top_hattop_hatTopHatTopHat (Operator)
Name
top_hattop_hatTopHatTopHat — Compute the top hat of regions.
Signature
Description
top_hattop_hatTopHatTopHatTopHat computes the openingopeningOpeningOpeningOpening of
RegionRegionRegionRegionregion with StructElementStructElementStructElementStructElementstructElement. The difference
between the original region and the result of the opening is called
the top hat. In contrast to openingopeningOpeningOpeningOpening, which splits
regions under certain circumstances, top_hattop_hatTopHatTopHatTopHat computes
the regions removed by such a splitting.
The position of StructElementStructElementStructElementStructElementstructElement is meaningless, since an
opening operation is invariant with respect to the choice of the
reference point.
Structuring elements (StructElementStructElementStructElementStructElementstructElement) can be generated
with operators such as gen_circlegen_circleGenCircleGenCircleGenCircle, gen_rectangle1gen_rectangle1GenRectangle1GenRectangle1GenRectangle1,
gen_rectangle2gen_rectangle2GenRectangle2GenRectangle2GenRectangle2, gen_ellipsegen_ellipseGenEllipseGenEllipseGenEllipse,
draw_regiondraw_regionDrawRegionDrawRegionDrawRegion, gen_region_polygongen_region_polygonGenRegionPolygonGenRegionPolygonGenRegionPolygon,
gen_region_pointsgen_region_pointsGenRegionPointsGenRegionPointsGenRegionPoints, 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
RegionRegionRegionRegionregion (input_object) region(-array) → objectHRegionHRegionHobject
Regions to be processed.
StructElementStructElementStructElementStructElementstructElement (input_object) region → objectHRegionHRegionHobject
Structuring element (position independent).
RegionTopHatRegionTopHatRegionTopHatRegionTopHatregionTopHat (output_object) region(-array) → objectHRegionHRegionHobject *
Result of the top hat operator.
Result
top_hattop_hatTopHatTopHatTopHat 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>)
-
empty region:
set_system('empty_region_result',<RegionResult>)
Otherwise, an exception is raised.
Possible Predecessors
thresholdthresholdThresholdThresholdThreshold,
regiongrowingregiongrowingRegiongrowingRegiongrowingRegiongrowing,
connectionconnectionConnectionConnectionConnection,
union1union1Union1Union1Union1,
watershedswatershedsWatershedsWatershedsWatersheds,
class_ndim_normclass_ndim_normClassNdimNormClassNdimNormClassNdimNorm,
gen_circlegen_circleGenCircleGenCircleGenCircle,
gen_ellipsegen_ellipseGenEllipseGenEllipseGenEllipse,
gen_rectangle1gen_rectangle1GenRectangle1GenRectangle1GenRectangle1,
gen_rectangle2gen_rectangle2GenRectangle2GenRectangle2GenRectangle2,
draw_regiondraw_regionDrawRegionDrawRegionDrawRegion,
gen_region_pointsgen_region_pointsGenRegionPointsGenRegionPointsGenRegionPoints,
gen_region_polygon_filledgen_region_polygon_filledGenRegionPolygonFilledGenRegionPolygonFilledGenRegionPolygonFilled
Possible Successors
reduce_domainreduce_domainReduceDomainReduceDomainReduceDomain,
select_shapeselect_shapeSelectShapeSelectShapeSelectShape,
area_centerarea_centerAreaCenterAreaCenterAreaCenter,
connectionconnectionConnectionConnectionConnection
Alternatives
openingopeningOpeningOpeningOpening,
differencedifferenceDifferenceDifferenceDifference
See also
bottom_hatbottom_hatBottomHatBottomHatBottomHat,
gray_tophatgray_tophatGrayTophatGrayTophatGrayTophat,
openingopeningOpeningOpeningOpening
Module
Foundation