Documentation |
Discrete-time, direct-form I filter
Refer to dfilt.df1 in Signal Processing Toolbox™ documentation.
hd = dfilt.df1 returns a default discrete-time, direct-form I filter object that uses double-precision arithmetic. By default, the numerator and denominator coefficients b and a are set to 1. With these coefficients the filter passes the input to the output without changes.
Make this filter a fixed-point or single-precision filter by changing the value of the Arithmetic property for the filter hd as follows:
To change to single-precision filtering, enter
set(hd,'arithmetic','single');
To change to fixed-point filtering, enter
set(hd,'arithmetic','fixed');
For more information about the property Arithmetic, refer to Arithmetic.
The following figure shows the signal flow for the direct-form I filter implemented by dfilt.df1. To help you see how the filter processes the coefficients, input, output, and states of the filter, as well as numerical operations, the figure includes the locations of the arithmetic and data type format elements within the signal flow.
To help you understand where and how the filter performs fixed-point arithmetic during filtering, the figure shows various labels associated with data and functional elements in the filter. The following table describes each label in the signal flow and relates the label to the filter properties that are associated with it.
The labels use a common format — a prefix followed by the word "format." In this use, "format" means the word length and fraction length associated with the filter part referred to by the prefix.
For example, the InputFormat label refers to the word length and fraction length used to interpret the data input to the filter. The format properties InputWordLength and InputFracLength (as shown in the table) store the word length and the fraction length in bits. Or consider NumFormat, which refers to the word and fraction lengths (CoeffWordLength, NumFracLength) associated with representing filter numerator coefficients.
Signal Flow Label | Corresponding Word Length Property | Corresponding Fraction Length Property | Related Properties |
---|---|---|---|
DenAccumFormat | AccumWordLength | DenAccumFracLength | AccumMode, CastBeforeSum |
DenFormat | CoeffWordLength | DenFracLength | CoeffAutoScale , SignedDenominator |
DenProdFormat | CoeffWordLength | DenProdFracLength | ProductMode, ProductWordLength |
InputFormat | InputWordLength | InputFracLength | None |
NumAccumFormat | AccumWordLength | NumAccumFracLength | AccumMode, CastBeforeSum |
NumFormat | CoeffWordLength | NumFracLength | CoeffAutoScale, Signed, Numerator |
NumProdFormat | CoeffWordLength | NumProdFracLength | ProductWordLength, ProductMode |
OutputFormat | OutputWordLength | OutputFracLength | OutputMode |
Most important is the label position in the diagram, which identifies where the format applies.
As one example, look at the label DenProdFormat, which always follows a denominator coefficient multiplication element in the signal flow. The label indicates that denominator coefficients leave the multiplication element with the word length and fraction length associated with product operations that include denominator coefficients. From reviewing the table, you see that the DenProdFormat refers to the properties ProdWordLength, ProductMode and DenProdFracLength that fully define the denominator format after multiply (or product) operations.
In this table you see the properties associated with df1 implementations of dfilt objects.
Note The table lists all the properties that a filter can have. Many of the properties are dynamic, meaning they exist only in response to the settings of other properties. You might not see all of the listed properties all the time. To view all the properties for a filter at any time, use get(hd) where hd is a filter. |
For further information about the properties of this filter or any dfilt object, refer to Fixed-Point Filter Properties.
Property Name | Brief Description |
---|---|
AccumMode | Determines how the accumulator outputs stored values. Choose from full precision (FullPrecision), or whether to keep the most significant bits (KeepMSB) or least significant bits (KeepLSB) when output results need shorter word length than the accumulator supports. To let you set the word length and the precision (the fraction length) used by the output from the accumulator, set AccumMode to SpecifyPrecision. |
AccumWordLength | Sets the word length used to store data in the accumulator/buffer. |
Arithmetic | Defines the arithmetic the filter uses. Gives you the options double, single, and fixed. In short, this property defines the operating mode for your filter. |
CastBeforeSum | Specifies whether to cast numeric data to the appropriate accumulator format (as shown in the signal flow diagrams) before performing sum operations. |
CoeffAutoScale | Specifies whether the filter automatically chooses the proper fraction length to represent filter coefficients without overflowing. Turning this off by setting the value to false enables you to change the NumFracLength and DenFracLength properties to specify the precision used. |
CoeffWordLength | Specifies the word length to apply to filter coefficients. |
DenAccumFracLength | Specifies the fraction length the filter algorithm uses to interpret the results of product operations involving denominator coefficients. You can change the value for this property when you set AccumMode to SpecifyPrecision. |
DenFracLength | Set the fraction length the filter uses to interpret denominator coefficients. DenFracLength is always available, but it is read-only until you set CoeffAutoScale to false. |
Denominator | Stores the denominator coefficients for the IIR filter. |
DenProdFracLength | Specifies how the filter algorithm interprets the results of product operations involving denominator coefficients. You can change this property value when you set ProductMode to SpecifyPrecision. |
FilterStructure | Describes the signal flow for the filter object, including all of the active elements that perform operations during filtering — gains, delays, sums, products, and input/output. |
InputFracLength | Specifies the fraction length the filter uses to interpret input data. |
InputWordLength | Specifies the word length applied to interpret input data. |
NumAccumFracLength | Specifies how the filter algorithm interprets the results of addition operations involving numerator coefficients. You can change the value of this property after you set AccumMode to SpecifyPrecision. |
Numerator | Holds the numerator coefficient values for the filter. |
NumFracLength | Sets the fraction length used to interpret the value of numerator coefficients. |
NumProdFracLength | Specifies how the filter algorithm interprets the results of product operations involving numerator coefficients. Available to be changed when you set ProductMode to SpecifyPrecision. |
OutputFracLength | Determines how the filter interprets the filter output data. You can change the value of OutputFracLength when you set OutputMode to SpecifyPrecision. |
OutputWordLength | Determines the word length used for the output data. |
OverflowMode | Sets the mode used to respond to overflow conditions in fixed-point arithmetic. Choose from either saturate (limit the output to the largest positive or negative representable value) or wrap (set overflowing values to the nearest representable value using modular arithmetic). The choice you make affects only the accumulator and output arithmetic. Coefficient and input arithmetic always saturates. Finally, products never overflow — they maintain full precision. |
ProductMode | Determines how the filter handles the output of product operations. Choose from full precision (FullPrecision), or whether to keep the most significant bit (KeepMSB) or least significant bit (KeepLSB) in the result when you need to shorten the data words. For you to be able to set the precision (the fraction length) used by the output from the multiplies, you set ProductMode to SpecifyPrecision. |
ProductWordLength | Specifies the word length to use for multiplication operation results. This property becomes writable (you can change the value) when you set ProductMode to SpecifyPrecision. |
PersistentMemory | Specifies whether to reset the filter states and memory before each filtering operation. Lets you decide whether your filter retains states from previous filtering runs. False is the default setting. |
RoundMode | Sets the mode the filter uses to quantize numeric values when the values lie between representable values for the data format (word and fraction lengths).
The choice you make affects only the accumulator and output arithmetic. Coefficient and input arithmetic always round. Finally, products never overflow — they maintain full precision. |
Signed | Specifies whether the filter uses signed or unsigned fixed-point coefficients. Only coefficients reflect this property setting. |
States | This property contains the filter states before, during, and after filter operations. States act as filter memory between filtering runs or sessions. The states use fi objects, with the associated properties from those objects. For details, refer to filtstates in Signal Processing Toolbox documentation or in the Help system. |
Specify a second-order direct-form I structure for a dfilt object, hd, with the following code:
b = [0.3 0.6 0.3]; a = [1 0 0.2]; hd = dfilt.df1(b,a); % Convert hd to fixed-point filter set(hd,'arithmetic','fixed')
dfilt | dfilt.df1t | dfilt.df2 | dfilt.df2t