IMAQ Object Tracking Options VI

Download PDF

Updated2023-02-21
8 minute(s) read

Owning Palette: Tracking
Requires: NI Vision Development Module

Specifies the options to use for tracking objects.

Examples

IMAQ Mean Shift Options

Specifies the options to use for mean shift object tracking.

IMAQ Mean Shift Options

Object Tracking Session In is a reference to the object tracking session.

Get/Set (Get) specifies whether the VI gets or sets the property value. TRUE sets the property value. FALSE gets the property value. The default is TRUE.

Mean Shift Options in controls the options for mean shift object tracking.

	Number of Histogram Bins specifies the number of bins per band to use for the object description. The default is 8.
	Blending Parameter sets the ratio that the algorithm blends the current frame with the previous frame to track an object. Values range from 0% to 100%. 100% results in the algorithm inspecting the current frame only. 0% results in the algorithm inspecting the previous frame only. The default is 10%.
	Maximum Iterations specifies the maximum number of iterations the mean shift tracking process is repeated until convergence on the new location of the object. The default is 15.

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.

	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.
	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.
	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.

Object Tracking Session Out is a reference to the object tracking session.

Mean Shift Options out indicates the options for mean shift object tracking.

	Number of Histogram Bins indicates the number of bins per band to use for the object description.
	Blending Parameter indicates the ratio that the algorithm uses.
	Maximum Iterations indicates the maximum number of iterations the mean shift tracking process is repeated.

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.

	status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
	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.
	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.

IMAQ Shape Adapted Options

Specifies the options to use for shape adapted object tracking.

IMAQ Shape Adapted Options

Object Tracking Session In is a reference to the object tracking session.

Shape Adapted Options in controls the behavior of the shape adapted algorithm.

	Number of Histogram Bins specifies the number of bins per band to use for the object description. The default is 8.
	Blending Parameter sets the ratio that the algorithm blends the current frame with the previous frame to track an object. Values range from 0% to 100%. 100% results in the algorithm inspecting the current frame only. 0% results in the algorithm inspecting the previous frame only. The default is 10%.
	Max Scale Change sets the maximum acceptable scale change. Values range from 0% to 100%.
	Max Rotation Change sets the maximum acceptable rotation change. Values range from 0 degrees to 180 degrees.
	Max Shape Change sets the maximum acceptable shape change. Values range from 0% to 100%.
	Maximum Iterations specifies the maximum number of iterations the mean shift tracking process is repeated until convergence on the new location of the object. The default is 15.

Get/Set (Get) specifies whether the VI gets or sets the property value. TRUE sets the property value. FALSE gets the property value. The default is TRUE.

	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.
	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.
	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.

Object Tracking Session Out is a reference to the object tracking session.

Shape Adapted Options out specifies the options for the shape adapted algorithm.

	Number of Histogram Bins indicates the number of bins per band to use for the object description.
	Blending Parameter indicates the ratio that the algorithm uses.
	Max Scale Change indicates the maximum acceptable scale change.
	Max Rotation Change indicates the maximum acceptable rotation change.
	Max Shape Change indicates the maximum acceptable shape change.
	Maximum Iterations indicates the maximum number of iterations the mean shift tracking process is repeated.

	status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
	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.
	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.

Examples

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

LabVIEW\examples\Vision\Tracking\Object Tracking.vi

NI Vision for LabVIEW

Table of Contents

IMAQ Object Tracking Options VI

IMAQ Mean Shift Options

IMAQ Shape Adapted Options

Examples