Skip to content

distance_transformDistanceTransformDistanceTransformdistance_transformdistance_transform🔗

Short description🔗

distance_transformDistanceTransformDistanceTransformdistance_transformdistance_transform — Compute the distance transformation of a region.

Signature🔗

distance_transform( region Region, out image DistanceImage, string Metric, string Foreground, extent.x Width, extent.y Height )void DistanceTransform( const HObject& Region, HObject* DistanceImage, const HTuple& Metric, const HTuple& Foreground, const HTuple& Width, const HTuple& Height )static void HOperatorSet.DistanceTransform( HObject region, out HObject distanceImage, HTuple metric, HTuple foreground, HTuple width, HTuple height )def distance_transform( region: HObject, metric: str, foreground: str, width: int, height: int ) -> HObject

Herror distance_transform( const Hobject Region, Hobject* DistanceImage, const char* Metric, const char* Foreground, const Hlong Width, const Hlong Height )

Herror T_distance_transform( const Hobject Region, Hobject* DistanceImage, const Htuple Metric, const Htuple Foreground, const Htuple Width, const Htuple Height )

HImage HRegion::DistanceTransform( const HString& Metric, const HString& Foreground, Hlong Width, Hlong Height ) const

HImage HRegion::DistanceTransform( const char* Metric, const char* Foreground, Hlong Width, Hlong Height ) const

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

HImage HRegion.DistanceTransform( string metric, string foreground, int width, int height )

Description🔗

distance_transformDistanceTransform computes for every point of the input region Regionregionregion (or its complement, respectively) the distance of the point to the border of the region. The parameter Foregroundforegroundforeground determines whether the distances are calculated for all points within the region (Foregroundforegroundforeground = 'true'"true") or for all points outside the region (Foregroundforegroundforeground = 'false'"false"). The distance is computed for every point of the output image DistanceImagedistanceImagedistance_image, which has the specified dimensions Widthwidthwidth and Heightheightheight. 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_regionMoveRegion) 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_rectangle1SmallestRectangle1.

The parameter Metricmetricmetric determines which metric is used for the calculation of the distances. If Metricmetricmetric = '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 Metricmetricmetric = '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 Metricmetricmetric = 'octagonal'"octagonal", a combination of these approaches is used, which leads to diagonal paths receiving a higher weight. If Metricmetricmetric = '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 Metricmetricmetric = 'chamfer-3-4-unnormalized'"chamfer-3-4-unnormalized". Finally, if Metricmetricmetric = 'euclidean'"euclidean", the computed distance is approximately Euclidean.

Execution information🔗

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🔗

Regionregionregion (input_object) region(-array) → objectHObjectHRegionHObjectHobject

Region for which the distance to the border is computed.

DistanceImagedistanceImagedistance_image (output_object) image → object (int4)HObject (int4)HImage (int4)HObject (int4)Hobject * (int4)

Image containing the distance information.

Metricmetricmetric (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Type of metric to be used for the distance transformation.

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

Foregroundforegroundforeground (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

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

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

Widthwidthwidth (input_control) extent.x → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Width of the output image.

Default: 640640
Suggested values: 160, 192, 320, 384, 640, 768160, 192, 320, 384, 640, 768
Value range: 1 ≤ Width

Heightheightheight (input_control) extent.y → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Height of the output image.

Default: 480480
Suggested values: 120, 144, 240, 288, 480, 576120, 144, 240, 288, 480, 576
Value range: 1 ≤ Height

Example🔗

(HDevelop)

* Step towards extracting the medial axis of a shape:
gen_rectangle1 (Rectangle1, 0, 0, 200, 400)
gen_rectangle1 (Rectangle2, 200, 0, 400, 200)
union2 (Rectangle1, Rectangle2, Shape)
distance_transform (Shape, DistanceImage, 'chessboard', 'true', 640, 480)

Complexity🔗

The runtime complexity is \(O(\textrm{Width}*\textrm{Height})\).

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

thresholdThreshold, dyn_thresholdDynThreshold, regiongrowingRegiongrowing

Possible successors

thresholdThreshold

Alternatives

closest_point_transformClosestPointTransform

See also

skeletonSkeleton

References🔗

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