IMAQ Particle Filter 3 VI

LabView NI Vision

IMAQ Particle Filter 3 VI

Owning Palette: MorphologyInstalled With: NI Vision Development Module

Filters (keeps or removes) each particle in an image according to its measurements.

Note  This VI modifies the source image. If you need the original source image, create a copy of the image using the IMAQ Copy VI before using this VI.

IMAQ Particle Filter 3

ccclst.gif

ROI Descriptor is a descriptor that defines the Region of Interest (ROI) within which the particle filter is performed.

c1di32.gif

Global Rectangle contains the coordinates of the bounding rectangle.

c1dcclst.gif

Contours are each of the individual shapes that define an ROI.

cenum.gif

ID refers to whether the contour is the external or internal edge of an ROI.

cu32.gif

Type is the shape type of the contour.

c1di32.gif

Coordinates indicates the relative position of the contour.

cbool.gif

Connectivity 4/8 (8) specifies the type of connectivity used by the algorithm for particle detection. The connectivity mode directly determines whether an adjacent pixel belongs to the same particle or a different particle. The default is 8. The following values are possible:

8 (TRUE) Particle detection is performed in connectivity mode 8
4 (FALSE) Particle detection is performed in connectivity mode 4
cgenclasstagrefflat.gif

Image Src is a reference to the source image.

cgenclasstagrefflat.gif

Image Dst is a reference to the destination image.

c1dcclst.gif

Selection Values controls the criteria used to filter the particle in the image. This control is made of an array of clusters composed of the following values:

ci32.gif

Measurement Parameter is the measurement on which you want to filter.

cdbl.gif

Range Lower Value specifies the lower value of the range for the chosen parameter.

cdbl.gif

Range Upper Value specifies the upper value of the range for the chosen parameter.

cbool.gif

Range specifies whether to include or exclude the values given in Range Lower Value and Range Upper Value.

When Range is Include (FALSE), the particle meets the criteria if Range Lower Value ≤ particle measurement < Range Upper Value.

When Range is Exclude (TRUE), the particle meets the criteria if Range Upper Value ≤ particle measurement or particle measurement < Range Lower Value.

cbool.gif

Measurement Type specifies whether the measurement is in uncalibrated pixels or calibrated real-world values.

cbool.gif

Keep/Remove Particles (F) controls whether particles that meet any of the criteria specified in Selection Values are removed. When Keep/Remove Particles is TRUE, particles meeting any of the criteria are removed. If FALSE, only particles meeting any of the criteria remain.

cerrcodeclst.gif

error in (no error) describes the error status 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.

cbool.gif

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.

ci32.gif

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.

cstr.gif

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. The default is an empty string.

cbool.gif

Reject Border? (F), when TRUE, rejects border particles. The default value is FALSE.

cbool.gif

Fill Holes? (F), when TRUE, fills holes in the binary object. The default value is FALSE. If Fill Holes? is TRUE and Reject Border? is TRUE, then holes in the binary object are filled after border particles are rejected.

igenclasstagrefflat.gif

Image Dst Out is a reference to the destination image. If Image Dst is connected, Image Dst Out is the same as Image Dst. Otherwise, Image Dst Out refers to the image referenced by Image Src.

ii32.gif

Number of Particles indicates the number of particles detected in the image.

ierrcodeclst.gif

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 indicator on the front panel and select Explain Error from the shortcut menu for more information about the error.

ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

ii32.gif

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.

istr.gif

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. The default is an empty string.