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

# Class Vector3Tuple

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

3-Tuple `(x, y, z)` of (geocentric) components, all in `meter` or the same `units`.

Instance Methods
to4Tuple(self, h=0, **name) Extend this Vector3Tuple to a Vector4Tuple. |
Inherited from `named._NamedTuple`: `__delattr__`, `__getattr__`, `__hash__`, `__repr__`, `__setattr__`, `__str__`, `dup`, `items`, `iteritems`, `iterunits`, `toRepr`, `toStr`, `toUnits`, `units` Inherited from `tuple`: `__add__`, `__contains__`, `__eq__`, `__ge__`, `__getattribute__`, `__getitem__`, `__getnewargs__`, `__getslice__`, `__gt__`, `__iter__`, `__le__`, `__len__`, `__lt__`, `__mul__`, `__ne__`, `__rmul__`, `count`, `index` Inherited from `named._Named`: `__imatmul__`, `__matmul__`, `__rmatmul__`, `attrs`, `classof`, `copy`, `methodname`, `rename`, `toStr2` Inherited from `object`: `__format__`, `__init__`, `__reduce__`, `__reduce_ex__`, `__sizeof__`, `__subclasshook__`

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

Properties
| xyz Get X, Y and Z components (`Vector3Tuple`).
Inherited from `named._Named`: `classname`, `classnaming`, `iteration`, `name`, `named`, `named2`, `named3`, `named4`, `sizeof` Inherited from `object`: `__class__`

Method Details

### to4Tuple (self, h=0, **name) |
Extend this Vector3Tuple to a Vector4Tuple. Arguments: `h` - The height to add (`scalar`). `name` - Optional name (`str`), overriding this name. Returns: A Vector4Tuple`(x, y, z, h)`. Raises: `ValueError` - Invalid `h`.

Property Details

### xyz Get X, Y and Z components (`Vector3Tuple`). Get method: xyz(self) - Get X, Y and Z components (`Vector3Tuple`). Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.