DFD Plot Pole-Zero VI

Digital Filter Design VIs and Functions

previous page next page

Owning Palette: Filter Analysis VIs

Installed With: Digital Filter Design Toolkit

Plots the poles and zeroes of a filter in the z-plane.

Example

Place on the block diagram

Find on the Functions palette

output option specifies the pole-zero distribution that this VI plots.

0	Auto (default)—This VI automatically determines the pole-zero distribution of filter in to plot. If filter in is a floating-point filter, this VI plots the pole-zero distribution of this filter. If filter in is a fixed-point filter, this VI plots the pole-zero distributions of both this filter and the reference floating-point filter.
1	Floating-Point Only—If filter in is a floating-point filter, this VI plots the pole-zero distribution of this filter. If filter in is a fixed-point filter, this VI plots the pole-zero distribution of the reference floating-point filter.
2	Fixed-Point Only—If filter in is a floating-point filter, this VI returns an empty graph. If filter in is a fixed-point filter, this VI plots the pole-zero distribution of this filter.

filter in specifies the input filter.

upper half plane only specifies if this VI displays zeroes and poles on only the upper-half unit circle. The default is TRUE.

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.

filter out returns the filter in unchanged.

Z-Plane returns the zeroes and poles of the filter in an XY graph.

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 Plot Pole-Zero VI.

Open example Browse related examples

previous page start next page