Operator Reference

closest_point_transformclosest_point_transformClosestPointTransformClosestPointTransformclosest_point_transform (Operator)

closest_point_transformclosest_point_transformClosestPointTransformClosestPointTransformclosest_point_transform — Compute the closest-point transformation of a region.

Signature

Herror closest_point_transform(const Hobject Region, Hobject* Distances, Hobject* ClosestPoints, const char* Metric, const char* Foreground, const char* ClosestPointMode, const Hlong Width, const Hlong Height)

Herror T_closest_point_transform(const Hobject Region, Hobject* Distances, Hobject* ClosestPoints, const Htuple Metric, const Htuple Foreground, const Htuple ClosestPointMode, const Htuple Width, const Htuple Height)

void ClosestPointTransform(const HObject& Region, HObject* Distances, HObject* ClosestPoints, const HTuple& Metric, const HTuple& Foreground, const HTuple& ClosestPointMode, const HTuple& Width, const HTuple& Height)

HImage HRegion::ClosestPointTransform(HImage* ClosestPoints, const HString& Metric, const HString& Foreground, const HString& ClosestPointMode, Hlong Width, Hlong Height) const

HImage HRegion::ClosestPointTransform(HImage* ClosestPoints, const char* Metric, const char* Foreground, const char* ClosestPointMode, Hlong Width, Hlong Height) const

HImage HRegion::ClosestPointTransform(HImage* ClosestPoints, const wchar_t* Metric, const wchar_t* Foreground, const wchar_t* ClosestPointMode, Hlong Width, Hlong Height) const   ( Windows only)

static void HOperatorSet.ClosestPointTransform(HObject region, out HObject distances, out HObject closestPoints, HTuple metric, HTuple foreground, HTuple closestPointMode, HTuple width, HTuple height)

HImage HRegion.ClosestPointTransform(out HImage closestPoints, string metric, string foreground, string closestPointMode, int width, int height)

def closest_point_transform(region: HObject, metric: str, foreground: str, closest_point_mode: str, width: int, height: int) -> Tuple[HObject, HObject]

Description

closest_point_transformclosest_point_transformClosestPointTransformClosestPointTransformclosest_point_transform computes for every pixel of the input region RegionRegionRegionregionregion (or its complement, respectively) the distance to the closest pixel outside the region (i.e., to the pixel on the outside border of the region) and returns this information in DistancesDistancesDistancesdistancesdistances. In addition to the distance, the corresponding closest pixel is returned in ClosestPointsClosestPointsClosestPointsclosestPointsclosest_points.

The parameter ForegroundForegroundForegroundforegroundforeground determines whether the distances are calculated for all points within the region (ForegroundForegroundForegroundforegroundforeground = 'true'"true""true""true""true") or for all points outside the region (ForegroundForegroundForegroundforegroundforeground = 'false'"false""false""false""false"). The distance is computed for every pixel of the output images DistancesDistancesDistancesdistancesdistances and ClosestPointsClosestPointsClosestPointsclosestPointsclosest_points. The size of the images is specified by WidthWidthWidthwidthwidth and HeightHeightHeightheightheight. The input region is always clipped to the extent of the output image. If it is important that the distances within the entire region should be computed, the region should be moved (see move_regionmove_regionMoveRegionMoveRegionmove_region) so that it has only positive coordinates and the width and height of the output image should be large enough to contain the region. The extent of the input region can be obtained with smallest_rectangle1smallest_rectangle1SmallestRectangle1SmallestRectangle1smallest_rectangle1.

The parameter MetricMetricMetricmetricmetric determines which metric is used for the calculation of the distances. If MetricMetricMetricmetricmetric = 'city-block'"city-block""city-block""city-block""city-block", the distance is calculated from the shortest path from the point to the border of the region, where only horizontal and vertical “movements” are allowed. They are weighted with a weight of 1. If MetricMetricMetricmetricmetric = 'chessboard'"chessboard""chessboard""chessboard""chessboard", the distance is calculated from the shortest path to the border, where horizontal, vertical, and diagonal “movements” are allowed. They are weighted with a weight of 1. If MetricMetricMetricmetricmetric = 'octagonal'"octagonal""octagonal""octagonal""octagonal", a combination of these approaches is used, which leads to diagonal paths receiving a higher weight. If MetricMetricMetricmetricmetric = 'chamfer-3-4'"chamfer-3-4""chamfer-3-4""chamfer-3-4""chamfer-3-4", horizontal and vertical movements are weighted with a weight of 3, while diagonal movements are weighted with a weight of 4. To normalize the distances, the resulting distance image is divided by 3. Since this normalization step takes some time, and one usually is interested in the relative distances of the points, the normalization can be suppressed with MetricMetricMetricmetricmetric = 'chamfer-3-4-unnormalized'"chamfer-3-4-unnormalized""chamfer-3-4-unnormalized""chamfer-3-4-unnormalized""chamfer-3-4-unnormalized". Finally, if MetricMetricMetricmetricmetric = 'euclidean'"euclidean""euclidean""euclidean""euclidean", the computed distance is approximately Euclidean.

The parameter ClosestPointModeClosestPointModeClosestPointModeclosestPointModeclosest_point_mode determines how the closest points are stored. For ClosestPointModeClosestPointModeClosestPointModeclosestPointModeclosest_point_mode = 'absolute'"absolute""absolute""absolute""absolute", absolute coordinates are stored in ClosestPointsClosestPointsClosestPointsclosestPointsclosest_points. For ClosestPointModeClosestPointModeClosestPointModeclosestPointModeclosest_point_mode = 'relative'"relative""relative""relative""relative", the offset to the coordinate of the respective pixel is stored in ClosestPointsClosestPointsClosestPointsclosestPointsclosest_points.

Attention

It should be noted that the closest points are usually not unique, i.e., for each pixel in the image DistancesDistancesDistancesdistancesdistances, there usually exist several points on the outer border of the region that have the respective distance to that pixel. For example, all points on the skeleton of the region in the chosen metric have the same distance to at least two distinct points on the outer border of the region. closest_point_transformclosest_point_transformClosestPointTransformClosestPointTransformclosest_point_transform returns one of these points that is determined by the implementation of the algorithm. In particular, invariances with respect to rotation or mirroring of the region should not be expected.

Furthermore, it should be noted that for ForegroundForegroundForegroundforegroundforeground = 'true'"true""true""true""true", point coordinates that lie outside the image defined by WidthWidthWidthwidthwidth and HeightHeightHeightheightheight are returned if the input region RegionRegionRegionregionregion touches the border of this image, since in this case the outside border of the region lies one pixel outside of the image. If the returned coordinates should be used for a direct access to an image, a suitable border treatment must be implemented.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Parameters

RegionRegionRegionregionregion (input_object)  region(-array) objectHRegionHObjectHObjectHobject

Region for which the distance to the border is computed.

DistancesDistancesDistancesdistancesdistances (output_object)  image objectHImageHObjectHObjectHobject * (int4)

Image containing the distance information.

ClosestPointsClosestPointsClosestPointsclosestPointsclosest_points (output_object)  image objectHImageHObjectHObjectHobject * (vector_field)

Image containing the coordinates of the closest points.

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

Type of metric to be used for the closest-point transformation.

Default: 'city-block' "city-block" "city-block" "city-block" "city-block"

List of values: 'chamfer-3-4'"chamfer-3-4""chamfer-3-4""chamfer-3-4""chamfer-3-4", 'chamfer-3-4-unnormalized'"chamfer-3-4-unnormalized""chamfer-3-4-unnormalized""chamfer-3-4-unnormalized""chamfer-3-4-unnormalized", 'chessboard'"chessboard""chessboard""chessboard""chessboard", 'city-block'"city-block""city-block""city-block""city-block", 'euclidean'"euclidean""euclidean""euclidean""euclidean", 'octagonal'"octagonal""octagonal""octagonal""octagonal"

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

Compute the distance for pixels inside ('true'"true""true""true""true") or outside ('false'"false""false""false""false") the input region.

Default: 'true' "true" "true" "true" "true"

List of values: 'false'"false""false""false""false", 'true'"true""true""true""true"

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

Mode in which the coordinates of the closest points are returned.

Default: 'absolute' "absolute" "absolute" "absolute" "absolute"

List of values: 'absolute'"absolute""absolute""absolute""absolute", 'relative'"relative""relative""relative""relative"

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

Width of the output images.

Default: 640

Suggested values: 160, 192, 320, 384, 640, 768

Value range: 1 ≤ Width Width Width width width

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

Height of the output images.

Default: 480

Suggested values: 120, 144, 240, 288, 480, 576

Value range: 1 ≤ Height Height Height height height

Complexity

The runtime complexity is O(WidthWidthWidthwidthwidth*HeightHeightHeightheightheight).

Result

closest_point_transformclosest_point_transformClosestPointTransformClosestPointTransformclosest_point_transform returns 2 ( H_MSG_TRUE) if all parameters are correct.

Possible Predecessors

thresholdthresholdThresholdThresholdthreshold, dyn_thresholddyn_thresholdDynThresholdDynThresholddyn_threshold, regiongrowingregiongrowingRegiongrowingRegiongrowingregiongrowing

Possible Successors

thresholdthresholdThresholdThresholdthreshold, vector_field_to_realvector_field_to_realVectorFieldToRealVectorFieldToRealvector_field_to_real

Alternatives

distance_transformdistance_transformDistanceTransformDistanceTransformdistance_transform

See also

skeletonskeletonSkeletonSkeletonskeleton

References

Y. Ge, C.R. Maurer, Jr., J.M. Fitzpatrick: “Surface-based 3-D image registration using the Iterative Closest Point algorithm with a closest point transform”; in: “Medical Imaging 1996: Image Processing”, M.H. Loew, K.M. Hanson, Editors, Proc. SPIE 2710, pages 358--367, 1996.
P. Soille: “Morphological Image Analysis, Principles and Applications”; Springer Verlag Berlin Heidelberg New York, 1999.
G. Borgefors: “Distance Transformations in Arbitrary Dimensions”; Computer Vision, Graphics, and Image Processing, Vol. 27, pages 321--345, 1984.
P.E. Danielsson: “Euclidean Distance Mapping”; Computer Graphics and Image Processing, Vol. 14, pages 227--248, 1980.

Module

Foundation