Operator Reference

Operators

Features

List of Operators ↓

This chapter contains operators that allow you to access the different features of regions.

List of Features

In the following, the available features are illustrated.

'area'"area""area""area""area":: Area of the object
'row'"row""row""row""row":: Row index of the center
'column'"column""column""column""column":: Column index of the center
'row1'"row1""row1""row1""row1":: Row index of upper left corner
'column1'"column1""column1""column1""column1":: Column index of upper left corner
'row2'"row2""row2""row2""row2":: Row index of lower right corner
'column2'"column2""column2""column2""column2":: Column index of lower right corner
'width'"width""width""width""width":: Width of the region (parallel to the coordinate axis)
'height'"height""height""height""height":: Height of the region (parallel to the coordinate axis)
'circularity'"circularity""circularity""circularity""circularity":: Circularity (see circularitycircularityCircularityCircularitycircularity)
'compactness'"compactness""compactness""compactness""compactness":: Compactness (see compactnesscompactnessCompactnessCompactnesscompactness)
'contlength'"contlength""contlength""contlength""contlength":: Total length of contour (see operator contlengthcontlengthContlengthContlengthcontlength)
'convexity'"convexity""convexity""convexity""convexity":: Convexity (see convexityconvexityConvexityConvexityconvexity)
'rectangularity'"rectangularity""rectangularity""rectangularity""rectangularity":: Rectangularity (see rectangularityrectangularityRectangularityRectangularityrectangularity)
'ra'"ra""ra""ra""ra":: Main radius of the equivalent ellipse (see elliptic_axiselliptic_axisEllipticAxisEllipticAxiselliptic_axis)
'rb'"rb""rb""rb""rb":: Secondary radius of the equivalent ellipse (see elliptic_axiselliptic_axisEllipticAxisEllipticAxiselliptic_axis)
'phi'"phi""phi""phi""phi":: Orientation of the equivalent ellipse see elliptic_axiselliptic_axisEllipticAxisEllipticAxiselliptic_axis)
'anisometry'"anisometry""anisometry""anisometry""anisometry":: Anisometry (see eccentricityeccentricityEccentricityEccentricityeccentricity)
'bulkiness'"bulkiness""bulkiness""bulkiness""bulkiness":: Bulkiness (see operator eccentricityeccentricityEccentricityEccentricityeccentricity)
'struct_factor'"struct_factor""struct_factor""struct_factor""struct_factor":: Structure Factor (see operator eccentricityeccentricityEccentricityEccentricityeccentricity)
'outer_radius'"outer_radius""outer_radius""outer_radius""outer_radius":: Radius of smallest surrounding circle (see smallest_circlesmallest_circleSmallestCircleSmallestCirclesmallest_circle)
'inner_radius'"inner_radius""inner_radius""inner_radius""inner_radius":: Radius of largest inner circle (see inner_circleinner_circleInnerCircleInnerCircleinner_circle)
'inner_width'"inner_width""inner_width""inner_width""inner_width":: Width of the largest axis-parallel rectangle that fits into the region (see inner_rectangle1inner_rectangle1InnerRectangle1InnerRectangle1inner_rectangle1)
'inner_height'"inner_height""inner_height""inner_height""inner_height":: Height of the largest axis-parallel rectangle that fits into the region (see inner_rectangle1inner_rectangle1InnerRectangle1InnerRectangle1inner_rectangle1)
'dist_mean'"dist_mean""dist_mean""dist_mean""dist_mean":: Mean distance from the region border to the center (see operator roundnessroundnessRoundnessRoundnessroundness)
'dist_deviation'"dist_deviation""dist_deviation""dist_deviation""dist_deviation":: Deviation of the distance from the region border to the center (see operator roundnessroundnessRoundnessRoundnessroundness)
'roundness'"roundness""roundness""roundness""roundness":: Roundness (see operator roundnessroundnessRoundnessRoundnessroundness)
'num_sides'"num_sides""num_sides""num_sides""num_sides":: Number of polygon sides (see operator roundnessroundnessRoundnessRoundnessroundness)
'connect_num'"connect_num""connect_num""connect_num""connect_num":: Number of connection components (see operator connect_and_holesconnect_and_holesConnectAndHolesConnectAndHolesconnect_and_holes)
'holes_num'"holes_num""holes_num""holes_num""holes_num":: Number of holes (see operator connect_and_holesconnect_and_holesConnectAndHolesConnectAndHolesconnect_and_holes)
'area_holes'"area_holes""area_holes""area_holes""area_holes":: Area of the holes of the object (see operator area_holesarea_holesAreaHolesAreaHolesarea_holes)
'max_diameter'"max_diameter""max_diameter""max_diameter""max_diameter":: Maximum diameter of the region (see operator diameter_regiondiameter_regionDiameterRegionDiameterRegiondiameter_region)
'orientation'"orientation""orientation""orientation""orientation":: Orientation of the region (see operator orientation_regionorientation_regionOrientationRegionOrientationRegionorientation_region)
'euler_number'"euler_number""euler_number""euler_number""euler_number":: Euler number (see operator euler_numbereuler_numberEulerNumberEulerNumbereuler_number)
'rect2_phi'"rect2_phi""rect2_phi""rect2_phi""rect2_phi":: Orientation of the smallest surrounding rectangle (see operator smallest_rectangle2smallest_rectangle2SmallestRectangle2SmallestRectangle2smallest_rectangle2)
'rect2_len1'"rect2_len1""rect2_len1""rect2_len1""rect2_len1":: Half the length of the smallest surrounding rectangle (see operator smallest_rectangle2smallest_rectangle2SmallestRectangle2SmallestRectangle2smallest_rectangle2)
'rect2_len2'"rect2_len2""rect2_len2""rect2_len2""rect2_len2":: Half the width of the smallest surrounding rectangle (see operator smallest_rectangle2smallest_rectangle2SmallestRectangle2SmallestRectangle2smallest_rectangle2)
'moments_m11'"moments_m11""moments_m11""moments_m11""moments_m11":: Geometric moments of the region (see operator moments_region_2ndmoments_region_2ndMomentsRegion2ndMomentsRegion2ndmoments_region_2nd)
'moments_m20'"moments_m20""moments_m20""moments_m20""moments_m20":: Geometric moments of the region (see operator moments_region_2ndmoments_region_2ndMomentsRegion2ndMomentsRegion2ndmoments_region_2nd)
'moments_m02'"moments_m02""moments_m02""moments_m02""moments_m02":: Geometric moments of the region (see operator moments_region_2ndmoments_region_2ndMomentsRegion2ndMomentsRegion2ndmoments_region_2nd)
'moments_ia'"moments_ia""moments_ia""moments_ia""moments_ia":: Geometric moments of the region (see operator moments_region_2ndmoments_region_2ndMomentsRegion2ndMomentsRegion2ndmoments_region_2nd)
'moments_ib'"moments_ib""moments_ib""moments_ib""moments_ib":: Geometric moments of the region (see operator moments_region_2ndmoments_region_2ndMomentsRegion2ndMomentsRegion2ndmoments_region_2nd)
'moments_m11_invar'"moments_m11_invar""moments_m11_invar""moments_m11_invar""moments_m11_invar":: Geometric moments of the region (see operator moments_region_2nd_invarmoments_region_2nd_invarMomentsRegion2ndInvarMomentsRegion2ndInvarmoments_region_2nd_invar)
'moments_m20_invar'"moments_m20_invar""moments_m20_invar""moments_m20_invar""moments_m20_invar":: Geometric moments of the region (see operator moments_region_2nd_invarmoments_region_2nd_invarMomentsRegion2ndInvarMomentsRegion2ndInvarmoments_region_2nd_invar)
'moments_m02_invar'"moments_m02_invar""moments_m02_invar""moments_m02_invar""moments_m02_invar":: Geometric moments of the region (see operator moments_region_2nd_invarmoments_region_2nd_invarMomentsRegion2ndInvarMomentsRegion2ndInvarmoments_region_2nd_invar)
'moments_phi1'"moments_phi1""moments_phi1""moments_phi1""moments_phi1":: Geometric moments of the region (see operator moments_region_2nd_rel_invarmoments_region_2nd_rel_invarMomentsRegion2ndRelInvarMomentsRegion2ndRelInvarmoments_region_2nd_rel_invar)
'moments_phi2'"moments_phi2""moments_phi2""moments_phi2""moments_phi2":: Geometric moments of the region (see operator moments_region_2nd_rel_invarmoments_region_2nd_rel_invarMomentsRegion2ndRelInvarMomentsRegion2ndRelInvarmoments_region_2nd_rel_invar)
'moments_m21'"moments_m21""moments_m21""moments_m21""moments_m21":: Geometric moments of the region (see operator moments_region_3rdmoments_region_3rdMomentsRegion3rdMomentsRegion3rdmoments_region_3rd)
'moments_m12'"moments_m12""moments_m12""moments_m12""moments_m12":: Geometric moments of the region (see operator moments_region_3rdmoments_region_3rdMomentsRegion3rdMomentsRegion3rdmoments_region_3rd)
'moments_m03'"moments_m03""moments_m03""moments_m03""moments_m03":: Geometric moments of the region (see operator moments_region_3rdmoments_region_3rdMomentsRegion3rdMomentsRegion3rdmoments_region_3rd)
'moments_m30'"moments_m30""moments_m30""moments_m30""moments_m30":: Geometric moments of the region (see operator moments_region_3rdmoments_region_3rdMomentsRegion3rdMomentsRegion3rdmoments_region_3rd)
'moments_m21_invar'"moments_m21_invar""moments_m21_invar""moments_m21_invar""moments_m21_invar":: Geometric moments of the region (see operator moments_region_3rd_invarmoments_region_3rd_invarMomentsRegion3rdInvarMomentsRegion3rdInvarmoments_region_3rd_invar)
'moments_m12_invar'"moments_m12_invar""moments_m12_invar""moments_m12_invar""moments_m12_invar":: Geometric moments of the region (see operator moments_region_3rd_invarmoments_region_3rd_invarMomentsRegion3rdInvarMomentsRegion3rdInvarmoments_region_3rd_invar)
'moments_m03_invar'"moments_m03_invar""moments_m03_invar""moments_m03_invar""moments_m03_invar":: Geometric moments of the region (see operator moments_region_3rd_invarmoments_region_3rd_invarMomentsRegion3rdInvarMomentsRegion3rdInvarmoments_region_3rd_invar)
'moments_m30_invar'"moments_m30_invar""moments_m30_invar""moments_m30_invar""moments_m30_invar":: Geometric moments of the region (see operator moments_region_3rd_invarmoments_region_3rd_invarMomentsRegion3rdInvarMomentsRegion3rdInvarmoments_region_3rd_invar)
'moments_i1'"moments_i1""moments_i1""moments_i1""moments_i1":: Geometric moments of the region (see operator moments_region_centralmoments_region_centralMomentsRegionCentralMomentsRegionCentralmoments_region_central)
'moments_i2'"moments_i2""moments_i2""moments_i2""moments_i2":: Geometric moments of the region (see operator moments_region_centralmoments_region_centralMomentsRegionCentralMomentsRegionCentralmoments_region_central)
'moments_i3'"moments_i3""moments_i3""moments_i3""moments_i3":: Geometric moments of the region (see operator moments_region_centralmoments_region_centralMomentsRegionCentralMomentsRegionCentralmoments_region_central)
'moments_i4'"moments_i4""moments_i4""moments_i4""moments_i4":: Geometric moments of the region (see operator moments_region_centralmoments_region_centralMomentsRegionCentralMomentsRegionCentralmoments_region_central)
'moments_psi1'"moments_psi1""moments_psi1""moments_psi1""moments_psi1":: Geometric moments of the region (see operator moments_region_central_invarmoments_region_central_invarMomentsRegionCentralInvarMomentsRegionCentralInvarmoments_region_central_invar)
'moments_psi2'"moments_psi2""moments_psi2""moments_psi2""moments_psi2":: Geometric moments of the region (see operator moments_region_central_invarmoments_region_central_invarMomentsRegionCentralInvarMomentsRegionCentralInvarmoments_region_central_invar)
'moments_psi3'"moments_psi3""moments_psi3""moments_psi3""moments_psi3":: Geometric moments of the region (see operator moments_region_central_invarmoments_region_central_invarMomentsRegionCentralInvarMomentsRegionCentralInvarmoments_region_central_invar)
'moments_psi4'"moments_psi4""moments_psi4""moments_psi4""moments_psi4":: Geometric moments of the region (see operator moments_region_central_invarmoments_region_central_invarMomentsRegionCentralInvarMomentsRegionCentralInvarmoments_region_central_invar)

List of Operators

area_centerAreaCenterarea_centerAreaCenterarea_center: Area and center of regions.

area_holesAreaHolesarea_holesAreaHolesarea_holes: Compute the area of holes of regions.

circularityCircularitycircularityCircularitycircularity: Shape factor for the circularity (similarity to a circle) of a region.

compactnessCompactnesscompactnessCompactnesscompactness: Shape factor for the compactness of a region.

connect_and_holesConnectAndHolesconnect_and_holesConnectAndHolesconnect_and_holes: Number of connection components and holes

contlengthContlengthcontlengthContlengthcontlength: Contour length of a region.

convexityConvexityconvexityConvexityconvexity: Shape factor for the convexity of a region.

diameter_regionDiameterRegiondiameter_regionDiameterRegiondiameter_region: Maximal distance between two boundary points of a region.

eccentricityEccentricityeccentricityEccentricityeccentricity: Shape features derived from the ellipse parameters.

elliptic_axisEllipticAxiselliptic_axisEllipticAxiselliptic_axis: Calculate the parameters of the equivalent ellipse.

euler_numberEulerNumbereuler_numberEulerNumbereuler_number: Calculate the Euler number.

find_neighborsFindNeighborsfind_neighborsFindNeighborsfind_neighbors: Search direct neighbors.

get_region_indexGetRegionIndexget_region_indexGetRegionIndexget_region_index: Index of all regions containing a given pixel.

get_region_thicknessGetRegionThicknessget_region_thicknessGetRegionThicknessget_region_thickness: Access the thickness of a region along the main axis.

hamming_distanceHammingDistancehamming_distanceHammingDistancehamming_distance: Hamming distance between two regions.

hamming_distance_normHammingDistanceNormhamming_distance_normHammingDistanceNormhamming_distance_norm: Hamming distance between two regions using normalization.

height_width_ratioHeightWidthRatioheight_width_ratioHeightWidthRatioheight_width_ratio: Compute the width, height, and aspect ratio of the surrounding rectangle parallel to the coordinate axes.

inner_circleInnerCircleinner_circleInnerCircleinner_circle: Largest inner circle of a region.

inner_rectangle1InnerRectangle1inner_rectangle1InnerRectangle1inner_rectangle1: Largest inner rectangle of a region.

moments_region_2ndMomentsRegion2ndmoments_region_2ndMomentsRegion2ndmoments_region_2nd: Calculate the geometric moments of regions.

moments_region_2nd_invarMomentsRegion2ndInvarmoments_region_2nd_invarMomentsRegion2ndInvarmoments_region_2nd_invar: Geometric moments of regions.

moments_region_2nd_rel_invarMomentsRegion2ndRelInvarmoments_region_2nd_rel_invarMomentsRegion2ndRelInvarmoments_region_2nd_rel_invar: Geometric moments of regions.

moments_region_3rdMomentsRegion3rdmoments_region_3rdMomentsRegion3rdmoments_region_3rd: Geometric moments of regions.

moments_region_3rd_invarMomentsRegion3rdInvarmoments_region_3rd_invarMomentsRegion3rdInvarmoments_region_3rd_invar: Geometric moments of regions.

moments_region_centralMomentsRegionCentralmoments_region_centralMomentsRegionCentralmoments_region_central: Geometric moments of regions.

moments_region_central_invarMomentsRegionCentralInvarmoments_region_central_invarMomentsRegionCentralInvarmoments_region_central_invar: Geometric moments of regions.

orientation_regionOrientationRegionorientation_regionOrientationRegionorientation_region: Orientation of a region.

rectangularityRectangularityrectangularityRectangularityrectangularity: Shape factor for the rectangularity of a region.

region_featuresRegionFeaturesregion_featuresRegionFeaturesregion_features: Calculate shape features of regions.

roundnessRoundnessroundnessRoundnessroundness: Shape factors from contour.

runlength_distributionRunlengthDistributionrunlength_distributionRunlengthDistributionrunlength_distribution: Distribution of runs needed for runlength encoding of a region.

runlength_featuresRunlengthFeaturesrunlength_featuresRunlengthFeaturesrunlength_features: Characteristic values for runlength coding of regions.

select_region_pointSelectRegionPointselect_region_pointSelectRegionPointselect_region_point: Choose all regions containing a given pixel.

select_region_spatialSelectRegionSpatialselect_region_spatialSelectRegionSpatialselect_region_spatial: Pose relation of regions.

select_shapeSelectShapeselect_shapeSelectShapeselect_shape: Choose regions with the aid of shape features.

select_shape_protoSelectShapeProtoselect_shape_protoSelectShapeProtoselect_shape_proto: Choose regions having a certain relation to each other.

select_shape_stdSelectShapeStdselect_shape_stdSelectShapeStdselect_shape_std: Select regions of a given shape.

smallest_circleSmallestCirclesmallest_circleSmallestCirclesmallest_circle: Smallest surrounding circle of a region.

smallest_rectangle1SmallestRectangle1smallest_rectangle1SmallestRectangle1smallest_rectangle1: Surrounding rectangle parallel to the coordinate axes.

smallest_rectangle2SmallestRectangle2smallest_rectangle2SmallestRectangle2smallest_rectangle2: Smallest surrounding rectangle with any orientation.

spatial_relationSpatialRelationspatial_relationSpatialRelationspatial_relation: Pose relation of regions with regard to the coordinate axes.

Operators