IMAQ Particle Analysis VI

LabView NI Vision

IMAQ Particle Analysis VI

Owning Palette: AnalysisInstalled With: NI Vision Development Module

Returns the number of particles detected in a binary image and a 2D array of requested measurements about the particle.

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.

Examples

IMAQ Particle Analysis

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 is a reference to the source image.

c1di32.gif

Pixel Measurements is an array of measurement parameters you can request for each particle. The parameters are returned as uncalibrated pixel measurements.

c1di32.gif

Real-World Measurements is an array of measurement parameters you can request for each particle. The parameters are returned as calibrated real-world measurements. If Image does not have any attached calibration information, the VI returns pixel measurements.

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.

ii32.gif

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

igenclasstagrefflat.gif

Image Out (duplicate) is a reference to the Image input.

i2ddbl.gif

Particle Measurements (Pixels) is a 2D array that returns the requested pixel measurements from the detected particles. The array has one column for each measurement requested in Pixel Measurements and one row for each particle detected.

i2ddbl.gif

Particle Measurements (Real-World) is a 2D array that returns the requested calibrated real-world measurements from the detected particles. The array has one column for each measurement requested in Real-World Measurements and one row for each particle detected. If Image does not have any attached calibration information, the VI returns pixel measurements.

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.

i1dbool.gif

Calibration Valid indicates whether the calibration information for a particle is valid. Calibration Valid has one Boolean for each report in Particle Reports (Real-World). If the calibration information is invalid for any pixel in the particle, the corresponding Calibration Valid Boolean is FALSE.

Note  A pixel has invalid calibration information when the pixel lies outside the area of the image that was calibrated.
Note   Particle Report (Real-World) contains measurements for every particle regardless of whether the particle has valid or invalid calibration information.

Examples

Refer to the following for an example that uses this VI.

  • LabVIEW\examples\Vision\2. Functions\Binary Analysis\Particle Analysis Example.vi