Filter Design Toolbox

get

Return the property values for quantized filters, quantizers, and quantized FFTs

Syntax

• get(obj,pn,pv)
  get(hq)
  struct = get(hq)
  v = get(hq,'propertyname')
  value = get(f, 'propertyname')
  structure = get(f)
  value = get(q, 'propertyname')
  structure = get(q)
  

Description

get(obj,pn,pv) displays the property names and property values associated with obj, where obj is one of the following:

• A quantizer
• A quantized filter
• A quantized FFT

pn is the name of a property of the object obj, and pv is the value associated with pn.

get(hq) displays a list of the property names and property values associated with quantized filter hq.

struct = get(hq) returns the MATLAB structure struct, a list of the properties associated with the quantized filter hq, along with the properties' associated values. Each field associated with struct is named according to the corresponding property name.

v = get(hq,'propertyname') returns the property value v associated with the property named in the string 'propertyname' for the quantized filter hq. If you replace the string 'propertyname' by a cell array of a vector of strings containing property names, get returns a cell array of a vector of corresponding values.

value = get(f, 'propertyname') returns the property value value associated with the property named in the string 'propertyname' for the quantized FFT f. If you replace the string 'propertyname' by a cell array of a vector of strings containing property names, get returns a cell array of a vector of corresponding values.

structure = get(f) returns a structure containing the properties and states of quantized FFT f.

value = get(q, 'propertyname') returns the property value value associated with the property named in the string 'propertyname' for the quantizer q. If you replace the string 'propertyname' by a cell array of a vector of strings containing property names, get returns a cell array of a vector of corresponding values.

structure = get(q) returns a structure containing the properties and states of quantizer q.

Remarks

For more information on the properties associated with quantized filters, see A Quick Guide to Quantized Filter Properties. For more information on the properties associated with quantized FFTs, see A Quick Guide to Quantized FFT Properties. For more information on the properties associated with quantizers, refer to A Quick Guide to Quantizer Properties.

Examples

Use get to list the properties of quantized filter hq, along with the property values. Then retrieve the value associated with the OutputFormat property for this filter in a structure v.

• hq = qfilt;
  get(hq)
  
  Quantized Direct form II transposed filter                            
  Numerator                                                             
       QuantizedCoefficients{1}    ReferenceCoefficients{1}             
  + (1)       0.999969482421875  1.000000000000000000                   
  Denominator                                                           
       QuantizedCoefficients{2}    ReferenceCoefficients{2}             
  + (1)       0.999969482421875  1.000000000000000000                   
                                                                        
     FilterStructure = df2t                                             
         ScaleValues = [1]                                              
    NumberOfSections = 1                                                
    StatesPerSection = [0]                                              
   CoefficientFormat = quantizer('fixed', 'round', 'saturate', [16  15])
         InputFormat = quantizer('fixed', 'floor', 'saturate', [16  15])
        OutputFormat = quantizer('fixed', 'floor', 'saturate', [16  15])
  MultiplicandFormat = quantizer('fixed', 'floor', 'saturate', [16  15])
       ProductFormat = quantizer('fixed', 'floor', 'saturate', [32  30])
           SumFormat = quantizer('fixed', 'floor', 'saturate', [32  30])
  Warning: 2 overflows in coefficients. 
  

• v = get(hq,'OutputFormat')
  
  v = 
  
              Mode = fixed
         RoundMode = floor
      OverflowMode = saturate
            Format = [16  15]
   
               Max = reset
               Min = reset
        NOverflows = 0
       NUnderflows = 0
       NOperations = 0
  q = quantizer('fixed', 'floor', 'saturate', [16 15]) 
  struct      = get(q) 
  mode        = get(q, 'mode') 
  format      = get(q, 'format') 
  noverflows  = get(q, 'noverflows') 
  

get also supports the dot notation for setting and accessing properties.

• q = quantizer('fixed', 'floor', 'saturate', [16 15]) 
  struct      = get(q) 
  mode        = q.mode 
  format      = q.format 
  noverflows  = q.noverflows 
  

See Also
qfft, qfilt, quantizer, set

freqz

gremez