Package pygeodesy :: Module ecef :: Class Ecef9Tuple |
[frames] | no frames]

# Class Ecef9Tuple

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

9-Tuple `(x, y, z, lat, lon, height, C, M, datum)` with geocentric coordinates `x`, `y` and `z`, geodetic coordinates `lat`, `lon` and `height`, case `C` and optionally, the EcefMatrix `M` and `datum`, with `lat` and `lon` in `degrees` and `x`, `y`, `z` and `height` in `meter`, usually.

Instance Methods
toCartesian(self, Cartesian) Return the geocentric `(x, y, z)` coordinates as an ellipsoidal or spherical `Cartesian`. |
toLatLon(self, LatLon=None) Return the geodetic `(lat, lon, height[, datum])` coordinates. |
toVector(self, Vector=None) Return the geocentric `(x, y, z)` coordinates as vector. |
Inherited from `named._NamedTuple`: `__delattr__`, `__getattr__`, `__getitem__`, `__repr__`, `__setattr__`, `__str__`, `items`, `iteritems` 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`: `classof`, `copy`, `toStr`, `toStr2` Inherited from `object`: `__format__`, `__init__`, `__reduce__`, `__reduce_ex__`, `__sizeof__`, `__subclasshook__`

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

Class Variables
| _Names_ = ``(``'``x``'``,` `'``y``'``,` `'``z``'``,` `'``lat``'``,` `'``lon``'``,` `'``height``'``,` `'``C``'``,` `'``M``'``,` `'``d``...``

Properties
Inherited from `named._Named`: `classname`, `classnaming`, `name`, `named`, `named2` Inherited from `object`: `__class__`

Method Details

### toCartesian(self, Cartesian) |
Return the geocentric `(x, y, z)` coordinates as an ellipsoidal or spherical `Cartesian`. Parameters: `Cartesian` - ellipsoidalKarney.Cartesian, ellipsoidalNvector.Cartesian, ellipsoidalVincenty.Cartesian, sphericalNvector.Cartesian or sphericalTrigonometry.Cartesian (sub-)class to return `(x, y, z)`. Returns: A `Cartesian``(x, y, z)` instance. Raises: `TypeError` - Invalid `Cartesian`.

### toLatLon(self, LatLon=None) |
Return the geodetic `(lat, lon, height[, datum])` coordinates. Parameters: `LatLon` - Optional (sub-)class to return `(lat, lon, height[, datum])` or `None`. Returns: An instance of `LatLon``(lat, lon, height[, datum])` if `LatLon` is not `None` or a LatLon3Tuple`(lat, lon, height)` or a LatLon4Tuple`(lat, lon, height, datum)` if `datum` is unavailable respectively available.

### toVector(self, Vector=None) |
Return the geocentric `(x, y, z)` coordinates as vector. Parameters: `Vector` - Optional vector (sub-)class to return `(x, y, z)` or `None`. Returns: A `Vector``(x, y, z)` instance or if `Vector` is `None` a Vector3Tuple`(x, y, z)`.

Class Variable Details

  ### _Names_ Value:
      ('x', 'y', 'z', 'lat', 'lon', 'height', 'C', 'M', 'datum')