Package pygeodesy :: Module namedTuples :: Class Vector2Tuple

Class Vector2Tuple

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

2-Tuple (x, y) of (geocentric) components, each in meter or the same units.

Instance Methods

to3Tuple(self, z=0, **name)
Extend this Vector2Tuple to a Vector3Tuple.

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

Inherited from named._Named: classname, classnaming, iteration, name, named, named2, named3, named4, sizeof

Inherited from object: __class__

Method Details

to3Tuple (self, z=0, **name)

Extend this Vector2Tuple to a Vector3Tuple.

Arguments:

z - The Z component add (scalar).
name - Optional name (str), overriding this name.

Returns:

A Vector3Tuple(x, y, z).

Raises:

ValueError - Invalid z.