Package pygeodesy :: Module ltpTuples :: Class Local6Tuple
[frames] | no frames]

Class Local6Tuple

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

6-Tuple (x, y, z, ltp, ecef, M) with local x, y and z all in meter, local tangent plane ltp (Ltp), ecef (Ecef9Tuple) with both the geocentric and geodectic coordinates and optionally, the concatenated rotation matrix M (EcefMatrix).

Instance Methods
 
toAer(self, Aer=None, **Aer_kwds)
Get the local Azimuth, Elevation, slant Range (AER) components.
 
toCartesian(self, Cartesian=None, **Cartesian_kwds)
Convert this local to geocentric (x, y, z) (ECEF).
 
toEnu(self, Enu=None, **Enu_kwds)
Get the local East, North, Up (ENU) components.
 
toLatLon(self, LatLon=None, **LatLon_kwds)
Convert this local to geodetic (lat, lon, height).
 
toNed(self, Ned=None, **Ned_kwds)
Get the local North, East, Down (NED) components.
 
toXyz(self, Xyz=None, **Xyz_kwds)
Get the local X, Y, Z (XYZ) components.

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', 'ltp', 'ecef', 'M')
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
  azimuth
Get the local Azimuth, bearing from North (degrees360).
  down
Get the local Down, -z component (meter).
  east
Get the local East, x component (meter).
  elevation
Get the local Elevation, tilt above horizon (degrees90).
  groundrange
Get the local ground range, distance (meter).
  north
Get the local North, y component (meter).
  slantrange
Get the local slant Range, distance (meter).
  up
Get the local Up, z component (meter).
  xyz
Get the local (X, Y, Z) components (Vector3Tuple(x, y, z)).
  xyzLocal
Get this Local6Tuple as an XyzLocal.

Inherited from named._NamedTuple: iteration

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

Inherited from object: __class__

Method Details

toAer (self, Aer=None, **Aer_kwds)

 

Get the local Azimuth, Elevation, slant Range (AER) components.

Arguments:
  • Aer - Class to return AER (Aer) or None.
  • Aer_kwds - Optional, additional Aer keyword arguments, ignored if Aer is None.
Returns:
AER as an Aer instance or if Aer=None, an Aer4Tuple(azimuth, elevation, slantrange, ltp).

toCartesian (self, Cartesian=None, **Cartesian_kwds)

 

Convert this local to geocentric (x, y, z) (ECEF).

Arguments:
  • Cartesian - Optional class to return (x, y, z) (Cartesian) or None.
  • Cartesian_kwds - Optional, additional Cartesian keyword arguments, ignored if Cartesian=None.
Returns:
A Cartesian instance of if Cartesian=None, an Ecef9Tuple(x, y, z, lat, lon, height, C, M, datum) with M=None, always.

toEnu (self, Enu=None, **Enu_kwds)

 

Get the local East, North, Up (ENU) components.

Arguments:
  • Enu - Class to return ENU (Enu) or None.
  • Enu_kwds - Optional, additional Enu keyword arguments, ignored if Enu is None.
Returns:
ENU as an Enu instance or if Enu=None, an Enu4Tuple(east, north, up, ltp).

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

 

Convert this local to geodetic (lat, lon, height).

Arguments:
  • LatLon - Optional class to return (lat, lon, height) (LatLon) or None.
  • LatLon_kwds - Optional, additional LatLon keyword arguments, ignored if LatLon=None.
Returns:
An LatLon instance of if LatLon=None, an Ecef9Tuple(x, y, z, lat, lon, height, C, M, datum) with M=None, always.

toNed (self, Ned=None, **Ned_kwds)

 

Get the local North, East, Down (NED) components.

Arguments:
  • Ned - Class to return NED (Ned) or None.
  • Ned_kwds - Optional, additional Ned keyword arguments, ignored if Ned is None.
Returns:
NED as an Ned instance or if Ned=None, an Ned4Tuple(north, east, down, ltp).

toXyz (self, Xyz=None, **Xyz_kwds)

 

Get the local X, Y, Z (XYZ) components.

Arguments:
  • Xyz - Class to return XYZ (XyzLocal) or None.
  • Xyz_kwds - Optional, additional Xyz keyword arguments, ignored if Xyz=None.
Returns:
XYZ as an Xyz instance or if Xyz=None, an Xyz4Tuple(x, y, z, ltp).

Class Variable Details

_Names_

Tuple specifying the name of each Named-Tuple item.

Note: Specify at least 2 item names.

Value:
('x', 'y', 'z', 'ltp', 'ecef', 'M')

_Units_

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

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

Value:
Meter, Meter, Meter, _Pass, _Pass, _Pass

Property Details

azimuth

Get the local Azimuth, bearing from North (degrees360).

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

down

Get the local Down, -z component (meter).

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

east

Get the local East, x component (meter).

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

elevation

Get the local Elevation, tilt above horizon (degrees90).

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

groundrange

Get the local ground range, distance (meter).

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

north

Get the local North, y component (meter).

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

slantrange

Get the local slant Range, distance (meter).

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

up

Get the local Up, z component (meter).

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

xyz

Get the local (X, Y, Z) components (Vector3Tuple(x, y, z)).

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

xyzLocal

Get this Local6Tuple as an XyzLocal.

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