imaqCalcCoeff

NI Vision for LabWindows/CVI Function

imaqCalcCoeff

Usage

int imaqCalcCoeff(const Image* image, const ParticleReport* report, MeasurementValue parameter, float* coefficient);

Purpose

Returns a coefficient associated with a particle. Call imaqGetParticleInfo() before calling imaqCalcCoeff() to get the particle reports you need to pass to this function.

Note  This function is obsolete. The replacement function is imaqMeasureParticle(), which allows you to take both pixel and real-world measurements.

Image Types Supported

IMAQ_IMAGE_U8

Parameters

Name

Type

Description

image const Image* The image containing the particle.
report const ParticleReport* The particle report you want to use to calculate the coefficient. You must generate this report using imaqGetParticleInfo() with the mode parameter set to IMAQ_ALL_INFO. This parameter is required and cannot be NULL.
parameter MeasurementValue The coefficient to calculate.
coefficient float* On return, the coefficient you request. This parameter is required and cannot be NULL.

Return Value

Type

Description

int On success, this function returns a non-zero value. On failure, this function returns 0. To get extended error information, call imaqGetLastError().