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

# Class Hausdorff6Tuple

       object --+
                |
            tuple --+
                    |
       object --+   |
                |   |
     named._Named --+
                    |
    named._NamedTuple --+
                        |
                       Hausdorff6Tuple

6-Tuple `(hd, i, j, mn, md, units)` with the Hausdorff distance `hd`, indices `i` and `j`, the total count `mn`, the `mean Hausdorff` distance `md` and the class or name of both distance `units`.

For `directed Hausdorff` distances, count `mn` is the number of model points considered. For `symmetric Hausdorff` distances count `mn` twice that.

Indices `i` and `j` are the `model` respectively `target` point with the `hd` distance.

Mean distance `md` is `None` if an `early break` occurred and early breaking was enabled by keyword argument `early=True`.

Instance Methods
toUnits(self, **Error) Overloaded `_NamedTuple.toUnits` for `hd` and `md` units. |
Inherited from `named._NamedTuple`: `__delattr__`, `__getattr__`, `__getitem__`, `__repr__`, `__setattr__`, `__str__`, `items`, `iteritems`, `iterunits`, `toRepr`, `toStr`, `units` Inherited from `tuple`: `__add__`, `__contains__`, `__eq__`, `__ge__`, `__getattribute__`, `__getnewargs__`, `__getslice__`, `__gt__`, `__hash__`, `__iter__`, `__le__`, `__len__`, `__lt__`, `__mul__`, `__ne__`, `__rmul__`, `count`, `index` Inherited from `named._Named`: `_DOT_`, `attrs`, `classof`, `copy`, `rename`, `toStr2` Inherited from `object`: `__format__`, `__init__`, `__reduce__`, `__reduce_ex__`, `__sizeof__`, `__subclasshook__`

Static Methods
Inherited from `named._NamedTuple`: `__new__`

Class Variables
| _Names_ = ``(``'``hd``'``,` `'``i``'``,` `'``j``'``,` `'``mn``'``,` `'``md``'``,` `'``units``'``)`` Tuple specifying the `name` of each `Named-Tuple` item.
| _Units_ = `_Pass, Number_, Number_, Number_, _Pass, _Pass` Tuple defining the `units` of the value of each `Named-Tuple` item.

Properties
Inherited from `named._NamedTuple`: `iteration` Inherited from `named._Named`: `classname`, `classnaming`, `name`, `named`, `named2`, `named3`, `named4` Inherited from `object`: `__class__`

Method Details

### toUnits (self, **Error) |
Overloaded `_NamedTuple.toUnits` for `hd` and `md` units. Arguments: `Error` - Error to raise for units issues (`UnitError`). Returns: A duplicate of this `Named-Tuple` (``Named-Tuple``). Raises: `Error` - Invalid `Named-Tuple` item or units class. Overrides: named._NamedTuple.toUnits

Class Variable Details

  ### _Names_ Tuple specifying the `name` of each `Named-Tuple` item. Note: Specify at least 2 item names. Value:
      ('hd', 'i', 'j', 'mn', 'md', 'units')

  ### _Units_ Tuple defining the `units` of the value of each `Named-Tuple` item. Note: The `len(_Units_)` must match `len(_Names_)`. Value:
      _Pass, Number_, Number_, Number_, _Pass, _Pass