Package pygeodesy :: Module hausdorff :: Class HausdorffDistanceTo |
[frames] | no frames]

# Class HausdorffDistanceTo

      object --+
               |
    named._Named --+
                   |
           Hausdorff --+
                       |
                      HausdorffDistanceTo

Compute the `Hausdorff` distance based on the distance from the points' `LatLon.distanceTo` method, conventionally in `meter`.

See Also: HausdorffCosineAndoyerLambert, HausdorffCosineForsytheAndoyerLambert, HausdorffExact, HausdorffFlatLocal, HausdorffHubeny, HausdorffThomas and HausdorffKarney.

Instance Methods
__init__(self, points, seed=None, name='', **distanceTo_kwds) New HausdorffDistanceTo calculator. |
directed(self, points, early=True) Compute only the `forward Hausdorff` distance. |
symmetric(self, points, early=True) Compute the combined `forward and reverse Hausdorff` distance. |
distance(self, p1, p2) Return the distance in `meter`. |
Inherited from `Hausdorff`: `point` Inherited from `named._Named`: `_DOT_`, `__imatmul__`, `__matmul__`, `__repr__`, `__rmatmul__`, `__str__`, `attrs`, `classof`, `copy`, `dup`, `rename`, `toRepr`, `toStr`, `toStr2` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties
Inherited from `Hausdorff`: `adjust`, `datum`, `seed`, `units`, `wrap` Inherited from `named._Named`: `classname`, `classnaming`, `name`, `named`, `named2`, `named3`, `named4` Inherited from `object`: `__class__`

Method Details

### __init__ (self, points, seed=None, name='', **distanceTo_kwds) (Constructor) |
New HausdorffDistanceTo calculator. Arguments: `points` - Initial set of points, aka the `model` or `template` (`LatLon`[]). `seed` - Random sampling seed (`any`) or `None`, `0` or `False` for no random sampling. `name` - Optional name for this interpolator (`str`). `distanceTo_kwds` - Optional keyword arguments for the `points`' `LatLon.distanceTo` method. Raises: `HausdorffError` - Insufficient number of `points` or an invalid `point` or `seed`. `ImportError` - Package geographiclib missing iff `points` are ellipsoidalKarney.LatLons. Overrides: object.__init__ Note: All `model`, `template` and `target` `points` must be instances of the same ellipsoidal or spherical `LatLon` class.

### directed (self, points, early=True) |
Compute only the `forward Hausdorff` distance. Arguments: `points` - Second set of points, aka the `target` (`LatLon`[], `Numpy2LatLon`[], `Tuple2LatLon`[] or `other`[]). `early` - Enable or disable early breaking (`bool`). Returns: A Hausdorff6Tuple`(hd, i, j, mn, md, units)`. Raises: `HausdorffError` - Insufficient number of `points` or an invalid `point`. Overrides: Hausdorff.directed Note: See `points` note at HausdorffDistanceTo.

### symmetric (self, points, early=True) |
Compute the combined `forward and reverse Hausdorff` distance. Arguments: `points` - Second set of points, aka the `target` (`LatLon`[], `Numpy2LatLon`[], `Tuple2LatLon`[] or `other`[]). `early` - Enable or disable early breaking (`bool`). Returns: A Hausdorff6Tuple`(hd, i, j, mn, md, units)`. Raises: `HausdorffError` - Insufficient number of `points` or an invalid `point`. Overrides: Hausdorff.symmetric Note: See `points` note at HausdorffDistanceTo.

### distance (self, p1, p2) |
Return the distance in `meter`. Overrides: Hausdorff.distance