Package pygeodesy :: Module units :: Class FIx |
[frames] | no frames]

# Class FIx

          object --+
                   |
               float --+
                       |
      object --+       |
               |       |
    named._Named --+   |
                   |   |
          _NamedUnit --+
                       |
                   Float --+
                           |
                      Float_ --+
                               |
                              FIx

A named Fractional Index, an `int` or `float` index into a `list` or `tuple` of `points`, typically. A `float` Fractional Index `fi` represents a location on the edge between `points[int(fi)]` and `points[(int(fi) + 1) % len(points)]`.

Instance Methods
fractional(self, points, wrap=None, LatLon=None, Vector=None, **kwds) Return the point at this Fractional Index. |
Inherited from `Float`: `__repr__`, `__str__`, `toRepr`, `toStr` Inherited from `float`: `__abs__`, `__add__`, `__coerce__`, `__div__`, `__divmod__`, `__eq__`, `__float__`, `__floordiv__`, `__format__`, `__ge__`, `__getattribute__`, `__getformat__`, `__getnewargs__`, `__gt__`, `__hash__`, `__int__`, `__le__`, `__long__`, `__lt__`, `__mod__`, `__mul__`, `__ne__`, `__neg__`, `__nonzero__`, `__pos__`, `__pow__`, `__radd__`, `__rdiv__`, `__rdivmod__`, `__rfloordiv__`, `__rmod__`, `__rmul__`, `__rpow__`, `__rsub__`, `__rtruediv__`, `__setformat__`, `__sub__`, `__truediv__`, `__trunc__`, `as_integer_ratio`, `conjugate`, `fromhex`, `hex`, `is_integer` Inherited from `named._Named`: `_DOT_`, `__imatmul__`, `__matmul__`, `__rmatmul__`, `attrs`, `classof`, `copy`, `dup`, `rename`, `toStr2` Inherited from `object`: `__delattr__`, `__init__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Static Methods
a new object with type S, a subtype of T |
__new__(cls, fi, fin=None, **name_Error) New Fractional Index in a `list` or `tuple` of points. |

Properties
| fin Get the given `len`, the index `[n]` wrapped to `[0]` (`int`).
Inherited from `float`: `imag`, `real` Inherited from `_NamedUnit`: `std_repr`, `units` Inherited from `named._Named`: `classname`, `classnaming`, `name`, `named`, `named2`, `named3`, `named4` Inherited from `object`: `__class__`

Method Details

### __new__ (cls, fi, fin=None, **name_Error) Static Method |
New Fractional Index in a `list` or `tuple` of points. Arguments: `fi` - The fractional index (`float` or `int`). `fin` - Optional `len`, the number of `points`, the index `[n]` wrapped to `[0]` (`int` or `None`). `name_Error` - Optional keyword argument `name=<name>` and/or `Error=<Exception>`. Returns: a new object with type S, a subtype of T The `fi` (named FIx). Raises: `Error` - Invalid `arg` or `arg` below `low` or above `high`. Overrides: object.__new__ Note: The returned `fi` may exceed the `flen` of the original `points` in certain open/closed cases. See Also: Method fractional or function pygeodesy.fractional.

### fractional (self, points, wrap=None, LatLon=None, Vector=None, **kwds) |
Return the point at this Fractional Index. Arguments: `points` - The points (`LatLon`[], Numpy2LatLon[], Tuple2LatLon[] or `other`[]). `wrap` - Wrap and unroll longitudes (`bool`) or `None` for backward compatible LatLon2Tuple or `LatLon` with averaged lat- and longitudes. `LatLon` - Optional class to return the intermediate, fractional point (`LatLon`) or `None`. `Vector` - Optional class to return the intermediate, fractional point (`Cartesian`, `Vector3d`) or `None`. `kwds` - Optional, additional `LatLon` or `Vector` keyword arguments, ignored if both `LatLon` and `Vector` are `None`. Returns: See function pygeodesy.fractional. Raises: `IndexError` - This fractional index invalid or `points` not subscriptable or not closed. `TypeError` - Invalid `LatLon`, `Vector` or `kwds` argument. See Also: Function pygeodesy.fractional.

Property Details

### fin Get the given `len`, the index `[n]` wrapped to `[0]` (`int`). Get method: fin(self) - Get the given `len`, the index `[n]` wrapped to `[0]` (`int`). Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.