Package pygeodesy :: Module namedTuples :: Class PhiLam2Tuple |
[frames] | no frames]

# Class PhiLam2Tuple

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

2-Tuple `(phi, lam)` with latitude `phi` in `radians[PI_2]` and longitude `lam` in `radians[PI]`.

Note: Using `phi/lambda` for lat-/longitude in `radians` follows Chris Veness' convention.

Instance Methods
to3Tuple(self, height) Extend this PhiLam2Tuple to a PhiLam3Tuple. |
to4Tuple(self, height, datum) Extend this PhiLam2Tuple to a PhiLam4Tuple. |
Inherited from `named._NamedTuple`: `__delattr__`, `__getattr__`, `__getitem__`, `__repr__`, `__setattr__`, `__str__`, `dup`, `items`, `iteritems`, `iterunits`, `toRepr`, `toStr`, `toUnits`, `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_`, `__imatmul__`, `__matmul__`, `__rmatmul__`, `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_ = ``(``'``phi``'``,` `'``lam``'``)`` Tuple specifying the `name` of each `Named-Tuple` item.
| _Units_ = ``(`<class 'pygeodesy.units.Phi'>`,` <class 'pygeodesy.un`...`` 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

### to3Tuple (self, height) |
Extend this PhiLam2Tuple to a PhiLam3Tuple. Arguments: `height` - The height to add (`scalar`). Returns: A PhiLam3Tuple`(phi, lam, height)`. Raises: `ValueError` - Invalid `height`.

### to4Tuple (self, height, datum) |
Extend this PhiLam2Tuple to a PhiLam4Tuple. Arguments: `height` - The height to add (`scalar`). `datum` - The datum to add (`Datum`). Returns: A PhiLam4Tuple`(phi, lam, height, datum)`. Raises: `TypeError` - If `datum` not a `Datum`. `ValueError` - Invalid `height`.

Class Variable Details

  ### _Names_ Tuple specifying the `name` of each `Named-Tuple` item. Note: Specify at least 2 item names. Value:
      ('phi', 'lam')

  ### _Units_ Tuple defining the `units` of the value of each `Named-Tuple` item. Note: The `len(_Units_)` must match `len(_Names_)`. Value:
      (<class 'pygeodesy.units.Phi'>, <class 'pygeodesy.units.Lam'>)