gray_histoT_gray_histoGrayHistoGrayHisto (Operator)

Name

gray_histoT_gray_histoGrayHistoGrayHisto — Calculate the gray value distribution.

Signature

gray_histo(Regions, Image : : : AbsoluteHisto, RelativeHisto)

Herror T_gray_histo(const Hobject Regions, const Hobject Image, Htuple* AbsoluteHisto, Htuple* RelativeHisto)

void GrayHisto(const HObject& Regions, const HObject& Image, HTuple* AbsoluteHisto, HTuple* RelativeHisto)

HTuple HImage::GrayHisto(const HRegion& Regions, HTuple* RelativeHisto) const

HTuple HRegion::GrayHisto(const HImage& Image, HTuple* RelativeHisto) const

static void HOperatorSet.GrayHisto(HObject regions, HObject image, out HTuple absoluteHisto, out HTuple relativeHisto)

HTuple HImage.GrayHisto(HRegion regions, out HTuple relativeHisto)

HTuple HRegion.GrayHisto(HImage image, out HTuple relativeHisto)

Description

The operator gray_histogray_histoGrayHistoGrayHistoGrayHisto calculates for the image (ImageImageImageImageimage) within RegionsRegionsRegionsRegionsregions the absolute (AbsoluteHistoAbsoluteHistoAbsoluteHistoAbsoluteHistoabsoluteHisto) and relative (RelativeHistoRelativeHistoRelativeHistoRelativeHistorelativeHisto) histogram of the gray values.

Both histograms are tupels of 256 values, which --- beginning at 0 --- contain the frequencies of the individual gray values of the image.

AbsoluteHistoAbsoluteHistoAbsoluteHistoAbsoluteHistoabsoluteHisto indicates the absolute frequencies of the gray values in integers, and RelativeHistoRelativeHistoRelativeHistoRelativeHistorelativeHisto indicates the relative, i.e. the absolute frequencies divided by the area of the image as floating point numbers.

'real'"real""real""real""real"-, 'int2'"int2""int2""int2""int2"-, 'uint2'"uint2""uint2""uint2""uint2"-, and 'int4'"int4""int4""int4""int4"-images are transformed into 'byte'"byte""byte""byte""byte"-images (first the largest and smallest gray value in the image are determined, and then the original gray values are mapped linearly into the area 0..255) and then processed as mentioned above. The histogram can also be returned directly as a graphic via the operators set_paint(::WindowHandle,'histogram':)set_paint(WindowHandle,"histogram")SetPaint(WindowHandle,"histogram")SetPaint(WindowHandle,"histogram")SetPaint(WindowHandle,"histogram") and disp_imagedisp_imageDispImageDispImageDispImage.

Attention

Note that the operator gray_histogray_histoGrayHistoGrayHistoGrayHisto only considers the given RegionsRegionsRegionsRegionsregions and ignores any previously set domain of the input image ImageImageImageImageimage.

Real, int2, uint2, and int4 images are reduced to 256 gray values.

gray_histogray_histoGrayHistoGrayHistoGrayHisto can be executed on OpenCL devices for byte, int1, directional and cyclic images if the OpenCL device supports the cl_khr_local_int32_base_atomics and cl_khr_global_int32_base_atomics extensions (which are optional in OpenCL 1.0). Unlike most other HALCON operators, gray_histogray_histoGrayHistoGrayHistoGrayHisto can be substantially slower on an OpenCL device if the ImageImageImageImageimage is not completely included in the RegionsRegionsRegionsRegionsregions.

OpenCL support is not available in HALCON XL, as 64 bit atomic integer arithmetic would be required.

Execution Information

Parameters

RegionsRegionsRegionsRegionsregions (input_object)  region(-array) objectHRegionHRegionHobject

Region in which the histogram is to be calculated.

ImageImageImageImageimage (input_object)  singlechannelimage objectHImageHImageHobject (byte* / cyclic* / direction* / int1* / int2 / uint2 / int4 / real) *allowed for compute devices

Image the gray value distribution of which is to be calculated.

AbsoluteHistoAbsoluteHistoAbsoluteHistoAbsoluteHistoabsoluteHisto (output_control)  histogram-array HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Absolute frequencies of the gray values.

RelativeHistoRelativeHistoRelativeHistoRelativeHistorelativeHisto (output_control)  histogram-array HTupleHTupleHtuple (real) (double) (double) (double)

Frequencies, normalized to the area of the region.

Complexity

If F is the area of the region the runtime complexity is O(F + 255).

Result

The operator gray_histogray_histoGrayHistoGrayHistoGrayHisto returns the value 2 (H_MSG_TRUE) if the image has defined gray values and the parameters are correct. The behavior in case of empty input (no input images available) is set via the operator set_system(::'no_object_result',<Result>:)set_system("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>), the behavior in case of empty region is set via set_system(::'empty_region_result',<Result>:)set_system("empty_region_result",<Result>)SetSystem("empty_region_result",<Result>)SetSystem("empty_region_result",<Result>)SetSystem("empty_region_result",<Result>). If necessary an exception is raised.

Possible Successors

histo_to_threshhisto_to_threshHistoToThreshHistoToThreshHistoToThresh, gen_region_histogen_region_histoGenRegionHistoGenRegionHistoGenRegionHisto

Alternatives

min_max_graymin_max_grayMinMaxGrayMinMaxGrayMinMaxGray, intensityintensityIntensityIntensityIntensity, gray_histo_absgray_histo_absGrayHistoAbsGrayHistoAbsGrayHistoAbs, gray_histo_rangegray_histo_rangeGrayHistoRangeGrayHistoRangeGrayHistoRange

See also

set_paintset_paintSetPaintSetPaintSetPaint, disp_imagedisp_imageDispImageDispImageDispImage, histo_2dimhisto_2dimHisto2dimHisto2dimHisto2dim, scale_image_maxscale_image_maxScaleImageMaxScaleImageMaxScaleImageMax, entropy_grayentropy_grayEntropyGrayEntropyGrayEntropyGray

Module

Foundation