DFD Get Zero-Pole-Gain VI

Digital Filter Design VIs and Functions

previous page next page

Owning Palette: Utilities VIs

Installed With: Digital Filter Design Toolkit

Retrieves the zeroes, poles, and gain (ZPK) of a filter.

Example

Place on the block diagram

Find on the Functions palette

type specifies the type of zero-pole-gain (ZPK) coefficients to retrieve.

0	FLP (default)—Specifies to retrieve the coefficients of a floating-point filter. If filter in is a fixed-point filter, this VI retrieves the coefficients of the reference floating-point filter.
1	FXP—Specifies to retrieve the coefficients of a fixed-point filter. If filter in is a floating-point filter, this VI returns an error.

filter in specifies the input filter.

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.

gain returns the gain of the filter in linear units.

filter out returns the filter in unchanged.

zeroes returns the zeroes of the filter.

poles returns the poles of the filter.

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.

Example

Refer to the Get Zero-Pole-Gain of Filter VI in the labview\examples\Digital Filter Design\Getting Started\Analyze Filters directory for an example of using the DFD Get Zero-Pole-Gain VI.

Open example Browse related examples

previous page start next page