Model Infinite Impulse Response (IIR) filters
Discrete
The Discrete Filter block independently filters each channel
of the input signal with the specified digital IIR filter. You can
specify the filter structure as one of  Direct
form I
 Direct form I transposed
 Direct
form II
 Direct form II transposed
.
The block implements static filters with fixed coefficients. You can
tune the coefficients of these static filters.
This block filters each channel of the input signal independently over time. The Input processing parameter allows you to specify how the block treats each element of the input. You can specify treating input elements as an independent channel (samplebased processing), or treating each column of the input as an independent channel (framebased processing). To perform framebased processing, you must have a DSP System Toolbox™ license.
The output dimensions equal those of the input, except when you specify a matrix of filter taps for the Numerator coefficients parameter. When you do so, the output dimensions depend on the number of different sets of filter taps you specify.
Use the Numerator coefficients parameter to specify the coefficients of the discrete filter numerator polynomial. Use the Denominator coefficients parameter to specify the coefficients of the denominator polynomial of the function. The Denominator coefficients parameter must be a vector of coefficients.
Specify the coefficients of the numerator and denominator polynomials in ascending powers of z^{1}. The Discrete Filter block lets you use polynomials in z^{1} (the delay operator) to represent a discrete system. This method is the one that signal processing engineers typically use. Conversely, the Discrete Transfer Fcn block lets you use polynomials in z to represent a discrete system. This method is the one that control engineers typically use. When the numerator and denominator polynomials have the same length, the two methods are identical.
In Dialog parameters and Input port(s) modes, the block initializes the internal filter states to zero by default, which is equivalent to assuming past inputs and outputs are zero. You can optionally use the Initial states parameter to specify nonzero initial states for the filter delays.
To determine the number of initial state values you must specify, and how to specify them, see the following table on Valid Initial States and Number of Delay Elements (Filter States). The Initial states parameter can take one of four forms as described in the following table.
Valid Initial States
Initial state  Examples  Description 

Scalar 
Each delay element for
each channel is set to  The block initializes all delay elements in the filter to the scalar value. 
Vector  For a filter with two delay elements: [d_{1} d_{2}] The delay elements for all channels are d1 and d2.  Each vector element specifies a unique initial condition for a corresponding delay element. The block applies the same vector of initial conditions to each channel of the input signal. The vector length must equal the number of delay elements in the filter (specified in the table Number of Delay Elements (Filter States)). 
Vector or matrix  For a 3channel input signal and a filter with two delay elements: [d_{1} d_{2} D_{1} D_{2} d_{1} d_{2}] or $$\left[\begin{array}{lll}{d}_{1}\hfill & {D}_{1}\hfill & {d}_{1}\hfill \\ {d}_{2}\hfill & {D}_{2}\hfill & {d}_{2}\hfill \end{array}\right]$$
 Each vector or matrix element specifies a unique initial condition for a corresponding delay element in a corresponding channel:

Empty matrix 
 The empty matrix, 
The number of delay elements (filter states) per input channel depends on the filter structure, as indicated in the following table.
Number of Delay Elements (Filter States)
Filter Structure  Number of Delay Elements per Channel 





The following tables describe the valid initial states for different sizes of input and different number of channels. These tables provide this information according to whether you set the Input processing parameter to frame based or sample based.
FrameBased Processing
Input  Number of Channels  Valid Initial States (Dialog Box)  Valid Initial States (Input Port) 

 1 


 N 


SampleBased Processing
Input  Number of Channels  Valid Initial States (Dialog Box)  Valid Initial States (Input Port) 

 1 


 N 


 K×N 


When the Initial states is a scalar, the
block initializes all filter states to the same scalar value. Enter 0
to
initialize all states to zero. When the Initial states is
a vector or a matrix, each vector or matrix element specifies a unique
initial state. This unique state corresponds to a delay element in
a corresponding channel:
The vector length must equal the number of delay elements
in the filter, M = max(number of zeros, number of poles)
.
The matrix must have the same number of rows as the
number of delay elements in the filter, M = max(number of
zeros, number of poles)
. The matrix must also have one column
for each channel of the input signal.
The following example shows the relationship between the initial filter output and the initial input and state. Given an initial input u_{1}, the first output y_{1} is related to the initial state [x_{1}, x_{2}] and initial input by:
$${y}_{1}={b}_{1}\left[\frac{\left({u}_{1}{a}_{2}{x}_{1}{a}_{3}{x}_{2}\right)}{{a}_{1}}\right]+{b}_{2}{x}_{1}+{b}_{3}{x}_{2}$$
To see an example of how to set initial conditions as a vector:
Click on the model ex_discretefilter_nonzero_ic
,
or type it at the MATLAB^{®} command prompt.
Doubleclick on the Discrete Filter block, and set the parameters. The following shows how to set the initial conditions of the Discrete Filter block to [1 2].
Simulate the model, by leftclicking the green simulation icon.
Doubleclick the scope. You can see that the difference between the signal filtered by the Discrete Filter block, and the signal from the filter’s building blocks, is zero.
This demonstrates that you can enter the initial conditions of the Discrete Filter block as a vector of [1 2]. You can also set the initial condition of the first Unit Delay to 1 and the second Unit Delay to 2. The resulting outputs are the same.
The Discrete Filter block accepts and outputs real and complex signals of any signed numeric data type that Simulink^{®} supports. The block supports the same types for the numerator and denominator coefficients.
Numerator and denominator coefficients must have the same complexity. They can have different word lengths and fraction lengths.
The following diagrams show the filter structure and the data types used within the Discrete Filter block for fixedpoint signals.
The block omits the dashed divide when you select the Optimize by skipping divide by leading denominator coefficient (a0) parameter.
Numerator coefficients of the discrete filter. To specify the
coefficients, set the Source to Dialog
.
Then, enter the coefficients in Value as descending
powers of z. Use a row vector to specify the
coefficients for a single numerator polynomial.
Denominator coefficients of the discrete filter. To specify
the coefficients, set the Source to Dialog
.
Then, enter the coefficients in Value as descending
powers of z. Use a row vector to specify the
coefficients for a single denominator polynomial.
If the Source is Dialog
,
then, in Value, specify the initial states of
the filter states. To learn how to specify initial states, see Specifying Initial States.
If the Source is Input port
,
then you do not need to specify Value.
Specify the trigger event to use to reset the states to the initial conditions.
Reset Mode  Behavior 

None  No reset. 
Rising  Reset on a rising edge. 
Falling  Reset on a falling edge. 
Either  Reset on either a rising or falling edge. 
Level  Reset in either of these cases:

Level hold  Reset when the reset signal is nonzero at the current time step 
The reset signal must be a scalar of type single
, double
, boolean
,
or integer
. Fixed point data types, except for ufix1
,
are not supported.
Specify whether the block performs sample or framebased processing.
Elements as channels (sample based)
—
Process each element of the input as an independent channel.
Columns as channels (frame based)
—
Process each column of the input as an independent channel.
Framebased processing requires a DSP System Toolbox license.
For more information, see Sample and FrameBased Concepts (DSP System Toolbox) in the DSP System Toolbox documentation.
Select when the leading denominator coefficient, a_{0}, equals 1. This parameter optimizes your code.
When you select this check box, the block does not perform a dividebya_{0} either in simulation or in the generated code. An error occurs if a_{0} is not equal to one.
When you clear this check box, the block is fully tunable during simulation. It performs a dividebya_{0} in both simulation and code generation.
Specify the time interval between samples. To inherit the sample
time, set this parameter to 1
. See Specify Sample Time.
Specify the state data type. You can set this parameter to:
A rule that inherits a data type, for example, Inherit:
Same as input
A builtin integer, for example, int8
A data type object, for example, a Simulink.NumericType
object
An expression that evaluates to a data type, for example, fixdt(1,16,0)
Click the Show data type assistant button to display the Data Type Assistant, which helps you set the State parameter.
See Specify Data Types Using Data Type Assistant for more information.
Specify the numerator coefficient data type. You can set this parameter to:
A rule that inherits a data type, for example, Inherit:
Inherit via internal rule
A builtin integer, for example, int8
A data type object, for example, a Simulink.NumericType
object
An expression that evaluates to a data type, for example, fixdt(1,16,0)
Click the Show data type assistant button to display the Data Type Assistant, which helps you set the Numerator coefficients parameter.
See Specify Data Types Using Data Type Assistant for more information.
Specify the minimum value that a numerator coefficient can have.
The default value is []
(unspecified). Simulink software
uses this value to perform:
Parameter range checking (see Specify Minimum and Maximum Values for Block Parameters)
Automatic scaling of fixedpoint data types
Specify the maximum value that a numerator coefficient can have.
The default value is []
(unspecified). Simulink software
uses this value to perform:
Parameter range checking (see Specify Minimum and Maximum Values for Block Parameters)
Automatic scaling of fixedpoint data types
Specify the product output data type for the numerator coefficients. You can set this parameter to:
A rule that inherits a data type, for example, Inherit:
Inherit via internal rule
A builtin data type, for example, int8
A data type object, for example, a Simulink.NumericType
object
An expression that evaluates to a data type, for example, fixdt(1,16,0)
Click the Show data type assistant button to display the Data Type Assistant, which helps you set the Numerator product output parameter.
See Specify Data Types Using Data Type Assistant for more information.
Specify the accumulator data type for the numerator coefficients. You can set this parameter to:
A rule that inherits a data type, for example, Inherit:
Inherit via internal rule
A builtin data type, for example, int8
A data type object, for example, a Simulink.NumericType
object
An expression that evaluates to a data type, for example, fixdt(1,16,0)
Click the Show data type assistant button to display the Data Type Assistant, which helps you set the Numerator accumulator parameter.
See Specify Data Types Using Data Type Assistant for more information.
Specify the denominator coefficient data type. You can set this parameter to:
A rule that inherits a data type, for example, Inherit:
Inherit via internal rule
A builtin integer, for example, int8
A data type object, for example, a Simulink.NumericType
object
An expression that evaluates to a data type, for example, fixdt(1,16,0)
Click the Show data type assistant button to display the Data Type Assistant, which helps you set the Denominator coefficients parameter.
See Specify Data Types Using Data Type Assistant for more information.
Specify the minimum value that a denominator coefficient can
have. The default value is []
(unspecified). Simulink software
uses this value to perform:
Parameter range checking (see Specify Minimum and Maximum Values for Block Parameters)
Automatic scaling of fixedpoint data types
Specify the maximum value that a denominator coefficient can
have. The default value is []
(unspecified). Simulink software
uses this value to perform:
Parameter range checking (see Specify Minimum and Maximum Values for Block Parameters)
Automatic scaling of fixedpoint data types
Specify the product output data type for the denominator coefficients. You can set this parameter to:
A rule that inherits a data type, for example, Inherit:
Inherit via internal rule
A builtin data type, for example, int8
A data type object, for example, a Simulink.NumericType
object
An expression that evaluates to a data type, for example, fixdt(1,16,0)
Click the Show data type assistant button to display the Data Type Assistant, which helps you set the Denominator product output parameter.
See Specify Data Types Using Data Type Assistant for more information.
Specify the accumulator data type for the denominator coefficients. You can set this parameter to:
A rule that inherits a data type, for example, Inherit:
Inherit via internal rule
A builtin data type, for example, int8
A data type object, for example, a Simulink.NumericType
object
An expression that evaluates to a data type, for example, fixdt(1,16,0)
Click the Show data type assistant button to display the Data Type Assistant, which helps you set the Denominator accumulator parameter.
See Specify Data Types Using Data Type Assistant for more information.
Specify the output data type. You can set this parameter to:
A rule that inherits a data type, for example, Inherit:
Inherit via internal rule
A builtin data type, for example, int8
A data type object, for example, a Simulink.NumericType
object
An expression that evaluates to a data type, for example, fixdt(1,16,0)
Click the Show data type assistant button to display the Data Type Assistant, which helps you set the Output parameter.
See Control Signal Data Types for more information.
Specify the minimum value that the block can output. The default
value is []
(unspecified). Simulink software
uses this value to perform:
Simulation range checking (see Signal Ranges)
Automatic scaling of fixedpoint data types
Specify the maximum value that the block can output. The default
value is []
(unspecified). Simulink software
uses this value to perform:
Simulation range checking (see Signal Ranges)
Automatic scaling of fixedpoint data types
Select to lock all data type settings of this block against changes by the FixedPoint Tool and the FixedPoint Advisor. For more information, see Lock the Output Data Type Setting (FixedPoint Designer).
Specify the rounding mode for fixedpoint operations. For more information, see Rounding (FixedPoint Designer). in the FixedPoint Designer™ documentation.
Action  Reasons for Taking This Action  What Happens for Overflows  Example 

Select this check box.  Your model has possible overflow, and you want explicit saturation protection in the generated code.  Overflows saturate to either the minimum or maximum value that the data type can represent.  The maximum value that the 
Do not select this check box.  You want to optimize efficiency of your generated code. You want to avoid overspecifying how a block handles outofrange signals. For more information, see Check for Signal Range Errors.  Overflows wrap to the appropriate value that is representable by the data type.  The maximum value that the 
When you select this check box, saturation applies to every internal operation on the block, not just the output or result. Usually, the code generation process can detect when overflow is not possible. In this case, the code generator does not produce saturation code.
Use this parameter to assign a unique name to the block state.
The default is ' '
. When this field is blank, no
name is assigned. When using this parameter, remember these considerations:
A valid identifier starts with an alphabetic or underscore character, followed by alphanumeric or underscore characters.
The state name applies only to the selected block.
This parameter enables State name must resolve to Simulink signal object when you click Apply.
For more information, see Discrete Block State Naming in Generated Code (Simulink Coder).
Select this check box to require that the state name resolve to a Simulink signal object. This check box is cleared by default.
State name enables this parameter. This
parameter appears only if you set the model configuration parameter Signal
resolution to a value other than None
.
Selecting this check box disables Code generation storage class.
Choose a custom storage class package by selecting a signal
object class that the target package defines. For example, to apply
custom storage classes from the builtin package mpt
,
select mpt.Signal
. Unless you use an ERTbased
code generation target with Embedded
Coder^{®}, custom storage classes
do not affect the generated code.
If the class that you want does not appear in the list, select Customize
class lists
. For instructions, see Apply Custom Storage Classes Directly to Signal Lines, Block States, and Outport Blocks (Embedded Coder).
To programmatically set this parameter, use StateSignalObject
.
For information about storage classes, see Control Signals and States in Code by Applying Storage Classes (Simulink Coder). For information about custom storage classes, see Control Data Representation by Applying Custom Storage Classes (Embedded Coder).
Select state storage class for code generation.
Default: Auto
Auto
Auto
is the appropriate storage class for
states that you do not need to interface to external code.
StorageClass
Applies the storage class or custom storage class that you select from the list. For information about storage classes, see Control Signals and States in Code by Applying Storage Classes (Simulink Coder). For information about custom storage classes, see Control Data Representation by Applying Custom Storage Classes (Embedded Coder).
Use Signal object class to select custom
storage classes from a package other than Simulink
.
State name enables this parameter.
To programmatically set this parameter, use StateStorageClass
or StateSignalObject
.
See Control Signals and States in Code by Applying Storage Classes (Simulink Coder).
TypeQualifier will be removed in a future release. To apply storage type qualifiers to data, use custom storage classes and memory sections. Unless you use an ERTbased code generation target with Embedded Coder, custom storage classes and memory sections do not affect the generated code.
Specify a storage type qualifier such as const
or volatile
.
Setting Code generation storage class to ExportedGlobal
, ImportedExtern
, ImportedExternPointer
,
or SimulinkGlobal
enables this parameter.
This parameter is hidden unless you previously set its value.
During simulation, the block uses the following values:
The initial value of the signal object to which the state name resolves
Minimum and maximum values of the signal object
For more information, see Discrete Block State Naming in Generated Code (Simulink Coder) in the Simulink Coder™ documentation.
Data Types  Double  Single  Base Integer  FixedPoint 
Sample Time  Specified in the Sample time parameter 
Direct Feedthrough  Only when the leading numerator coefficient does not equal zero 
Multidimensional Signals  No 
VariableSize Signals  No 
ZeroCrossing Detection  No 
Code Generation  Yes 
The diagrams in the following sections show the filter structures supported by the Digital Filter block. They also show the data types used in the filter structures for fixedpoint signals. You can set the coefficient, output, accumulator, product output, and state data types shown in these diagrams in the block dialog.
The following constraints are applicable when processing a fixedpoint signal with this filter structure:
Inputs can be real or complex.
Numerator and denominator coefficients can be real or complex.
Numerator and denominator coefficients must have the same complexity characteristics.
When the numerator and denominator coefficients are specified using input ports and have different complexities from each other, you get an error.
When the numerator and denominator coefficients are specified in the dialog box and have different complexities from each other, the block does not error. Instead, it processes the filter as if two sets of complex coefficients are provided. The realvalued coefficient set is treated as if it is a complex vector with zerovalued imaginary parts.
Numerator and denominator coefficients must have the same word length. They can have different fraction lengths.
The State data type cannot be specified on the block mask for this structure. Doing so is not possible because the input and output states have the same data types as the input and output buffers.
The following constraints are applicable when processing a fixedpoint signal with this filter structure:
Inputs can be real or complex.
Numerator and denominator coefficients can be real or complex.
Numerator and denominator coefficients must have the same complexity characteristics.
When the numerator and denominator coefficients are specified using input ports and have different complexities from each other, you get an error.
When the numerator and denominator coefficients are specified in the dialog box and have different complexities from each other, the block does not error. Instead, it processes the filter as if two sets of complex coefficients are provided. The realvalued coefficient set is treated as if it is a complex vector with zerovalued imaginary parts.
States are complex when either the input or the coefficients are complex.
Numerator and denominator coefficients must have the same word length. They can have different fraction lengths.
The following constraints are applicable when processing a fixedpoint signal with this filter structure:
Inputs can be real or complex.
Numerator and denominator coefficients can be real or complex.
Numerator and denominator coefficients must have the same complexity characteristics.
When the numerator and denominator coefficients are specified using input ports and have different complexities from each other, you get an error.
When the numerator and denominator coefficients are specified in the dialog box and have different complexities from each other, the block does not error. Instead, it processes the filter as if two sets of complex coefficients are provided. The realvalued coefficient set is treated as if it is a complex vector with zerovalued imaginary parts.
States are complex when either the inputs or the coefficients are complex.
Numerator and denominator coefficients must have the same word length. They can have different fraction lengths.
The following constraints are applicable when processing a fixedpoint signal with this filter structure:
Inputs can be real or complex.
Numerator and denominator coefficients can be real or complex.
Numerator and denominator coefficients must have the same complexity characteristics.
When the numerator and denominator coefficients are specified using input ports and have different complexities from each other, you get an error.
When the numerator and denominator coefficients are specified in the dialog box and have different complexities from each other, the block does not error. Instead, it processes the filter as if two sets of complex coefficients are provided. The realvalued coefficient set is treated as if it is a complex vector with zerovalued imaginary parts.
States are complex when either the inputs or the coefficients are complex.
Numerator and denominator coefficients must have the same word length. They can have different fraction lengths.
Doubleprecision floating point
Singleprecision floating point
Fixed point (signed only)
8, 16, and 32bit signed integers
Allpole Filter  DSP System Toolbox 
Digital Filter Design  DSP System Toolbox 
Discrete FIR Filter  Simulink 
Filter Realization Wizard  DSP System Toolbox 
dsp.IIRFilter  DSP System Toolbox 
dsp.AllpoleFilter  DSP System Toolbox 
filterDesigner  DSP System Toolbox 
fvtool  Signal Processing Toolbox 