Cog3DRangeImageHeightCalculator.Execute Method (CogImage16Range, ICogRegion, Double)

Cog3DRangeImageHeightCalculator Execute Method (CogImage16Range, ICogRegion, Double)

Cognex VisionPro

Computes the height of the range image surface relative to a horizontal base plane with a user specified Z height.

The base plane has a 3D selected space coordinate normal vector (0, 0, 1), i.e. oriented along the positive z axis.

Namespace: Cognex.VisionPro3D
Assembly: Cognex.VisionPro3D (in Cognex.VisionPro3D.dll) Version: 65.1.0.0

Syntax

public Cog3DRangeImageHeightCalculatorResult Execute(
	CogImage16Range rangeImage,
	ICogRegion region,
	double horizontalPlaneZ
)

public Cog3DRangeImageHeightCalculatorResult Execute(
	CogImage16Range rangeImage,
	ICogRegion region,
	double horizontalPlaneZ
)

Public Function Execute ( 
	rangeImage As CogImage16Range,
	region As ICogRegion,
	horizontalPlaneZ As Double
) As Cog3DRangeImageHeightCalculatorResult

Public Function Execute ( 
	rangeImage As CogImage16Range,
	region As ICogRegion,
	horizontalPlaneZ As Double
) As Cog3DRangeImageHeightCalculatorResult

public:
Cog3DRangeImageHeightCalculatorResult^ Execute(
	CogImage16Range^ rangeImage, 
	ICogRegion^ region, 
	double horizontalPlaneZ
)

public:
Cog3DRangeImageHeightCalculatorResult^ Execute(
	CogImage16Range^ rangeImage, 
	ICogRegion^ region, 
	double horizontalPlaneZ
)

Parameters

rangeImage: Type: Cognex.VisionPro CogImage16Range
The range image surface data of which the height is calculated.

region: Type: Cognex.VisionPro ICogRegion
The 2D region of the range image which contains the pixels of interest. Only pixels contained within this region will be used to calculate the height. The region can be null to use the entire range image.

horizontalPlaneZ: Type: System Double
The z value (usually the height) of the horizontal 3D plane, in the selected space 3D coordinates of the range image

Return Value

Type: Cog3DRangeImageHeightCalculatorResult

Exceptions

Exception	Condition
CogOperatorNoInputImageException	Thrown if rangeImage is null.
CogImageNoPixelsException	Thrown if rangeImage is is not allocated.
ArgumentException	Thrown if rangeImage has a transform that is singular (i.e., not invertible).
InvalidOperationException	Thrown if LowTailFrac + HighTailFrac is greater than 1. Thrown if HeightRangeFilterLow is greater than HeightRangeFilterHigh.