DFD FXP Code Generator VI

Digital Filter Design VIs and Functions

DFD FXP Code Generator VI

Owning Palette: Fixed-Point Tools VIs

Installed With: Digital Filter Design Toolkit

Generates fixed-point code from a fixed-point filter, including fixed-point LabVIEW field-programmable gate array (FPGA) code, integer LabVIEW code, and C code. You must manually select the polymorphic instance you want to use.

Note  To avoid errors in generating code from a fixed-point filter, ensure that you configure the quantizers according to the guidelines in the Details section of the DFD FXP Set Quantizer VI.

Examples

Use the pull-down menu to select an instance of this VI.

 Place on the block diagram  Find on the Functions palette

DFD FXP LabVIEW FPGA Code Generator

open project? specifies if this VI opens the project file after generating the code. The default is FALSE, which means that you must open the project file manually after this VI generates the code.
# channels specifies the number of channels that you want the generated code to process. The default is 1.
filter in specifies the input filter.
destination folder specifies the folder in which you want to save the generated code. This VI returns an error if you do not specify a valid path to the folder.
filter name specifies a name for the filter code that this VI generates. This VI also uses this value as the filename of the project file that contains the generated filter code. You can use only letters and digits in the filter name input. This VI ignores other characters. If you specify an invalid name, this VI creates a string that starts with Unknown.
error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
confirm? specifies if you want this VI to ask you for confirmation before replacing an existing file. If the value is TRUE, this VI displays a dialog box asking for confirmation to replace the existing file. If the value is FALSE, this VI replaces the existing file automatically. The default is TRUE.
lvproj path returns the path to the generated project file.
sampling frequency/FPGA clock returns a ratio. You can multiply this ratio with a specific FPGA clock rate to calculate the maximum input sampling frequency per channel that the generated FPGA code can process at the FPGA clock rate. For example, if the ratio is 0.05 and the FPGA clock rate is 40 MHz, then the maximum input sampling frequency per channel that the generated FPGA code can process is 2 MHz.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

DFD FXP Integer LabVIEW Code Generator

open project? specifies if this VI opens the project file after generating the code. The default is FALSE, which means that you must open the project file manually after this VI generates the code.
# channels specifies the number of channels that you want the generated code to process. The default is 1.
filter in specifies the input filter.
destination folder specifies the folder in which you want to save the generated code. This VI returns an error if you do not specify a valid path to the folder.
filter name specifies a name for the filter code that this VI generates. This VI also uses this value as the filename of the project file that contains the generated filter code. You can use only letters and digits in the filter name input. This VI ignores other characters. If you specify an invalid name, this VI creates a string that starts with Unknown.
error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
confirm? specifies if you want this VI to ask you for confirmation before replacing an existing file. If the value is TRUE, this VI displays a dialog box asking for confirmation to replace the existing file. If the value is FALSE, this VI replaces the existing file automatically. The default is TRUE.
lvproj path returns the path to the generated project file.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

DFD FXP C Code Generator

filter in specifies the input filter.
destination folder specifies the folder in which you want to save the generated code. This VI returns an error if you do not specify a valid path to the folder.
filter name specifies a name for the filter code that this VI generates. This VI also uses this value as the filename of the project file that contains the generated filter code. You can use only letters and digits in the filter name input. This VI ignores other characters. If you specify an invalid name, this VI creates a string that starts with Unknown.
error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
confirm? specifies if you want this VI to ask you for confirmation before replacing an existing file. If the value is TRUE, this VI displays a dialog box asking for confirmation to replace the existing file. If the value is FALSE, this VI replaces the existing file automatically. The default is TRUE.
output files contains the absolute path to the generated C source files. The VI generates three files: filter name.c, which contains C source code, filter name.h, which contains function prototypes, and nidfdtyp.h, which is a National Instruments proprietary file.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Examples

Refer to the following VIs for examples of using the DFD FXP Code Generator VI:

  • LabVIEW FPGA Code Generation VI: labview\examples\Digital Filter Design\Fixed-Point Filters\Single-Rate

     Open example  Browse related examples

  • Generate LabVIEW FPGA Code for Exponentially Weighted Moving Average Filter VI: labview\examples\Digital Filter Design\Fixed-Point Filters\Single-Rate

     Open example  Browse related examples

  • Integer LabVIEW Code Generation VI: labview\examples\Digital Filter Design\Fixed-Point Filters\Single-Rate

     Open example  Browse related examples

  • LabVIEW C Code Generation VI: labview\examples\Digital Filter Design\Fixed-Point Filters\Single-Rate

     Open example  Browse related examples