Home       Trees       Indices       Help   
PyGeodesy
Package pygeodesy :: Module ltpTuples :: Class XyzLocal
[frames] | no frames]

Class XyzLocal

  object --+            
           |            
named._Named --+        
               |        
named._NamedBase --+    
                   |    
   vector3d.Vector3d --+
                       |
                      XyzLocal
Known Subclasses:

Local (x, y, z) in a local tangent plane (LTP) and base class for local Enu, Ned and Aer.

Instance Methods
 
__init__(self, xyz, y=0.0, z=0.0, ltp=None, name='')
New XyzLocal.
 
__str__(self)
Default str(self).
 
classof(self, *args, **kwds)
Create another instance of this very class.
 
toAer(self, Aer=None, **Aer_kwds)
Get the local Azimuth, Elevation, slantRange components.
 
toCartesian(self, Cartesian=None, ltp=None, **Cartesian_kwds)
Get the geocentric (x, y, z) (ECEF) coordinates of this local.
 
toEnu(self, Enu=None, **Enu_kwds)
Get the local East, North, Up (ENU) components.
 
toLatLon(self, LatLon=None, ltp=None, **LatLon_kwds)
Get the geodetic (lat, lon, height) coordinates if this local.
 
toLocal6Tuple(self, M=None, name='')
Get this local as a Local6Tuple.
 
toNed(self, Ned=None, **Ned_kwds)
Get the local North, East, Down (Ned) components.
 
toRepr(self, prec=None, fmt='[%s]', sep=', ', **unused)
Return a string representation of this ENU/NED/XYZ.
 
toStr(self, prec=3, fmt='[%s]', sep=', ')
Return a string representation of this ENU/NED/XYZ.
 
toXyz(self, Xyz=None, **Xyz_kwds)
Get the local X, Y, Z (XYZ) components.

Inherited from vector3d.Vector3d: __abs__, __add__, __cmp__, __div__, __eq__, __ge__, __gt__, __le__, __lt__, __matmul__, __mul__, __ne__, __neg__, __pos__, __radd__, __rmatmul__, __rsub__, __sub__, __truediv__, angleTo, cmp, cross, dividedBy, dot, equals, iscolinearWith, isequalTo, minus, nearestOn, negate, others, parse, plus, rotate, rotateAround, sum, times, to2ab, to2ll, to3xyz, trilaterate3d2, unit

Inherited from named._NamedBase: __repr__

Inherited from named._Named: _DOT_, attrs, copy, rename, toStr2

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Properties
  aer4
Get the (azimuth, elevation, slantrange, ltp) components (Aer4Tuple).
  azimuth
Get the Azimuth, bearing from North (degrees360).
  down
Get the Down component (meter).
  ecef
Get this LTP's ECEF converter (Ecef... instance).
  east
Get the East component (meter).
  elevation
Get the Elevation, tilt above horizon (degrees90).
  enu4
Get the (east, north, up, ltp) components (Enu4Tuple).
  groundrange
Get the ground range, distance (meter).
  ltp
Get the local tangent plane (Ltp).
  ned4
Get the (north, east, down, ltp) components (Ned4Tuple).
  north
Get the North component (meter).
  slantrange
Get the slant Range, distance (meter).
  up
Get the Up component (meter).
  x
Get the X component (meter).
  xyz4
Get the (x, y, z, ltp) components (Xyz4Tuple).
  xyzLocal
Get this XyzLocal.
  y
Get the Y component (meter).
  z
Get the Z component (meter).

Inherited from vector3d.Vector3d: crosserrors, euclid, length, length2, xyz

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

Inherited from object: __class__

Method Details

__init__ (self, xyz, y=0.0, z=0.0, ltp=None, name='')
(Constructor)

 

New XyzLocal.

Arguments:
  • xyz - Scalar X component (meter), east or a local (XyzLocal, Xyz4Tuple, Enu, Enu4Tuple, Local6Tuple).
  • y - Scalar Y component (meter) if scalar xyz, north.
  • z - Scalar Z component if scalar xyz, normal up from the surface of the ellipsoid or sphere (meter).
  • ltp - The local tangent plane, (geodetic) origin (Ltp, LocalCartesian).
Raises:
  • TypeError - Invalid xyz, ltp.
  • UnitError - Invalid x, y or z.
Overrides: object.__init__

__str__ (self)
(Informal representation operator)

 

Default str(self).

Overrides: object.__str__
(inherited documentation)

classof (self, *args, **kwds)

 

Create another instance of this very class.

Arguments:
  • args - Optional, positional arguments.
  • kwds - Optional, keyword arguments.
Returns:
New instance (self.__class__).
Overrides: named._Named.classof

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

 

Get the local Azimuth, Elevation, slantRange components.

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

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

 

Get the geocentric (x, y, z) (ECEF) coordinates of this local.

Arguments:
  • Cartesian - Optional class to return (x, y, z) (Cartesian) or None.
  • ltp - Optional local tangent plane (LTP) (Ltp), overriding this ENU/NED/AER/XYZ's LTP.
  • 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.
Raises:
  • TypeError - Invalid ltp.

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).