imaqGetParticleInfo

NI Vision for LabWindows/CVI Function

imaqGetParticleInfo

Usage

ParticleReport* imaqGetParticleInfo(Image* image, int connectivity8, ParticleInfoMode mode, int* reportCount);

Purpose

Calculates various measurements of particles in a binary image.

Note  This function is obsolete. Use imaqCountParticles() and imaqMeasureParticle() to get information about particles in your image.

Image Types Supported

IMAQ_IMAGE_U8

Parameters

Name

Type

Description

image Image* The binary image containing particles on which the function gets particle information. The calculation modifies the border of the image.
connectivity8 int Set this parameter to TRUE to use connectivity-8 to determine whether particles are touching. Set this parameter to FALSE to use connectivity-4 to determine whether particles are touching. For more information about connectivity, see Chapter 9, Binary Morphology, in the NI Vision Concepts Manual.
mode ParticleInfoMode Controls the extent of particle information that the function returns.
reportCount int* On return, filled with the number of reports in the array returned by the function. Set this parameter to NULL if you do not need this information.

Return Value

Type

Description

ParticleReport* On success, this function returns a pointer to an array of reports about the particles in the image. On failure, this function returns NULL. To get extended error information, call imaqGetLastError(). When you are finished with this data, dispose of the array by calling imaqDispose().

Parameter Discussion

source—This function modifies the source image. If you need the original image, create a copy of the image using imaqDuplicate() before using this function.