FIR Decimator
Finite impulse response (FIR) decimation filter
 Library:
DSP HDL Toolbox / Filtering
Description
The FIR Decimator block implements a singlerate polyphase FIR decimation filter that is optimized for HDL code generation. The block provides a hardwarefriendly interface with input and output control signals. To provide a cycleaccurate simulation of the generated HDL code, the block models architectural latency including pipeline registers and resource sharing.
The block accepts scalar or vector input. When you use vector input and the vector size is less than the decimation factor, the decimation factor must be an integer multiple of the vector size. In this case, the output is scalar and an output valid signal indicates which samples are valid after decimation. The output data is valid every DecimationFactor/VectorSize samples. The waveform shows an input vector of four samples and a decimation factor of eight. The output data is a scalar that is valid every second cycle.
When you use vector input and the vector size is greater than the decimation factor, the vector size must be an integer multiple of the decimation factor. In this case, the output is a vector of VectorSize/DecimationFactor samples. The waveform shows an input vector of eight samples and a decimation factor of four. The output data is a vector of two samples on every cycle.
The block provides two filter structures. The direct form systolic architecture provides an implementation that makes efficient use of Intel^{®} and Xilinx^{®} DSP blocks. This architecture can be fully parallel or serial. To use a serial architecture, the input samples must be spaced out with a regular number of invalid cycles between the valid samples. The direct form transposed architecture is a fully parallel implementation that is suitable for FPGA and ASIC applications. For a filter implementation that matches multipliers, pipeline registers, and preadders to the DSP configuration of your FPGA vendor, specify your target device when you generate HDL code.
All filter structures optimize hardware resources by sharing multipliers for symmetric or antisymmetric filters and by removing the multipliers for zerovalued coefficients such as in halfband filters and Hilbert transforms.
The block implements one filter for each sample in the input vector. The block then shares this filter between the polyphase subfilters by interleaving the subfilter coefficients in time.
Ports
Input
data
— Input data
scalar  vector
Input data must be a real or complexvalued scalar or vector. When you use vector input and the vector size is less than the decimation factor, the decimation factor must be an integer multiple of the vector size. When you use vector input and the vector size is greater than the decimation factor, the vector size must be an integer multiple of the decimation factor. The vector size must be less than or equal to 64.
When the input data type is an integer type or a fixedpoint type, the block uses fixedpoint arithmetic for internal calculations.
double
and single
data
types are supported for simulation, but not for HDL code generation.
Data Types: fixed point
 single
 double
 int8
 int16
 int32
 uint8
 uint16
 uint32
Complex Number Support: Yes
valid
— Indicates valid input data
scalar
Control signal that indicates if the input data is valid.
When valid is 1
(true
), the block captures the
values from the input data port. When
valid is 0
(false
), the block ignores the
values from the input data
port.
Data Types: Boolean
reset
— Clears internal states
scalar
Control signal that clears internal states. When
reset is 1
(true
), the block stops the
current calculation and clears internal states. When the
reset is 0
(false
) and the input
valid is 1
(true
), the block captures data
for processing.
For more reset considerations, see the Reset Signal section on the Hardware Control Signals page.
Dependencies
To enable this port, on the Control Ports tab, select Enable reset input port.
Data Types: Boolean
Output
data
— Filtered output data
scalar
Filtered output data, returned as a real or complexvalued scalar. When the input data type is a floatingpoint type, the output data inherits the data type of the input data. When the input data type is an integer type or a fixedpoint type, the Output parameter on the Data Types tab specifies the output data type.
The output valid signal indicates which samples are valid after decimation. When the input vector size is greater than the decimation factor, the output is a vector of VectorSize/DecimationFactor samples.
Data Types: fixed point
 single
 double
Complex Number Support: Yes
valid
— Indicates valid output data
scalar
Control signal that indicates if the data from the output
data port is valid. When
valid is 1
(true
), the block returns valid
data from the output data port. When
valid is 0
(false
), the values from the
output data port are not
valid.
Data Types: Boolean
Parameters
Main
Coefficients
— FIR filter coefficients
fir1(35,0.4)
(default)  real or complexvalued vector
FIR filter coefficients, specified as a real or complexvalued vector. You can specify the vector as a workspace variable or as a call to a filter design function. When the input data type is a floatingpoint type, the block casts the coefficients to the same data type as the input. When the input data type is an integer type or a fixedpoint type, you can set the data type for the coefficients on the Data Types tab.
Example: firpm(30,[0 0.1 0.2 0.5]*2,[1 1 0
0])
defines coefficients using a
linearphase filter design function.
Data Types: single
 double
 int8
 int16
 int32
 uint8
 uint16
 uint32
Complex Number Support: Yes
Filter structure
— HDL filter architecture
Direct form
systolic
(default)  Direct form transposed
The block implements a polyphase decomposition filter by using Discrete FIR Filter blocks. Both structures share resources by interleaving the subfilter coefficients over one filter implementation for each sample in the input vector. Specify the HDL filter architecture as one of these structures:
Direct form systolic
— This architecture provides a parallel or partlyserial filter implementation that makes efficient use of Intel and Xilinx DSP blocks. For a partlyserial implementation, specify a value greater than 1 for the Minimum number of cycles between valid input samples parameter. You cannot use framebased input with the partlyserial architecture.When Minimum number of cycles between valid input samples is greater than 1, the block chooses a filter architecture that results in the fewest multipliers. If N allows for a single multiplier in each subfilter, then the block implements a single serial filter and decimates the output samples.
Direct form transposed
— This architecture is a fully parallel implementation that is suitable for FPGA and ASIC applications.
All implementations share resources by interleaving the subfilter coefficients over one filter implementation for each sample in the input vector.
The block implements a polyphase decomposition filter using Discrete FIR Filter blocks. For architecture details, see FIR Filter Architectures for FPGAs and ASICs.
Decimation factor
— Decimation factor
2 (default)  integer greater than two
Specify an integer decimation factor greater than two. When you use vector input and the vector size is less than the decimation factor, the decimation factor must be an integer multiple of the vector size. When you use vector input and the vector size is greater than the decimation factor, the vector size must be an integer multiple of the decimation factor.
Minimum number of cycles between valid input samples
— Serialization requirement for input timing
1
(default)  positive integer
Serialization requirement for input timing, specified as a
positive integer. This parameter represents
N, the minimum number of cycles
between valid input samples. To implement a fully serial
architecture, set Minimum number of cycles
between valid input samples greater than
the filter length, L, or to
Inf
.
The block applies coefficient optimizations before serialization, so the sharing factor of the final filter can be lower than the number of cycles that you specified.
Dependencies
To enable this parameter, set Filter
structure to Direct form
systolic
.
You cannot use framebased input with Minimum number of cycles between valid input samples greater than 1.
Data Types
Rounding mode
— Rounding mode for typecasting the output
Floor
(default)  Ceiling
 Convergent
 Nearest
 Round
 Zero
Rounding mode for typecasting the output to the data type specified by the Output parameter. When the input data type is floating point, the block ignores this parameter. For more details, see Rounding Modes.
Saturate on integer overflow
— Overflow handling for typecasting the output
off
(default)  on
Overflow handling for typecasting the output to the data type specified by the Output parameter. When the input data type is floating point, the block ignores this parameter. For more details, see Overflow Handling.
Coefficients
— Data type of filter coefficients
Inherit: Same word length as
input
(default)  <data type
expression>
The block casts the filter coefficients to this data type. The quantization rounds to the nearest representable value and saturates on overflow. When the input data type is floating point, the block ignores this parameter.
The recommended data type for this parameter is
Inherit: Same word length as
input
.
The block returns a warning or error if either of these conditions occur.
The coefficients data type does not have enough fractional length to represent the coefficients accurately.
The coefficients data type is unsigned, and the coefficients include negative values.
Output
— Data type of filter output
Inherit: Inherit via internal
rule
(default)  Inherit: Same word length as
input
 <data type
expression>
The block casts the output of the filter to this data type. The quantization uses the settings of the Rounding mode and Overflow mode parameters. When the input data type is floating point, the block ignores this parameter.
The block increases the word length for full precision inside each filter tap and casts the final output to the specified type. The maximum final internal data type (WF) depends on the input data type (WI), the coefficient data type (WC), and the number of coefficients (L) and is given by
WF = WI +
WC +
ceil(log2(L))
.
Because the coefficient values limit the potential growth, usually the actual fullprecision internal word length is smaller than WF.
Control Ports
Enable reset input port
— Option to enable reset input port
off
(default)  on
Select this parameter to enable the reset input port. The reset signal implements a local synchronous reset of the data path registers.
For more reset considerations, see the Reset Signal section on the Hardware Control Signals page.
Use HDL global reset
— Option to connect data path registers to generated HDL global reset signal
off
(default)  on
Select this parameter to connect the generated HDL global reset signal to the data path registers. This parameter does not change the appearance of the block or modify simulation behavior in Simulink^{®}. When you clear this parameter, the generated HDL global reset clears only the control path registers. The generated HDL global reset can be synchronous or asynchronous depending on the HDL Code Generation > Global Settings > Reset type parameter in the model Configuration Parameters.
For more reset considerations, see the Reset Signal section on the Hardware Control Signals page.
Model Examples
Algorithms
The block implements a polyphase filter bank where the filter coefficients are decomposed into Decimation factor subfilters. If the filter length is not divisible by the Decimation factor parameter value, then the block zeropads the coefficients.
The diagram shows the polyphase filter bank with scalar input, the
Decimation factor parameter set to
4
, and Minimum number of cycles between valid input
samples set to 1
. The four sets of decomposed
coefficients are interleaved in time over a single subfilter. The output data
sample is valid every 4 cycles.
With an input vector size greater than the decimation factor, the block implements the same interleaved filter but with framebased input. The output vector has VectorSize/DecimationFactor samples.
The next diagram shows the polyphase filter bank for an input vector size smaller than the decimation factor. This filter has an input vector of four values and the Decimation factor parameter set to eight. Each of the four subfilters has two sets of coefficients interleaved in time.
When the filter has Minimum number of cycles between valid input
samples greater than one and less than the number of filter
coefficients, the block implements a polyphase filter with
DecimationFactor subfilters. This diagram shows input
data with a valid sample every second cycle and a
DecimationFactor of 4
. The output data
has one valid sample every eight cycles.
When the filter has Minimum number of cycles between valid input samples greater than the number of filter coefficients, the block implements a single fully serial filter and decimates the output samples by the decimation factor.
Each subfilter is implemented with a Discrete FIR Filter block. The adder at the output is pipelined to accommodate higher synthesis frequencies. For architecture details, see FIR Filter Architectures for FPGAs and ASICs.
Note
The output of the FIR Decimator block does not match the output from the FIR Decimation block from DSP System Toolbox™ sampleforsample. This difference is mainly because of the phase that the samples are applied across the subfilters. To match the FIR Decimation block, apply Decimation factor – 1 zeros to the FIR Decimator block at the start of the data stream.
The FIR Decimation block also uses slightly different data types for fullprecision calculations. The different data types can also introduce differences in output values if the values overflow the internal data types.
Performance
This table shows the postsynthesis resource utilization for the HDL code
generated for the default FIR decimation filter using scalar input, a
decimation factor of eight, 16bit input, and 16bit coefficients. The
synthesis targets a Xilinx ZC706 (XC7Z045ffg9002) FPGA. The Global HDL reset
type parameter is Synchronous
,
and the Minimize clock enables parameter is selected.
The reset port is disabled, so only the control path
registers are connected to the generated global HDL reset.
Resource  Uses 

LUT  676 
Slice Reg  878 
Slice  257 
Xilinx LogiCORE DSP48  5 
After place and route, the maximum clock frequency of the design is 526 MHz.
For the same filter with a fourelement input vector, the filter uses these resources.
Resource  Uses 

LUT  322 
Slice Reg  2351 
Slice  502 
Xilinx LogiCORE DSP48  20 
After place and route, the maximum clock frequency of the design is 518 MHz.
For the same filter with scalar input and numCycles set to four, the filter uses these resources.
Resource  Uses 

LUT  835 
Slice Reg  1341 
Xilinx LogiCORE DSP48  8 
After place and route, the maximum clock frequency of the design is 460 MHz.
Extended Capabilities
C/C++ Code Generation
Generate C and C++ code using Simulink® Coder™.
This block supports C/C++ code generation for Simulink accelerator and rapid accelerator modes and for DPI component generation.
HDL Code Generation
Generate Verilog and VHDL code for FPGA and ASIC designs using HDL Coder™.
HDL Coder™ provides additional configuration options that affect HDL implementation and synthesized logic.
ConstrainedOutputPipeline  Number of registers to place at
the outputs by moving existing delays within your design. Distributed
pipelining does not redistribute these registers. The default is

InputPipeline  Number of input pipeline stages
to insert in the generated code. Distributed pipelining and constrained
output pipelining can move these registers. The default is

OutputPipeline  Number of output pipeline stages
to insert in the generated code. Distributed pipelining and constrained
output pipelining can move these registers. The default is

The FIR Decimator block does not support resource sharing optimization
through HDL Coder settings. Instead, set the Filter
structure parameter to Partly serial
systolic
, and configure a serialization factor
based on either input timing or resource usage.
Version History
Introduced in R2020bR2022a: Moved to DSP HDL Toolbox from DSP System Toolbox
Behavior changed in R2022a
Before R2022a, this block was named FIR Decimation HDL Optimized, and was included in the DSP System Toolbox DSP System Toolbox HDL Support library.
R2022a: Serial systolic architecture
This block now supports partly and fully serial systolic architecture. This
architecture enables you to share hardware resources if there is a regular
pattern of invalid cycles between valid input samples. To use the serial
systolic architecture, set Filter structure to
Direct form systolic
and Minimum
number of cycles between valid input samples to a value
greater than 1. You cannot use framebased input with the serial
architecture.
R2022a: Input vector size can be greater than decimation factor
In previous releases, the block did not support input vector sizes greater than the decimation factor.
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
 América Latina (Español)
 Canada (English)
 United States (English)
Europe
 Belgium (English)
 Denmark (English)
 Deutschland (Deutsch)
 España (Español)
 Finland (English)
 France (Français)
 Ireland (English)
 Italia (Italiano)
 Luxembourg (English)
 Netherlands (English)
 Norway (English)
 Österreich (Deutsch)
 Portugal (English)
 Sweden (English)
 Switzerland
 United Kingdom (English)