Main Content

cumsec

Cumulative second-order section of the biquadratic filter

collapse all in page

Syntax

sect = cumsec(sysobj)
sect = cumsec(sysobj,indices)
sect = cumsec(sysobj,indices,secondary)
sect = cumsec(sysobj,Arithmetic=arithType)

Description

sect = cumsec(sysobj) returns a cell array, sect, which contains cumulative sections of the biquadratic filter System object™, sysobj. Each element in sect is a filter with the structure of the original filter. The first element is the first filter section of the biquadratic filter. The second element of sect is a filter that represents the combination of the first and second sections of the biquadratic filter. The third element of sect is a filter which combines sections 1, 2, and 3 of the biquadratic filter. This pattern continues until the final element of sect contains all the sections of the biquadratic filter and should be identical to the biquadratic filter.

example

sect = cumsec(sysobj,indices) returns the cumulative sections of the biquadratic filter object whose indices in the original filter are in the vector indices.

sect = cumsec(sysobj,indices,secondary) uses the secondary scaling points secondary in the sections to determine where the sections should be split when secondary is true. secondary is false by default. This option only applies for biquadratic filter objects with 'Direct form II' and 'Direct form I transposed' structures. For these structures, the secondary scaling points refer to the location between the recursive and the nonrecursive part, that is the 'middle' of the section.

sect = cumsec(sysobj,Arithmetic=arithType) returns the cumulative sections of the biquadratic filter object with the arithmetic specified in arithType.

Examples

collapse all

Open Live Script

This example plots the relative responses of the sections of a sixth-order filter with three sections. Each curve adds one more section to form the filter response.

LowpassSpec = fdesign.lowpass('n,fc',6,.4); 
ButterLowpassFilter = butter(LowpassSpec,SystemObject=true) 
ButterLowpassFilter = 
  dsp.SOSFilter with properties:

            Structure: 'Direct form II'
    CoefficientSource: 'Property'
            Numerator: [3x3 double]
          Denominator: [3x3 double]
       HasScaleValues: true
          ScaleValues: [0.2772 0.2066 0.1801 1]

  Use get to show all properties


CumSections = cumsec(ButterLowpassFilter)
CumSections=1×3 cell array
    {1x1 dsp.SOSFilter}    {1x1 dsp.SOSFilter}    {1x1 dsp.SOSFilter}


hfvt = filterAnalyzer(CumSections{1},CumSections{2},...
    CumSections{3},FilterNames=["FirstSection",...
    "FirstTwoSections","OverallFilter"]);

Input Arguments

collapse all

Input filter, specified as a dsp.SOSFilter System object.

Filter indices, specified as a scalar or a row vector. Use indices to specify the filter sections that the cumsec function uses to compute the cumulative responses.

This option applies only when sysobj has the df2sos and df1tsos structures. For these second-order section structures, the secondary scaling points refer to the scaling locations between the recursive and the nonrecursive parts of the section (the "middle" of the section). Argument secondary accepts either true or false. By default, secondary is false.

Arithmetic used in the filter analysis, specified as 'double', 'single', or 'Fixed'. When the arithmetic input is not specified and the filter System object is unlocked, the analysis tool assumes a double-precision filter. When the arithmetic input is not specified and the System object is locked, the function performs the analysis based on the data type of the locked input.

The 'Fixed' value applies to filter System objects with fixed-point properties only.

When the 'Arithmetic' input argument is specified as 'Fixed' and the filter object has the data type of the coefficients set to 'Same word length as input', the arithmetic analysis depends on whether the System object is unlocked or locked.

  • unlocked –– The analysis object function cannot determine the coefficients data type. The function assumes that the coefficients data type is signed, has a 16-bit word length, and is auto scaled. The function performs fixed-point analysis based on this assumption.

  • locked –– When the input data type is 'double' or 'single', the analysis object function cannot determine the coefficients data type. The function assumes that the data type of the coefficients is signed, has a 16-bit word length, and is auto scaled. The function performs fixed-point analysis based on this assumption.

To check if the System object is locked or unlocked, use the isLocked function.

When the arithmetic input is specified as 'Fixed' and the filter object has the data type of the coefficients set to a custom numeric type, the object function performs fixed-point analysis based on the custom numeric data type.

Output Arguments

collapse all

Cumulative sections of the biquadratic filter, specified as a cell array.

Version History

Introduced in R2011a

expand all

See Also

Functions

Objects

Topics