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.
 
toDatum(self, datum2)
Convert this Ecef9Tuple to an other datum.
 
convertDatum(self, datum2)
Convert this Ecef9Tuple to an other datum.
 
toLatLon(self, LatLon=None, **LatLon_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, iterunits, toRepr, toStr, toUnits, units

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, rename, 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...
Tuple specifying the name of each Named-Tuple item.
  _Units_ = (<class 'pygeodesy.units.Meter'>, <class 'pygeodesy....
Tuple defining the units of the value of each Named-Tuple item.
Properties
  lam
Get the longitude in radians (float).
  lamVermeille
Get the longitude in radians [-PI*3/2..+PI*3/2] after Vermeille (2004), p 95.
  latlon
Get the lat-, longitude in degrees (LatLon2Tuple(lat, lon)).
  latlonheight
Get the lat-, longitude in degrees and height (LatLon3Tuple(lat, lon, height)).
  latlonheightdatum
Get the lat-, longitude in degrees with height and datum (LatLon4Tuple(lat, lon, height, datum)).
  latlonVermeille
Get the latitude and Vermeille longitude in degrees [-225..+225] (LatLon2Tuple(lat, lon)).
  lonVermeille
Get the longitude in degrees [-225..+225] after Vermeille (2004), p 95.
  phi
Get the latitude in radians (float).
  philam
Get the lat-, longitude in radians (PhiLam2Tuple(phi, lam)).
  philamheight
Get the lat-, longitude in radians and height (PhiLam3Tuple(phi, lam, height)).
  philamheightdatum
Get the lat-, longitude in radians with height and datum (PhiLam4Tuple(phi, lam, height, datum)).
  philamVermeille
Get the latitude and Vermeille longitude in radians [-PI*3/2..+PI*3/2] (PhiLam2Tuple(phi, lam)).
  xyz
Get the geocentric (x, y, z) coordinates (Vector3Tuple(x, y, z)).
  xyzh
Get the geocentric (x, y, z) coordinates and height (Vector4Tuple(x, y, z, h))

Inherited from named._NamedTuple: iteration

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

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.

toDatum (self, datum2)

 

Convert this Ecef9Tuple to an other datum.

Arguments:
  • datum2 - Datum to convert to (Datum).
Returns:
The converted 9-Tuple (Ecef9Tuple).
Raises:
  • TypeError - The datum2 is not a Datum.

convertDatum (self, datum2)

 

Convert this Ecef9Tuple to an other datum.

Arguments:
  • datum2 - Datum to convert to (Datum).
Returns:
The converted 9-Tuple (Ecef9Tuple).
Raises:
  • TypeError - The datum2 is not a Datum.

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

 

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

Arguments:
  • LatLon - Optional class to return (lat, lon, height[, datum]) or None.
  • LatLon_kwds - Optional height, datum and other LatLon keyword arguments.
Returns:
An instance of LatLon(lat, lon, **LatLon_kwds) or if LatLon is None, a LatLon3Tuple(lat, lon, height) respectively LatLon4Tuple(lat, lon, height, datum) depending on whether datum is un-/specified.
Raises:
  • TypeError - Invalid LatLon or LatLon_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_

Tuple specifying the name of each Named-Tuple item.

Note: Specify at least 2 item names.

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

_Units_

Tuple defining the units of the value of each Named-Tuple item.

Note: The len(_Units_) must match len(_Names_).

Value:
(<class 'pygeodesy.units.Meter'>,
 <class 'pygeodesy.units.Meter'>,
 <class 'pygeodesy.units.Meter'>,
 <class 'pygeodesy.units.Lat'>,
 <class 'pygeodesy.units.Lon'>,
 <class 'pygeodesy.units.Height'>,
 <class 'pygeodesy.units.Int'>,
 <function _Pass at 0x7fa782b26a50>,
...

Property Details

lam

Get the longitude in radians (float).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

lamVermeille

Get the longitude in radians [-PI*3/2..+PI*3/2] after Vermeille (2004), p 95.

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

See Also: Karney, Vermeille 2011, pp 112-113, 116 and Featherstone, et.al., p 7.

latlon

Get the lat-, longitude in degrees (LatLon2Tuple(lat, lon)).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

latlonheight

Get the lat-, longitude in degrees and height (LatLon3Tuple(lat, lon, height)).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

latlonheightdatum

Get the lat-, longitude in degrees with height and datum (LatLon4Tuple(lat, lon, height, datum)).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

latlonVermeille

Get the latitude and Vermeille longitude in degrees [-225..+225] (LatLon2Tuple(lat, lon)).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

See Also: Property lonVermeille.

lonVermeille

Get the longitude in degrees [-225..+225] after Vermeille (2004), p 95.

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

See Also: Property lamVermeille.

phi

Get the latitude in radians (float).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

philam

Get the lat-, longitude in radians (PhiLam2Tuple(phi, lam)).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

philamheight

Get the lat-, longitude in radians and height (PhiLam3Tuple(phi, lam, height)).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

philamheightdatum

Get the lat-, longitude in radians with height and datum (PhiLam4Tuple(phi, lam, height, datum)).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

philamVermeille

Get the latitude and Vermeille longitude in radians [-PI*3/2..+PI*3/2] (PhiLam2Tuple(phi, lam)).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

See Also: Property lamVermeille.

xyz

Get the geocentric (x, y, z) coordinates (Vector3Tuple(x, y, z)).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

xyzh

Get the geocentric (x, y, z) coordinates and height (Vector4Tuple(x, y, z, h))

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)