xlGetReOrderedCoeff - 2020.2 English

Vivado Design Suite Reference Guide: Model-Based DSP Design Using System Generator (UG958)

Document ID
UG958
Release Date
2020-11-18
Version
2020.2 English

The xlGetReOrderedCoeff function provides the re-ordered coefficient set of a FIR Compiler block.

Syntax


A = xlGetReOrderedCoeff(new_coeff_set, returnType, block_handle)

Description

Note: All three parameters of this function are required.

new_coeff_set

The new coefficient set that needs to be loaded into an existing FIR Compiler. Must be supplied to the function in the original order.

block_handle

This is the FIR Compiler block handle in the design. If a FIR Compiler block is selected, then this block_handle can be specified as gcbh.

returnType

This parameter specifies the re-ordered coefficient or just the reload order information format. This value can be specified as either 'coeff' or 'index'. A 'coeff' return type will modify the required coefficient set and provide the re-arranged coefficient set that can be directly supplied to the FIR compiler block. The 'index' return type provides only the coefficient address vector using the new_coeff_set that needs to be processed manually.

Examples

Example 1:

If A is a row vector of coefficients, then the coefficients sorted in the reload order can be obtained as follows:


reload_order_coefficients = xlGetReOrderedCoeff(A,'coeff', gcbh)

In this example, reload_order_coefficients specifies the order in which coefficients contained in A should be passed to the FIR Compiler through the reload channel.

Example 2:

This example shows how to use an input text file is generated.


reload_order_coefficients = xlGetReOrderedCoeff(A,'coeff',reload_<version>.txt)

Alternatively, the reload address vector can be obtained,


reload_order_coefficients = A(xlGetReOrderedCoeff(A,'index',gcbh))

See Also

FIR Compiler 7.2 block