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

Class Local9Tuple

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

9-Tuple (x, y, z, lat, lon, height, ltp, ecef, M) with local x, y, z all in meter, geodetic lat, lon, height, local tangent plane ltp (Ltp), ecef (Ecef9Tuple) with geocentric x, y, z, geodetic lat, lon, height and concatenated rotation matrix M (EcefMatrix) or None.

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', 'lat', 'lon', 'height', 'ltp', 'ecef...
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).
  lam
Get the geodetic longitude in radians (float).
  latlon
Get the geodetic lat-, longitude in degrees (LatLon2Tuple(lat, lon)).
  latlonheight
Get the geodetic lat-, longitude in degrees and height (LatLon3Tuple(lat, lon, height)).
  north
Get the local North, y component (meter).
  phi
Get the geodetic latitude in radians (float).
  philam
Get the geodetic lat-, longitude in radians (PhiLam2Tuple(phi, lam)).
  philamheight
Get the geodetic lat-, longitude in radians and height (PhiLam3Tuple(phi, lam, height)).
  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 Local9Tuple 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(x, y, z, **Cartesian_kwds) instance or a Vector4Tuple(x, y, z, h) if Cartesian=None.
Raises:
  • TypeError - Invalid Cartesian or Cartesian_kwds.

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=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 instance of LatLon(lat, lon, **LatLon_kwds) or if LatLon=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.

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', 'lat', 'lon', 'height', '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, Lat, Lon, Height, _Pass, _Pass, _Pass

Property Details

azimuth

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

Get method:
azimuth(self) - Get the local Azimuth, bearing from North (degrees360).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

down

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

Get method:
down(self) - Get the local Down, -z component (meter).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

east

Get the local East, x component (meter).

Get method:
east(self) - Get the local East, x component (meter).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

elevation

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

Get method:
elevation(self) - Get the local Elevation, tilt above horizon (degrees90).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

groundrange

Get the local ground range, distance (meter).

Get method:
groundrange(self) - Get the local ground range, distance (meter).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

lam

Get the geodetic longitude in radians (float).

Get method:
lam(self) - Get the geodetic longitude in radians (float).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

latlon

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

Get method:
latlon(self) - Get the geodetic lat-, longitude in degrees (LatLon2Tuple(lat, lon)).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

latlonheight

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

Get method:
latlonheight(self) - Get the geodetic lat-, longitude in degrees and height (LatLon3Tuple(lat, lon, height)).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

north

Get the local North, y component (meter).

Get method:
north(self) - Get the local North, y component (meter).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

phi

Get the geodetic latitude in radians (float).

Get method:
phi(self) - Get the geodetic latitude in radians (float).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

philam

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

Get method:
philam(self) - Get the geodetic lat-, longitude in radians (PhiLam2Tuple(phi, lam)).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

philamheight

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

Get method:
philamheight(self) - Get the geodetic lat-, longitude in radians and height (PhiLam3Tuple(phi, lam, height)).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

slantrange

Get the local slant Range, distance (meter).

Get method:
slantrange(self) - Get the local slant Range, distance (meter).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

up

Get the local Up, z component (meter).

Get method:
up(self) - Get the local Up, z component (meter).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

xyz

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

Get method:
xyz(self) - Get the local (X, Y, Z) components (Vector3Tuple(x, y, z)).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

xyzLocal

Get this Local9Tuple as an XyzLocal.

Get method:
xyzLocal(self) - Get this Local9Tuple as an XyzLocal.
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.