Package pygeodesy :: Module ecef :: Class _EcefBase
[frames] | no frames]

Class _EcefBase

  object --+        
           |        
named._Named --+    
               |    
named._NamedBase --+
                   |
                  _EcefBase
Known Subclasses:

(INTERNAL) Base class for EcefKarney, EcefVeness and EcefYou.

Instance Methods
 
__init__(self, a_ellipsoid, f=None, name='')
New Ecef* converter.
 
__eq__(self, other)
Compare this and an other Ecef.
 
forward(self, latlonh, lon=None, height=0, M=False, name='')
Convert from geodetic (lat, lon, height) to geocentric (x, y, z).
 
forward_(self, phi, lam, height=0, M=False, name='')
Like method .forward except with geodetic lat- and longitude given in radians.
 
reverse(self, xyz, y=None, z=None, M=False, name='')
(INTERNAL) Must be overloaded, see function notOverloaded.
 
toStr(self, prec=9, **unused)
Return this Ecef* as a string.

Inherited from named._NamedBase: __repr__, __str__, others, toRepr

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

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

Properties
  equatoradius
Get the equatorial radius, semi-axis (meter).
  equatorialRadius
Get the equatorial radius, semi-axis (meter).
  a
Get the equatorial radius, semi-axis (meter).
  datum
Get the datum (Datum).
  ellipsoid
Get the ellipsoid (Ellipsoid or Ellipsoid2).
  flattening
Get the flattening (float), (a - b) / a, positive for oblate, negative for prolate or 0 for near-spherical.
  f
Get the flattening (float), (a - b) / a, positive for oblate, negative for prolate or 0 for near-spherical.

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

Inherited from object: __class__

Method Details

__init__ (self, a_ellipsoid, f=None, name='')
(Constructor)

 

New Ecef* converter.

Arguments:
  • a_ellipsoid - A (non-prolate) ellipsoid (Ellipsoid, Ellipsoid2, Datum or a_f2Tuple) or scalar ellipsoid's equatorial radius (meter).
  • f - None or the ellipsoid flattening (scalar), required for scalar a_ellipsoid, f=0 represents a sphere, negative f a prolate ellipsoid.
  • name - Optional name (str).
Raises:
Overrides: object.__init__

__eq__ (self, other)
(Equality operator)

 

Compare this and an other Ecef.

Arguments:
  • other - The other ecef (Ecef*).
Returns:
True if equal, False otherwise.

forward (self, latlonh, lon=None, height=0, M=False, name='')

 

Convert from geodetic (lat, lon, height) to geocentric (x, y, z).

Arguments:
  • latlonh - Either a LatLon, an Ecef9Tuple or scalar latitude (degrees).
  • lon - Optional scalar longitude for scalar latlonh (degrees).
  • height - Optional height (meter), vertically above (or below) the surface of the ellipsoid.
  • M - Optionally, return the rotation EcefMatrix (bool).
  • name - Optional name (str).
Returns:
An Ecef9Tuple(x, y, z, lat, lon, height, C, M, datum) with geocentric (x, y, z) coordinates for the given geodetic ones (lat, lon, height), case C 0, optional M (EcefMatrix) and datum if available.
Raises:
  • EcefError - If latlonh not LatLon, Ecef9Tuple or scalar or lon not scalar for scalar latlonh or abs(lat) exceeds 90°.

Note: Use method .forward_ to specify lat and lon in radians and avoid double angle conversions.

forward_ (self, phi, lam, height=0, M=False, name='')

 

Like method .forward except with geodetic lat- and longitude given in radians.

Arguments:
  • phi - Latitude in radians (scalar).
  • lam - Longitude in radians (scalar).
  • height - Optional height (meter), vertically above (or below) the surface of the ellipsoid.
  • M - Optionally, return the rotation EcefMatrix (bool).
  • name - Optional name (str).
Returns:
An Ecef9Tuple(x, y, z, lat, lon, height, C, M, datum) with lat set to degrees90(phi) and lon to degrees180(lam).
Raises:
  • EcefError - If phi or lam invalid or not scalar.

toStr (self, prec=9, **unused)

 

Return this Ecef* as a string.

Arguments:
  • prec - Optional precision, number of decimal digits (0..9).
Returns:
This Ecef* representation (str).
Overrides: named._Named.toStr

Property Details

equatoradius

Get the equatorial radius, semi-axis (meter).

Get method:
equatoradius(self) - Get the equatorial radius, semi-axis (meter).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

equatorialRadius

Get the equatorial radius, semi-axis (meter).

Get method:
equatoradius(self) - Get the equatorial radius, semi-axis (meter).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

a

Get the equatorial radius, semi-axis (meter).

Get method:
equatoradius(self) - Get the equatorial radius, semi-axis (meter).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

datum

Get the datum (Datum).

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

ellipsoid

Get the ellipsoid (Ellipsoid or Ellipsoid2).

Get method:
ellipsoid(self) - Get the ellipsoid (Ellipsoid or Ellipsoid2).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

flattening

Get the flattening (float), (a - b) / a, positive for oblate, negative for prolate or 0 for near-spherical.

Get method:
flattening(self) - Get the flattening (float), (a - b) / a, positive for oblate, negative for prolate or 0 for near-spherical.
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

f

Get the flattening (float), (a - b) / a, positive for oblate, negative for prolate or 0 for near-spherical.

Get method:
flattening(self) - Get the flattening (float), (a - b) / a, positive for oblate, negative for prolate or 0 for near-spherical.
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.