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

Class XyzLocal

       object --+                
                |                
     named._Named --+            
                    |            
     named._NamedBase --+        
                        |        
vector3dBase.Vector3dBase --+    
                            |    
            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.
 
toLocal9Tuple(self, M=False, name='')
Get this local as a Local9Tuple.
 
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/XYZ.
 
toXyz(self, Xyz=None, **Xyz_kwds)
Get the local X, Y, Z (XYZ) components.

Inherited from vector3d.Vector3d: iscolinearWith, nearestOn, parse, trilaterate3d2

Inherited from vector3dBase.Vector3dBase: __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, isequalTo, minus, negate, others, plus, rotate, rotateAround, sum, times, to2ab, to2ll, to3xyz, 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).
  xyz4
Get the (x, y, z, ltp) components (Xyz4Tuple).
  xyzLocal
Get this XyzLocal.

Inherited from vector3dBase.Vector3dBase: crosserrors, euclid, length, length2, x, xyz, y, z

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, Local9Tuple).
  • 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 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).

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

 

Get the geodetic (lat, lon, height) coordinates if this local.

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

toLocal9Tuple (self, M=False, name='')

 

Get this local as a Local9Tuple.

Arguments:
  • M - Optionally include the rotation matrix (bool).
  • name - Optional name (str).
Returns:
Local9Tuple(x, y, z, lat, lon, height, ltp, ecef, M) with ltp this Ltp, ecef an Ecef9Tuple and M EcefMatrix or None.

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=None.
Returns:
NED as an Ned instance or if Ned=None, an Ned4Tuple(north, east, down, ltp).

toRepr (self, prec=None, fmt='[%s]', sep=', ', **unused)

 

Return a string representation of this ENU/NED/XYZ.

Arguments:
  • prec - Optional number of decimals, unstripped (int).
  • fmt - Optional enclosing backets format (str).
  • sep - Optional separator between items (str).
Returns:
This XYZ/ENU as "[E:meter, N:meter, U:meter]", "[N:meter, E:meter, D:meter]" respectively "[X:meter, Y:meter, Z:meter]" (str).
Overrides: named._Named.toRepr

toStr (self, prec=3, fmt='[%s]', sep=', ')

 

Return a string representation of this ENU/XYZ.

Arguments:
  • prec - Optional number of decimals, unstripped (int).
  • fmt - Optional enclosing backets format (str).
  • sep - Optional separator between items (str).
Returns:
This XYZ/ENU as "[meter, meter, meter]" (str).
Overrides: named._Named.toStr

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

 

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

Arguments:
  • Xyz - Class to return XYZ (XyzLocal, Enu, Ned, Aer) 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).

Property Details

aer4

Get the (azimuth, elevation, slantrange, ltp) components (Aer4Tuple).

Get method:
aer4(self) - Get the (azimuth, elevation, slantrange, ltp) components (Aer4Tuple).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

azimuth

Get the Azimuth, bearing from North (degrees360).

Get method:
azimuth(self) - Get the 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.

See Also: Azimuth.

down

Get the Down component (meter).

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

ecef

Get this LTP's ECEF converter (Ecef... instance).

Get method:
ecef(self) - Get this LTP's ECEF converter (Ecef... instance).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

east

Get the East component (meter).

Get method:
east(self) - Get the East 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 Elevation, tilt above horizon (degrees90).

Get method:
elevation(self) - Get the 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.

See Also: Elevation.

enu4

Get the (east, north, up, ltp) components (Enu4Tuple).

Get method:
enu4(self) - Get the (east, north, up, ltp) components (Enu4Tuple).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

groundrange

Get the ground range, distance (meter).

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

ltp

Get the local tangent plane (Ltp).

Get method:
ltp(self) - Get the local tangent plane (Ltp).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

ned4

Get the (north, east, down, ltp) components (Ned4Tuple).

Get method:
ned4(self) - Get the (north, east, down, ltp) components (Ned4Tuple).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

north

Get the North component (meter).

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

slantrange

Get the slant Range, distance (meter).

Get method:
slantrange(self) - Get the 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 Up component (meter).

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

xyz4

Get the (x, y, z, ltp) components (Xyz4Tuple).

Get method:
xyz4(self) - Get the (x, y, z, ltp) components (Xyz4Tuple).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

xyzLocal

Get this XyzLocal.

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