pygeodesy :: namedTuples :: Vector2Tuple :: 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.

toCartesian(self, Cartesian, **Cartesian_kwds)
Return this Vector2Tuple as a Cartesian.

Inherited from named._NamedTuple: __delattr__, __getattr__, __hash__, __repr__, __setattr__, __str__, dup, items, iteritems, iterunits, reUnit, 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: __format__, __imatmul__, __matmul__, __rmatmul__, attrs, classof, copy, methodname, rename, renamed, toStr2

Inherited from object: __init__, __reduce__, __reduce_ex__, __sizeof__, __subclasshook__

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

Properties
	xyz
	xyz3
Inherited from `named._Named`: `classname`, `classnaming`, `iteration`, `name`, `named`, `named2`, `named3`, `named4`, `sizeof`, `typename` Inherited from `object`: `__class__`

Method Details

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

Extend this Vector2Tuple to a Vector3Tuple.

Parameters:

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

Returns:

A Vector3Tuple(x, y, z).

Raises:

ValueError - Invalid z.

toCartesian(self, Cartesian, **Cartesian_kwds)

Return this Vector2Tuple as a Cartesian.

Parameters:

Cartesian - The Cartesian class to use.
Cartesian_kwds - Optional, additional Cartesian keyword arguments.

Returns:

The Cartesian instance with z=0.

Property Details

xyz

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

xyz3

Get Method:: unreachable.xyz3(self) - Get X, Y and Z=0 components as 3-tuple.
Set Method:: unreachable._fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:: unreachable._fdel(inst) - Zap the cached/memoized property value.