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

# Class HausdorffHaversine

      object --+
               |
    named._Named --+
                   |
           Hausdorff --+
                       |
        HausdorffRadians --+
                           |
                          HausdorffHaversine

Compute the `Hausdorff` distance based on the angular `Haversine` distance (in radians) from function haversine_.

Note: See note under HausdorffVincentys.

See Also: HausdorffEquirectangular, HausdorffEuclidean, HausdorffKarney and HausdorffVincentys.

Instance Methods
__init__(self, points, wrap=False, seed=None, name=`'````'`) New HausdorffHaversine calculator. |
distance(self, p1, p2) Return the haversine_ distance in `radians`. |
directed(self, points, early=True) Compute only the `forward Hausdorff` distance. |
symmetric(self, points, early=True) Compute the combined `forward and reverse Hausdorff` distance. |
Inherited from `HausdorffRadians`: `point` Inherited from `named._Named`: `__copy__`, `__repr__`, `__str__`, `classof`, `copy` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties
Inherited from `Hausdorff`: `seed`, `units` Inherited from `named._Named`: `classname`, `classnaming`, `name`, `named`, `named2` Inherited from `object`: `__class__`

Method Details

### __init__(self, points, wrap=False, seed=None, name=`'````'`) (Constructor) |
New HausdorffHaversine calculator. Parameters: `points` - Initial set of points, aka the `model` or `template` (`LatLon`[], `Numpy2LatLon`[], `Tuple2LatLon`[] or `other`[]). `wrap` - Wrap and unroll180 longitudes (`bool`). `seed` - Random sampling seed (`any`) or `None`, `0` or `False` for no random sampling. `name` - Optional calculator name (`str`). Raises: `HausdorffError` - Insufficient number of `points` or invalid `seed`. Overrides: object.__init__

### distance(self, p1, p2) |
Return the haversine_ distance in `radians`. Raises: `AssertionError` - Not overloaded. Overrides: Hausdorff.distance

### directed(self, points, early=True) |
Compute only the `forward Hausdorff` distance. Parameters: `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`. Overrides: Hausdorff.directed

### symmetric(self, points, early=True) |
Compute the combined `forward and reverse Hausdorff` distance. Parameters: `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`. Overrides: Hausdorff.symmetric