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

Class XyzLocal

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

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

Instance Methods
 
__init__(self, x_xyz, y=0, z=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, **name_Aer_kwds)
Get the local Azimuth, Elevation, slant Range components.
 
toCartesian(self, Cartesian=None, ltp=None, **name_Cartesian_kwds)
Get the geocentric (x, y, z) (ECEF) coordinates of this local.
 
toEnu(self, Enu=None, **name_Enu_kwds)
Get the local East, North, Up (ENU) components.
 
toLatLon(self, LatLon=None, ltp=None, **name_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, **name_Ned_kwds)
Get the local North, East, Down (Ned) components.
 
toXyz(self, Xyz=None, **name_Xyz_kwds)
Get the local X, Y, Z (XYZ) components.

Inherited from _Vector3d: toRepr, toStr

Inherited from vector3d.Vector3d: bearing, circin6, circum3, circum4_, iscolinearWith, meeus2, nearestOn, nearestOn6, parse, radii11, soddy4, trilaterate2d2, trilaterate3d2

Inherited from vector3dBase.Vector3dBase: __abs__, __add__, __bool__, __ceil__, __cmp__, __div__, __divmod__, __eq__, __float__, __floor__, __floordiv__, __format__, __ge__, __gt__, __hash__, __iadd__, __idiv__, __ifloordiv__, __imatmul__, __imod__, __imul__, __int__, __ipow__, __isub__, __itruediv__, __le__, __long__, __lt__, __matmul__, __mod__, __mul__, __ne__, __neg__, __nonzero__, __pos__, __pow__, __radd__, __rdiv__, __rdivmod__, __rfloordiv__, __rmatmul__, __rmod__, __rmul__, __round__, __rpow__, __rsub__, __rtruediv__, __sub__, __truediv__, __trunc__, angleTo, apply, bools, cmp, cross, dividedBy, dot, equals, equirectangular, fabs, floats, intermediateTo, ints, isconjugateTo, isequalTo, minus, minus_, negate, others, plus, plus_, rotate, rotateAround, sum, times, times_, to3xyz, unit

Inherited from named._NamedBase: __repr__

Inherited from named._Named: attrs, copy, dup, methodname, rename, renamed, toStr2

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

Properties
  aer4
  azimuth
  down
  ecef
  east
  elevation
  enu4
  groundrange
  ltp
  ned4
  north
  slantrange
  up
  xyz4
  xyzLocal

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

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

Inherited from object: __class__

Method Details

__init__ (self, x_xyz, y=0, z=0, ltp=None, **name)
(Constructor)

 

New XyzLocal.

Arguments:
  • x_xyz - Scalar X component (meter), positive east or a previous local instance (XyzLocal, Xyz4Tuple, Aer, Aer4Tuple, Enu, Enu4Tuple, Local9Tuple, Ned or Ned4Tuple).
  • y - Scalar Y component (meter), only used with scalar x_xyz, positive north.
  • z - Scalar Z component, normal positive up from the surface of the ellipsoid or sphere (meter), only used with scalar x_xyz.
  • ltp - The local tangent plane, (geodetic) origin (Ltp, LocalCartesian).
  • name - Optional name=NN (str).
Raises:
  • TypeError - Invalid x_xyz or ltp.
  • UnitError - Invalid scalar x_xyz, 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, **name_Aer_kwds)

 

Get the local Azimuth, Elevation, slant Range components.

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

toCartesian (self, Cartesian=None, ltp=None, **name_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.
  • name_Cartesian_kwds - Optional name=NN (str) and optional, additional Cartesian keyword arguments, ignored if Cartesian is None.
Returns:
A Cartesian instance of if Cartesian is None, an Ecef9Tuple(x, y, z, lat, lon, height, C, M, datum) with M=None, always.
Raises:
  • TypeError - Invalid ltp, Cartesian or name_Cartesian_kwds.

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

 

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

Arguments:
  • Enu - Class to return ENU (Enu) or None.
  • name_Enu_kwds - Optional name=NN (str) and optional, additional Enu keyword arguments, ignored if Enu is None.
Returns:
ENU as an Enu instance or if Enu is None, an Enu4Tuple(east, north, up, ltp).
Raises:
  • TypeError - Invalid Enu or name_Enu_kwds.

toLatLon (self, LatLon=None, ltp=None, **name_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.
  • name_LatLon_kwds - Optional name=NN (str) and optional, additional LatLon keyword arguments, ignored if LatLon is None.
Returns:
An LatLon instance of if LatLon is None, an Ecef9Tuple(x, y, z, lat, lon, height, C, M, datum) with M=None, always.
Raises:
  • TypeError - Invalid LatLon, ltp or name_LatLon_kwds.

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

 

Get this local as a Local9Tuple.

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

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

 

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

Arguments:
  • Ned - Class to return NED (Ned) or None.
  • name_Ned_kwds - Optional name=NN (str) and optional, additional Ned keyword arguments, ignored if Ned is None.
Returns:
NED as an Ned instance or if Ned is None, an Ned4Tuple(north, east, down, ltp).
Raises:
  • TypeError - Invalid Ned or name_Ned_kwds.

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

 

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

Arguments:
  • Xyz - Class to return XYZ (XyzLocal, Enu, Ned, Aer) or None.
  • name_Xyz_kwds - Optional name=NN (str) and optional, additional Xyz keyword arguments, ignored if Xyz is None.
Returns:
XYZ as an Xyz instance or if Xyz is None, an Xyz4Tuple(x, y, z, ltp).
Raises:
  • TypeError - Invalid Xyz or name_EXyz_kwds.

Property Details

aer4

Get method:
_fget(inst) - Get and cache/memoize the property value.
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

azimuth

Get method:
_fget(inst) - Get and cache/memoize the property value.
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

down

Get method:
_fget(inst) - Get and cache/memoize the property value.
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

ecef

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 method:
_fget(inst) - Get and cache/memoize the property value.
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

elevation

Get method:
_fget(inst) - Get and cache/memoize the property value.
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

enu4

Get method:
_fget(inst) - Get and cache/memoize the property value.
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

groundrange

Get method:
_fget(inst) - Get and cache/memoize the property value.
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

ltp

Get method:
_fget(inst) - Get and cache/memoize the property value.
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

ned4

Get method:
_fget(inst) - Get and cache/memoize the property value.
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

north

Get method:
_fget(inst) - Get and cache/memoize the property value.
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

slantrange

Get method:
_fget(inst) - Get and cache/memoize the property value.
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

up

Get method:
_fget(inst) - Get and cache/memoize the property value.
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

xyz4

Get method:
_fget(inst) - Get and cache/memoize the property value.
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

xyzLocal

Get method:
_fget(inst) - Get and cache/memoize the property value.
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

   Home       Trees       Indices       Help   
PyGeodesy
Generated by Epydoc 3.0.1 on Tue Oct 22 17:06:21 2024 http://epydoc.sourceforge.net