Package pygeodesy :: Module frechet :: Class Frechet6Tuple |
[frames] | no frames]

# Class Frechet6Tuple

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

6-Tuple `(fd, fi1, fi2, r, n, units)` with the discrete Fréchet distance `fd`, fractional indices `fi1` and `fi2` as `FIx`, the recursion depth `r`, the number of distances computed `n` and the units class or class or name of the distance `units`.

If fractional indices `fi1` and `fi2` are `int`, the returned `fd` is the distance between `points1[fi1]` and `points2[fi2]`. For `float` indices, the distance is between an intermediate point along `points1[int(fi1)]` and `points1[int(fi1) + 1]` respectively an intermediate point along `points2[int(fi2)]` and `points2[int(fi2) + 1]`.

Use function fractional to compute the point at a fractional index.

Instance Methods
toUnits(self, **Error) Overloaded `_NamedTuple.toUnits` for `fd` 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_ = ``(``'``fd``'``,` `'``fi1``'``,` `'``fi2``'``,` `'``r``'``,` `'``n``'``,` `'``units``'``)`` Tuple specifying the `name` of each `Named-Tuple` item.
| _Units_ = `_Pass, FIx, FIx, Number_, Number_, _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 `fd` 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:
      ('fd', 'fi1', 'fi2', 'r', 'n', 'units')

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