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, **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
An immutable property (Read Only).
  latlon
An immutable property (Read Only).
  latlonheight
An immutable property (Read Only).
  latlonheightdatum
An immutable property (Read Only).
  phi
An immutable property (Read Only).
  philam
An immutable property (Read Only).
  philamheight
An immutable property (Read Only).
  philamheightdatum
An immutable property (Read Only).
  xyz
An immutable property (Read Only).
  xyzh
An immutable property (Read Only).

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:
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, **kwds)

 

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

Parameters:
  • Vector - Optional vector (sub-)class to return (x, y, z) or None.
  • kwds - Optional, additional Vector keyword arguments, ignored if Vector=None.
Returns:
A Vector(x, y, z, **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

An immutable property (Read Only).

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

latlon

An immutable property (Read Only).

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

latlonheight

An immutable property (Read Only).

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

latlonheightdatum

An immutable property (Read Only).

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

phi

An immutable property (Read Only).

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

philam

An immutable property (Read Only).

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

philamheight

An immutable property (Read Only).

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

philamheightdatum

An immutable property (Read Only).

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

xyz

An immutable property (Read Only).

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

An immutable property (Read Only).

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.