top_hattop_hatTopHatTopHattop_hat (Operator)
Name
top_hattop_hatTopHatTopHattop_hat — Compute the top hat of regions.
Signature
Description
top_hattop_hatTopHatTopHatTopHattop_hat computes the openingopeningOpeningOpeningOpeningopening of
RegionRegionRegionRegionregionregion with StructElementStructElementStructElementStructElementstructElementstruct_element. The difference
between the original region and the result of the opening is called
the top hat. In contrast to openingopeningOpeningOpeningOpeningopening, which splits
regions under certain circumstances, top_hattop_hatTopHatTopHatTopHattop_hat computes
the regions removed by such a splitting.
The position of StructElementStructElementStructElementStructElementstructElementstruct_element is meaningless, since an
opening operation is invariant with respect to the choice of the
reference point.
Structuring elements (StructElementStructElementStructElementStructElementstructElementstruct_element) can be generated
with operators such as gen_circlegen_circleGenCircleGenCircleGenCirclegen_circle, gen_rectangle1gen_rectangle1GenRectangle1GenRectangle1GenRectangle1gen_rectangle1,
gen_rectangle2gen_rectangle2GenRectangle2GenRectangle2GenRectangle2gen_rectangle2, gen_ellipsegen_ellipseGenEllipseGenEllipseGenEllipsegen_ellipse,
draw_regiondraw_regionDrawRegionDrawRegionDrawRegiondraw_region, gen_region_polygongen_region_polygonGenRegionPolygonGenRegionPolygonGenRegionPolygongen_region_polygon,
gen_region_pointsgen_region_pointsGenRegionPointsGenRegionPointsGenRegionPointsgen_region_points, etc.
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
RegionRegionRegionRegionregionregion (input_object) region(-array) → objectHRegionHObjectHRegionHobject
Regions to be processed.
StructElementStructElementStructElementStructElementstructElementstruct_element (input_object) region → objectHRegionHObjectHRegionHobject
Structuring element (position independent).
RegionTopHatRegionTopHatRegionTopHatRegionTopHatregionTopHatregion_top_hat (output_object) region(-array) → objectHRegionHObjectHRegionHobject *
Result of the top hat operator.
Result
top_hattop_hatTopHatTopHatTopHattop_hat returns 2 (H_MSG_TRUE) if all parameters are correct.
The behavior in case of empty or no input region can be set via:
-
no region:
set_system('no_object_result',<RegionResult>)set_system("no_object_result",<RegionResult>)SetSystem("no_object_result",<RegionResult>)SetSystem("no_object_result",<RegionResult>)SetSystem("no_object_result",<RegionResult>)set_system("no_object_result",<RegionResult>)
-
empty region:
set_system('empty_region_result',<RegionResult>)set_system("empty_region_result",<RegionResult>)SetSystem("empty_region_result",<RegionResult>)SetSystem("empty_region_result",<RegionResult>)SetSystem("empty_region_result",<RegionResult>)set_system("empty_region_result",<RegionResult>)
Otherwise, an exception is raised.
Possible Predecessors
thresholdthresholdThresholdThresholdThresholdthreshold,
regiongrowingregiongrowingRegiongrowingRegiongrowingRegiongrowingregiongrowing,
connectionconnectionConnectionConnectionConnectionconnection,
union1union1Union1Union1Union1union1,
watershedswatershedsWatershedsWatershedsWatershedswatersheds,
class_ndim_normclass_ndim_normClassNdimNormClassNdimNormClassNdimNormclass_ndim_norm,
gen_circlegen_circleGenCircleGenCircleGenCirclegen_circle,
gen_ellipsegen_ellipseGenEllipseGenEllipseGenEllipsegen_ellipse,
gen_rectangle1gen_rectangle1GenRectangle1GenRectangle1GenRectangle1gen_rectangle1,
gen_rectangle2gen_rectangle2GenRectangle2GenRectangle2GenRectangle2gen_rectangle2,
draw_regiondraw_regionDrawRegionDrawRegionDrawRegiondraw_region,
gen_region_pointsgen_region_pointsGenRegionPointsGenRegionPointsGenRegionPointsgen_region_points,
gen_region_polygon_filledgen_region_polygon_filledGenRegionPolygonFilledGenRegionPolygonFilledGenRegionPolygonFilledgen_region_polygon_filled
Possible Successors
reduce_domainreduce_domainReduceDomainReduceDomainReduceDomainreduce_domain,
select_shapeselect_shapeSelectShapeSelectShapeSelectShapeselect_shape,
area_centerarea_centerAreaCenterAreaCenterAreaCenterarea_center,
connectionconnectionConnectionConnectionConnectionconnection
Alternatives
openingopeningOpeningOpeningOpeningopening,
differencedifferenceDifferenceDifferenceDifferencedifference
See also
bottom_hatbottom_hatBottomHatBottomHatBottomHatbottom_hat,
gray_tophatgray_tophatGrayTophatGrayTophatGrayTophatgray_tophat,
openingopeningOpeningOpeningOpeningopening
Module
Foundation