Operator Reference

HALCON Operator Reference / Image / Features
ClassesClasses | | Operators

plane_deviationplane_deviationPlaneDeviationPlaneDeviationplane_deviation (Operator)

plane_deviationplane_deviationPlaneDeviationPlaneDeviationplane_deviation — Calculate the deviation of the gray values from the approximating image plane.

Signature

plane_deviation(Regions, Image : : : Deviation)

Herror plane_deviation(const Hobject Regions, const Hobject Image, double* Deviation)

Herror T_plane_deviation(const Hobject Regions, const Hobject Image, Htuple* Deviation)

void PlaneDeviation(const HObject& Regions, const HObject& Image, HTuple* Deviation)

HTuple HImage::PlaneDeviation(const HRegion& Regions) const

HTuple HRegion::PlaneDeviation(const HImage& Image) const

static void HOperatorSet.PlaneDeviation(HObject regions, HObject image, out HTuple deviation)

HTuple HImage.PlaneDeviation(HRegion regions)

HTuple HRegion.PlaneDeviation(HImage image)

def plane_deviation(regions: HObject, image: HObject) -> Sequence[float]

def plane_deviation_s(regions: HObject, image: HObject) -> float

Description

The operator plane_deviationplane_deviationPlaneDeviationPlaneDeviationplane_deviation calculates the deviation of the gray values in ImageImageImageimageimage from the approximation of the gray values through a plane. Contrary to the standard deviation in case of intensityintensityIntensityIntensityintensity slanted gray value planes also receive the value zero. The gray value plane is calculated according to gen_image_gray_rampgen_image_gray_rampGenImageGrayRampGenImageGrayRampgen_image_gray_ramp. If F is the area of the region, , , and the parameters of the image plane, and (r',c') the center of the region, DeviationDeviationDeviationdeviationdeviation is defined by:

Attention

Note that the operator plane_deviationplane_deviationPlaneDeviationPlaneDeviationplane_deviation only considers the given RegionsRegionsRegionsregionsregions and ignores any previously set domain of the input image ImageImageImageimageimage. It should be noted that the calculation of DeviationDeviationDeviationdeviationdeviation does not follow the usual definition. It is defined to return the value 0.0 for an image with only one pixel.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Automatically parallelized on tuple level.

Parameters

RegionsRegionsRegionsregionsregions (input_object)  region(-array) → objectHRegionHObjectHObjectHobject

Regions, of which the plane deviation is to be calculated.

ImageImageImageimageimage (input_object)  singlechannelimage → objectHImageHObjectHObjectHobject (byte / cyclic)

Gray value image.

DeviationDeviationDeviationdeviationdeviation (output_control)  real(-array) → HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Deviation of the gray values within a region.

Complexity

If F is the area of the region the runtime complexity amounts to O(F).

Result

The operator plane_deviationplane_deviationPlaneDeviationPlaneDeviationplane_deviation returns the value 2 ( H_MSG_TRUE) if ImageImageImageimageimage is of the type byte. 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>)set_system("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>)set_system("empty_region_result",<Result>). If necessary an exception is raised.

Alternatives

intensityintensityIntensityIntensityintensity, gen_image_gray_rampgen_image_gray_rampGenImageGrayRampGenImageGrayRampgen_image_gray_ramp, sub_imagesub_imageSubImageSubImagesub_image

See also

moments_gray_planemoments_gray_planeMomentsGrayPlaneMomentsGrayPlanemoments_gray_plane

Module

Foundation

ClassesClasses | | Operators