dual_rankdual_rankDualRankDualRankdual_rank (Operator)

Name

dual_rankdual_rankDualRankDualRankdual_rank — Opening, Median and Closing with circle or rectangle mask.

Signature

dual_rank(Image : ImageRank : MaskType, Radius, ModePercent, Margin : )

Herror dual_rank(const Hobject Image, Hobject* ImageRank, const char* MaskType, const Hlong Radius, const Hlong ModePercent, const char* Margin)

Herror T_dual_rank(const Hobject Image, Hobject* ImageRank, const Htuple MaskType, const Htuple Radius, const Htuple ModePercent, const Htuple Margin)

void DualRank(const HObject& Image, HObject* ImageRank, const HTuple& MaskType, const HTuple& Radius, const HTuple& ModePercent, const HTuple& Margin)

HImage HImage::DualRank(const HString& MaskType, Hlong Radius, Hlong ModePercent, const HTuple& Margin) const

HImage HImage::DualRank(const HString& MaskType, Hlong Radius, Hlong ModePercent, const HString& Margin) const

HImage HImage::DualRank(const char* MaskType, Hlong Radius, Hlong ModePercent, const char* Margin) const

HImage HImage::DualRank(const wchar_t* MaskType, Hlong Radius, Hlong ModePercent, const wchar_t* Margin) const   ( Windows only)

static void HOperatorSet.DualRank(HObject image, out HObject imageRank, HTuple maskType, HTuple radius, HTuple modePercent, HTuple margin)

HImage HImage.DualRank(string maskType, int radius, int modePercent, HTuple margin)

HImage HImage.DualRank(string maskType, int radius, int modePercent, string margin)

def dual_rank(image: HObject, mask_type: str, radius: int, mode_percent: int, margin: Union[int, float, str]) -> HObject

Description

The operator dual_rankdual_rankDualRankDualRankdual_rank carries out a non-linear transformation of the gray values of all input images (ImageImageImageimageimage). Circles or squares can be used as structuring elements. The operator dual_rankdual_rankDualRankDualRankdual_rank effects two consecutive calls of rank_imagerank_imageRankImageRankImagerank_image. At the first call the range gray value is calculated with the indicated range (ModePercentModePercentModePercentmodePercentmode_percent). The result of this calculation is the input of a further call of rank_imagerank_imageRankImageRankImagerank_image, this time using the range value 100-ModePercentModePercentModePercentmodePercentmode_percent.

When filtering different parameters for border treatment (MarginMarginMarginmarginmargin) can be chosen:

gray value

Pixels outside of the image border are assumed to be constant (with the indicated gray value).

'continued'"continued""continued""continued""continued"

Continuation of the gray values at the image border.

'cyclic'"cyclic""cyclic""cyclic""cyclic"

Cyclic continuation at the image borders.

'mirrored'"mirrored""mirrored""mirrored""mirrored"

Reflection of pixels at the image borders.

A range filtering is calculated according to the following scheme: The indicated mask is put over the image to be filtered in such a way that the center of the mask touches all pixels once. For each of these pixels all neighboring pixels covered by the mask are sorted in an ascending sequence corresponding to their gray values. Each sorted sequence of gray values contains the same number of gray values like the mask has image points. The n-th highest element, (= ModePercentModePercentModePercentmodePercentmode_percent, rank values between 0...100 in percent) is selected and set as result gray value in the corresponding result image.

If ModePercentModePercentModePercentmodePercentmode_percent is 0, then the operator equals to the gray value opening (gray_openinggray_openingGrayOpeningGrayOpeninggray_opening). If ModePercentModePercentModePercentmodePercentmode_percent is 50, the operator results in the median filter, which is applied twice (median_imagemedian_imageMedianImageMedianImagemedian_image). The ModePercentModePercentModePercentmodePercentmode_percent 100 in dual_rankdual_rankDualRankDualRankdual_rank means that it calculates the gray value closing (gray_closinggray_closingGrayClosingGrayClosinggray_closing). Choosing parameter values inside this range results in a smooth transformation of these operators.

For an explanation of the concept of smoothing filters see the introduction of chapter Filters / Smoothing.

Attention

Note that filter operators may return unexpected results if an image with a reduced domain is used as input. Please refer to the chapter Filters.

Execution Information

Parameters

ImageImageImageimageimage (input_object)  (multichannel-)image(-array) objectHImageHObjectHObjectHobject (byte / int2 / uint2 / int4 / real)

Image to be filtered.

ImageRankImageRankImageRankimageRankimage_rank (output_object)  multichannel-image(-array) objectHImageHObjectHObjectHobject * (byte / int2 / uint2 / int4 / real)

Filtered Image.

MaskTypeMaskTypeMaskTypemaskTypemask_type (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Shape of the mask.

Default: 'circle' "circle" "circle" "circle" "circle"

List of values: 'circle'"circle""circle""circle""circle", 'square'"square""square""square""square"

RadiusRadiusRadiusradiusradius (input_control)  integer HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Radius of the filter mask.

Default: 1

Suggested values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 15, 19, 25, 31, 39, 47, 59

Value range: 1 ≤ Radius Radius Radius radius radius ≤ 101

Minimum increment: 1

Recommended increment: 2

ModePercentModePercentModePercentmodePercentmode_percent (input_control)  integer HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Filter Mode: 0 corresponds to a gray value opening , 50 corresponds to a median and 100 to a gray values closing.

Default: 10

Suggested values: 0, 2, 5, 10, 15, 20, 40, 50, 60, 80, 85, 90, 95, 98, 100

Value range: 0 ≤ ModePercent ModePercent ModePercent modePercent mode_percent ≤ 100

Minimum increment: 1

Recommended increment: 2

MarginMarginMarginmarginmargin (input_control)  string HTupleUnion[int, float, str]HTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)

Border treatment.

Default: 'mirrored' "mirrored" "mirrored" "mirrored" "mirrored"

Suggested values: 'mirrored'"mirrored""mirrored""mirrored""mirrored", 'cyclic'"cyclic""cyclic""cyclic""cyclic", 'continued'"continued""continued""continued""continued", 0, 30, 60, 90, 120, 150, 180, 210, 240, 255

Example (HDevelop)

read_image(Image,'fabrik')
dual_rank(Image,ImageOpening,'circle',10,10,'mirrored')
dev_display(ImageOpening)

Example (C)

read_image(&Image,"fabrik");
dual_rank(Image,&ImageOpening,"circle",10,10,"mirrored");
disp_image(ImageOpening,WindowHandle);

Example (HDevelop)

read_image(Image,'fabrik')
dual_rank(Image,ImageOpening,'circle',10,10,'mirrored')
dev_display(ImageOpening)

Example (HDevelop)

read_image(Image,'fabrik')
dual_rank(Image,ImageOpening,'circle',10,10,'mirrored')
dev_display(ImageOpening)

Complexity

For each pixel: with F = area of the structuring element.

Result

If the parameter values are correct the operator dual_rankdual_rankDualRankDualRankdual_rank returns the value 2 ( H_MSG_TRUE) . 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>). If necessary an exception is raised.

Possible Predecessors

read_imageread_imageReadImageReadImageread_image

Possible Successors

thresholdthresholdThresholdThresholdthreshold, dyn_thresholddyn_thresholdDynThresholdDynThresholddyn_threshold, sub_imagesub_imageSubImageSubImagesub_image, regiongrowingregiongrowingRegiongrowingRegiongrowingregiongrowing

Alternatives

rank_imagerank_imageRankImageRankImagerank_image, gray_closinggray_closingGrayClosingGrayClosinggray_closing, gray_openinggray_openingGrayOpeningGrayOpeninggray_opening, median_imagemedian_imageMedianImageMedianImagemedian_image

See also

gen_circlegen_circleGenCircleGenCirclegen_circle, gen_rectangle1gen_rectangle1GenRectangle1GenRectangle1gen_rectangle1, gray_erosion_rectgray_erosion_rectGrayErosionRectGrayErosionRectgray_erosion_rect, gray_dilation_rectgray_dilation_rectGrayDilationRectGrayDilationRectgray_dilation_rect, sigma_imagesigma_imageSigmaImageSigmaImagesigma_image

References

W. Eckstein, O. Munkelt “Extracting Objects from Digital Terrain Model” Remote Sensing and Reconstruction for Threedimensional Objects and Scenes, SPIE Symposium on Optical Science, Engeneering, and Instrumentation, July 1995, San Diego

Module

Foundation