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 (see the Ecef*.reverse methods) and optionally, the EcefMatrix M and datum, with lat and lon in degrees and x, y, z and height in meter, conventionally.

Instance Methods
 
toCartesian(self, Cartesian, **Cartesian_kwds)
Return the geocentric (x, y, z) coordinates as an ellipsoidal or spherical Cartesian.
 
toLatLon(self, LatLon=None, **LatLon_height_datum_kwds)
Return the geodetic (lat, lon, height[, datum]) coordinates.
 
toVector(self, Vector=None, **Vector_kwds)
Return the geocentric (x, y, z) coordinates as vector.

Inherited from named._NamedTuple: __delattr__, __getattr__, __getitem__, __repr__, __setattr__, __str__, items, iteritems, toStr, toStr2

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_, attrs, classof, copy

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
  lam
  latlon
  latlonheight
  latlonheightdatum
  phi
  philam
  philamheight
  philamheightdatum
  xyz
  xyzh

Inherited from named._Named: classname, classnaming, name, named, named2

Inherited from object: __class__

Method Details

toCartesian (self, Cartesian, **Cartesian_kwds)

 

Return the geocentric (x, y, z) coordinates as an ellipsoidal or spherical Cartesian.

Arguments:
Returns:
A Cartesian(x, y, z) instance.
Raises:
  • TypeError - Invalid Cartesian or Cartesian_kwds.

toLatLon (self, LatLon=None, **LatLon_height_datum_kwds)

 

Return the geodetic (lat, lon, height[, datum]) coordinates.

Arguments:
  • LatLon - Optional class to return (lat, lon, height[, datum]) or None.
  • LatLon_height_datum_kwds - Optional LatLon, height, datum and other keyword arguments.
Returns:
An instance of LatLon(lat, lon, **_height_datum_kwds) or if LatLon is None, a LatLon3Tuple(lat, lon, height) respectively LatLon4Tuple(lat, lon, height, datum) whether datum is un-/available.
Raises:
  • TypeError - Invalid LatLon or LatLon_height_datum_kwds.

toVector (self, Vector=None, **Vector_kwds)

 

Return the geocentric (x, y, z) coordinates as vector.

Arguments:
  • Vector - Optional vector class to return (x, y, z) or None.
  • Vector_kwds - Optional, additional Vector keyword arguments, ignored if Vector=None.
Returns:
A Vector(x, y, z, **Vector_kwds) instance or a Vector3Tuple(x, y, z) if Vector is None.

See Also: Propertes xyz and xyzh


Class Variable Details

_Names_

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

Property Details

lam

Get method:
lam(self) - Get the longitude in radians (float).
Set method:
immutable(inst, value) - Throws an AttributeError, always.

latlon

Get method:
latlon(self) - Get the lat-, longitude in degrees (LatLon2Tuple(lat, lon)).
Set method:
immutable(inst, value) - Throws an AttributeError, always.

latlonheight

Get method:
latlonheight(self) - Get the lat-, longitude in degrees and height (LatLon3Tuple(lat, lon, height)).
Set method:
immutable(inst, value) - Throws an AttributeError, always.

latlonheightdatum

Get method:
latlonheightdatum(self) - Get the lat-, longitude in degrees with height and datum (LatLon4Tuple(lat, lon, height, datum)).
Set method:
immutable(inst, value) - Throws an AttributeError, always.

phi

Get method:
phi(self) - Get the latitude in radians (float).
Set method:
immutable(inst, value) - Throws an AttributeError, always.

philam

Get method:
philam(self) - Get the lat-, longitude in radians (PhiLam2Tuple(phi, lam)).
Set method:
immutable(inst, value) - Throws an AttributeError, always.

philamheight

Get method:
philamheight(self) - Get the lat-, longitude in radians and height (PhiLam3Tuple(phi, lam, height)).
Set method:
immutable(inst, value) - Throws an AttributeError, always.

philamheightdatum

Get method:
philamheightdatum(self) - Get the lat-, longitude in radians with height and datum (PhiLam4Tuple(phi, lam, height, datum)).
Set method:
immutable(inst, value) - Throws an AttributeError, always.

xyz

Get method:
xyz(self) - Get the geocentric (x, y, z) coordinates (Vector3Tuple(x, y, z)).
Set method:
immutable(inst, value) - Throws an AttributeError, always.

xyzh

Get method:
xyzh(self) - Get the geocentric (x, y, z) coordinates and height (Vector4Tuple(x, y, z, h))
Set method:
immutable(inst, value) - Throws an AttributeError, always.