Cog3DRangeImageHeightCalculator.Execute Method (CogImage16Range, ICogRegion, Cog3DPlane)

Cog3DRangeImageHeightCalculator Execute Method (CogImage16Range, ICogRegion, Cog3DPlane)

Cognex VisionPro

Computes the height between the surface defined by the range image pixels and the specified base plane.

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

Syntax

public Cog3DRangeImageHeightCalculatorResult Execute(
	CogImage16Range rangeImage,
	ICogRegion region,
	Cog3DPlane basePlane
)

public Cog3DRangeImageHeightCalculatorResult Execute(
	CogImage16Range rangeImage,
	ICogRegion region,
	Cog3DPlane basePlane
)

Public Function Execute ( 
	rangeImage As CogImage16Range,
	region As ICogRegion,
	basePlane As Cog3DPlane
) As Cog3DRangeImageHeightCalculatorResult

Public Function Execute ( 
	rangeImage As CogImage16Range,
	region As ICogRegion,
	basePlane As Cog3DPlane
) As Cog3DRangeImageHeightCalculatorResult

public:
Cog3DRangeImageHeightCalculatorResult^ Execute(
	CogImage16Range^ rangeImage, 
	ICogRegion^ region, 
	Cog3DPlane^ basePlane
)

public:
Cog3DRangeImageHeightCalculatorResult^ Execute(
	CogImage16Range^ rangeImage, 
	ICogRegion^ region, 
	Cog3DPlane^ basePlane
)

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

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.

basePlane: Type: Cognex.VisionPro3D Cog3DPlane
The plane relative to which the height is calculated. (see also PlaneSide). The basePlane can be null to use a horizontal plane at z = 0.

Exceptions

Exception	Condition
CogOperatorNoInputImageException	Thrown if rangeImage is null.
ArgumentException	Thrown if rangeImage is is not allocated. Thrown if rangeImage has a transform that is singular (i.e., not invertible). Thrown if basePlane is degenerate.
InvalidOperationException	Thrown if LowTailFrac + HighTailFrac is greater than 1. Thrown if HeightRangeFilterLow is greater than HeightRangeFilterHigh.
[CogSpaceTreeNotInTreeException]	if the SelectedSpaceName3D of the range image is not in the tree, or if the SelectedSpaceName3D of the plane is not in the tree.