Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

scaleopts

Create an options object for second-order section scaling

Syntax

opts = scaleopts(biquad)
opts = scaleopts(biquad,Name,Value)

Description

opts = scaleopts(biquad) uses the current settings in the dsp.BiquadFilter System object™, biquad, to create an options object opts that contains specified scaling options for second-order section scaling. You can pass opts as an input to scale to apply scaling settings to a second-order filter.

opts = scaleopts(biquad,Name,Value) creates an options object with additional options specified by one or more Name,Value pair arguments.

Input Arguments

collapse all

biquad

dsp.BiquadFilter filter System object.

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside single quotes (' '). You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

collapse all

Specify the arithmetic used during analysis. When you specify 'double' or 'single', the function performs double- or single-precision analysis. When you specify 'fixed' , the arithmetic changes depending on the setting of the CoefficientDataType property and whether the System object is locked or unlocked.

 Details for Fixed-Point Arithmetic

When you do not specify the arithmetic, the function uses double-precision arithmetic if the filter System object is in an unlocked state. If the System object is locked, the function performs analysis based on the locked input data type.

Output Arguments

opts

Scaling object. The following table lists the properties of opts.

Parameter

Default

Description and Valid Value

sosReorder

'auto'

Reorder section prior to scaling.

Valid options are 'auto' (default), 'none', 'up', 'down', 'lowpass', 'highpass', 'bandpass', and 'bandstop'.

MaxNumerator

2

Maximum allowed value for numerator coefficients.

NumeratorConstraint

'none'

Specifies whether and how to constrain numerator coefficient values. Options are 'none' (default), 'unit', 'normalize', and 'po2'.

OverflowMode

'wrap'

Sets the way the filter handles arithmetic overflow situations during scaling. Valid options are 'wrap' (default), 'saturate', and 'satall'.

ScaleValueConstraint

'unit'

Specify whether to constrain the filter scale values, and how to constrain them. Valid options are 'unit' (default), 'none', and 'po2'.

MaxScaleValue

'Not used'

Maximum allowed scale values. The filter applies the MaxScaleValue limit only when you set ScaleValueConstraint to a value other than unit. Setting MaxScaleValue to a numerical value automatically changes the ScaleValueConstraint setting to none.

Examples

collapse all

Create an options scaling object that contains the scaling options settings you require.

EllipI = design(fdesign.lowpass('N,Fp,Ap,Ast',10,0.5,0.5,20), 'ellip', 'FilterStructure', 'df1sos','SystemObject',true)
opts = scaleopts(EllipI)
EllipI = 

  dsp.BiquadFilter with properties:

                       Structure: 'Direct form I'
                 SOSMatrixSource: 'Property'
                       SOSMatrix: [5×6 double]
                     ScaleValues: [6×1 double]
      NumeratorInitialConditions: 0
    DenominatorInitialConditions: 0
        OptimizeUnityScaleValues: true

  Use get to show all properties


opts =

              sosReorder: 'auto'
            MaxNumerator: 2
     NumeratorConstraint: 'none'
            OverflowMode: 'wrap'
    ScaleValueConstraint: 'unit'
           MaxScaleValue: 'Not used'

See Also

Functions

Introduced in R2011a

Was this topic helpful?