Table Of Contents

Particle Filter (G Dataflow)

Last Modified: October 26, 2017

Filters each particle in an image according to its measurements by keeping or removing.

This node modifies the source image. If you need the original source image, create a copy of the image using the Copy Image node before using this node.

connector_pane_image
datatype_icon

ROI descriptor

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

datatype_icon

global rectangle

Coordinates of the bounding rectangle.

datatype_icon

contours

Individual shapes that define an ROI.

datatype_icon

ID

Object specifying if contour is the external or internal edge of an ROI.

datatype_icon

Type

Shape type of the contour.

datatype_icon

Coordinates

Relative position of the contour.

datatype_icon

connectivity 4/8?

Boolean value that specifies the mode of connectivity used by the algorithm for particle detection.

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

The connectivity mode directly determines whether an adjacent pixel belongs to the same particle or a different particle.

Default: 8

datatype_icon

image src

Reference to the source image.

datatype_icon

image dst

Reference to the destination image.

datatype_icon

filter criteria

Criteria used to filter the particle in the image.

datatype_icon

measurement parameter

Measurement on which you want to filter.

datatype_icon

range lower value

Lower value of the range for the chosen parameter.

datatype_icon

range upper value

Upper value of the range for the chosen parameter.

datatype_icon

range

Boolean that specifies whether to include or exclude the values given in range lower value and range upper value.

TRUE (Exclude) The particle meets the criteria if range upper value ≤ particle measurement or particle measurement < range lower value.
FALSE (Include) The particle meets the criteria if range lower value ≤ particle measurement < range upper value.
datatype_icon

measurement type

Boolean that specifies if the measurement is in uncalibrated pixels or calibrated real-world values.

TRUE The measurement is in calibrated real-world values.
FALSE The measurement is in uncalibrated pixels.
datatype_icon

keep/remove particles?

Boolean that controls if particles that meet any of the criteria specified in filter criteria are removed.

TRUE Particles meeting any of the criteria are removed.
FALSE Only particles meeting any of the criteria remain.

Default: False

datatype_icon

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

datatype_icon

reject border

Boolean that specifies when to reject border particles.

TRUE Rejects the border particles.
FALSE Does not reject the border particles.

Default: FALSE

datatype_icon

fill holes

Boolean that specifies when to fill holes in the binary object.

If fill holes is TRUE and reject border is TRUE, then holes in the binary object are filled after border particles are rejected.

TRUE Fills holes in the binary object.
FALSE Does not fill holes in the binary object.

Default: FALSE

datatype_icon

image dst out

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.

datatype_icon

number of particles

Number of particles remaining in the image after filtering.

datatype_icon

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Where This Node Can Run:

Desktop OS: Windows

FPGA: Not supported

Web Server: Not supported in VIs that run in a web application


Recently Viewed Topics