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

# Class HausdorffKarney

      object --+
               |
    named._Named --+
                   |
           Hausdorff --+
                       |
        HausdorffDegrees --+
                           |
                          HausdorffKarney

Compute the `Hausdorff` distance based on the angular distance (in degrees) from Charles Karney's GeographicLib Geodesic Inverse method.

See Also: HausdorffEquirectangular, HausdorffEuclidean, HausdorffHaversine and HausdorffVincentys.

Instance Methods
__init__(self, points, datum=None, wrap=False, seed=None, name=`'````'`) New HausdorffKarney calculator. |
distance(self, p1, p2) Return the non-negative angular distance in `degrees`. |
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 `Hausdorff`: `point` Inherited from `named._Named`: `__repr__`, `__str__`, `_dot_`, `attrs`, `classof`, `copy`, `toStr`, `toStr2` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties
| datum An immutable property (`Read Only`).
Inherited from `Hausdorff`: `seed`, `units` Inherited from `named._Named`: `classname`, `classnaming`, `name`, `named`, `named2` Inherited from `object`: `__class__`

Method Details

### __init__(self, points, datum=None, wrap=False, seed=None, name=`'````'`) (Constructor) |
New HausdorffKarney calculator. Parameters: `points` - Initial set of points, aka the `model` or `template` (`LatLon`[], `Numpy2LatLon`[], `Tuple2LatLon`[] or `other`[]). `datum` - Optional datum (Datum to use, overriding the default `model points[0].datum`. `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`. `ImportError` - Package GeographicLib missing. `TypeError` - Invalid `datum`. Overrides: object.__init__

### distance(self, p1, p2) |
Return the non-negative angular distance in `degrees`. 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

Property Details

### datum An immutable property (`Read Only`). Get Method: datum(self) - Get the datum of this calculator (Datum). Set Method: immutable(inst, value) - Throws an `AttributeError`, always.