Operator Reference

HALCON Operator Reference / Regions / Transformations

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

rank_regionrank_regionRankRegionRankRegionrank_region (Operator)

rank_regionrank_regionRankRegionRankRegionrank_region — Rank operator for regions.

Signature

rank_region(Region : RegionCount : Width, Height, Number : )

Herror rank_region(const Hobject Region, Hobject* RegionCount, const Hlong Width, const Hlong Height, const Hlong Number)

Herror T_rank_region(const Hobject Region, Hobject* RegionCount, const Htuple Width, const Htuple Height, const Htuple Number)

void RankRegion(const HObject& Region, HObject* RegionCount, const HTuple& Width, const HTuple& Height, const HTuple& Number)

HRegion HRegion::RankRegion(Hlong Width, Hlong Height, Hlong Number) const

static void HOperatorSet.RankRegion(HObject region, out HObject regionCount, HTuple width, HTuple height, HTuple number)

HRegion HRegion.RankRegion(int width, int height, int number)

def rank_region(region: HObject, width: int, height: int, number: int) -> HObject

Description

rank_regionrank_regionRankRegionRankRegionrank_region calculates the binary rank operator. A filter mask of size HeightHeightHeightheightheight x WidthWidthWidthwidthwidth) is used. In the process, for each point in the region the number of points of RegionRegionRegionregionregion lying within the filter mask are counted. If this number is greater or equal to NumberNumberNumbernumbernumber, the current point is added to the output region. If is chosen, the median operator is obtained.

Attention

For HeightHeightHeightheightheight and WidthWidthWidthwidthwidth only odd values > 3 are valid. If invalid parameters are chosen they are converted automatically (without raising an exception) to the next larger odd values.

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

RegionRegionRegionregionregion (input_object)  region(-array) → objectHRegionHObjectHObjectHobject

Region(s) to be transformed.

RegionCountRegionCountRegionCountregionCountregion_count (output_object)  region(-array) → objectHRegionHObjectHObjectHobject *

Resulting region(s).

WidthWidthWidthwidthwidth (input_control)  extent.x → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Width of the filter mask.

Default: 15

Suggested values: 3, 5, 7, 9, 11, 13, 15, 17, 19, 21

Value range: 3 ≤ Width Width Width width width ≤ 511 (lin)

Minimum increment: 2

Recommended increment: 2

Restriction: Width >= 3 && odd(Width)

HeightHeightHeightheightheight (input_control)  extent.y → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Height of the filter mask.

Default: 15

Suggested values: 3, 5, 7, 9, 11, 13, 15, 17, 19, 21

Value range: 3 ≤ Height Height Height height height ≤ 511 (lin)

Minimum increment: 2

Recommended increment: 2

Restriction: Height >= 3 && odd(Height)

NumberNumberNumbernumbernumber (input_control)  integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Minimum number of points lying within the filter mask.

Default: 70

Suggested values: 5, 10, 20, 40, 60, 80, 90, 120, 150, 200

Value range: 1 ≤ Number Number Number number number ≤ 1000 (lin)

Minimum increment: 1

Recommended increment: 10

Restriction: Number > 0

Example (HDevelop)

read_image(Image,'monkey')
mean_image(Image,Mean,5,5)
dyn_threshold(Image,Mean,Points,25,'light')
rank_region(Points,Textur,15,15,30)
gen_circle(Mask,10,10,3)
opening(Textur,Mask,Seg)

Example (C)

read_image(&Image,"monkey");
mean_image(Image,&Mean,5,5);
dyn_threshold(Image,Mean,&Points,25,"light");
rank_region(Points,Textur,15,15,30);
gen_circle(&Mask,10,10,3);
opening(Textur,Mask,&Seg);

Example (HDevelop)

read_image(Image,'monkey')
mean_image(Image,Mean,5,5)
dyn_threshold(Image,Mean,Points,25,'light')
rank_region(Points,Textur,15,15,30)
gen_circle(Mask,10,10,3)
opening(Textur,Mask,Seg)

Example (HDevelop)

read_image(Image,'monkey')
mean_image(Image,Mean,5,5)
dyn_threshold(Image,Mean,Points,25,'light')
rank_region(Points,Textur,15,15,30)
gen_circle(Mask,10,10,3)
opening(Textur,Mask,Seg)

Complexity

Let F be the area of the input region. Then the runtime complexity is O(F * 8).

Result

rank_regionrank_regionRankRegionRankRegionrank_region returns 2 ( H_MSG_TRUE) if all parameters are correct. The behavior in case of empty input (no regions given) can be set via 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>) and the behavior in case of an empty input region 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.

Possible Predecessors

thresholdthresholdThresholdThresholdthreshold, connectionconnectionConnectionConnectionconnection, regiongrowingregiongrowingRegiongrowingRegiongrowingregiongrowing, pouringpouringPouringPouringpouring, class_ndim_normclass_ndim_normClassNdimNormClassNdimNormclass_ndim_norm

Possible Successors

select_shapeselect_shapeSelectShapeSelectShapeselect_shape, disp_regiondisp_regionDispRegionDispRegiondisp_region

Alternatives

closing_rectangle1closing_rectangle1ClosingRectangle1ClosingRectangle1closing_rectangle1, expand_regionexpand_regionExpandRegionExpandRegionexpand_region

See also

rank_imagerank_imageRankImageRankImagerank_image, mean_imagemean_imageMeanImageMeanImagemean_image

Module

Foundation

---

ClassesClasses | | Operators