Cog3DRangeImageHeightCalculatorResult.Histogram Property

Cog3DRangeImageHeightCalculatorResult Histogram Property

Cognex VisionPro

Returns a histogram of the height values of the individual range image pixels. See also: GetHeightFromHistogramBin(Int32) and GetHistogramBinFromHeight(Double)

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

Syntax

C++

Copy to Clipboard Print

public int[] Histogram { get; }

public int[] Histogram { get; }

Public ReadOnly Property Histogram As Integer()
	Get

Public ReadOnly Property Histogram As Integer()
	Get

public:
property array<int>^ Histogram {
	array<int>^ get ();
}

public:
property array<int>^ Histogram {
	array<int>^ get ();
}

Property Value

Type: Int32
Note that this property will return null if was false or if the height calculation included 0 used pixels. See: PixelCounts.

Remarks

Note that only pixels that were "used" as part of the actual height calculation are included in the histogram data. For example, the histogram bins for any height values that were filtered out by the height range filter will contain 0 pixels.

In the context of the height calculator, "used" pixels are the image pixels that contribute to the height calculation.

A range image pixel is "used" to calculate the height if:

it is inside the 2D input Region of the tool.
it is marked "care" in the optional InputImageMask provided as part of the RunParams.
it is marked as "visible pixel" in the visible pixel mask of the InputImage. The visible pixel mask can be accessed by calling GetMaskData on the range image.
its height falls within the valid height range configured in the height tool's run parameters. See HeightRangeFilterEnabled.

Pixels that meet these conditions contribute to the height computation and are marked as "used" in the PixelCountsDiagImage.

Only "used" pixels are included in the height tool's Histogram data.

Note that the height of an individual range image pixel is defined as the signed distance from the center of the range image pixel to the nearest point on the base plane (measured in selected space 3D units).

By default the positive height direction is defined to be in the same direction as the normal vector of the base plane. However, the positive height direction can be reversed by setting the [P:Cognex::VisionPro3D::Cog3DRangeImageHeightCalculator::PlaneSide] property.