Package pygeodesy :: Package auxilats :: Module auxLat :: Class AuxLat
[frames] | no frames]

Class AuxLat

   object --+        
            |        
 named._Named --+    
                |    
auxAngle.AuxAngle --+
                    |
                   AuxLat
Known Subclasses:

Accurate conversion between Auxiliary latitudes on an ellipsoid.

Latitudes are represented by instances of AuxAngle in order to maintain precision close to the poles, Authalic latitude Xi, Conformal Chi, Geocentric Theta, Geographic Phi, Parametric Beta and Rectifying Mu.


See Also: Karney's C++ class AuxLatitude.

Instance Methods
 
__init__(self, a_earth=Datum(name='WGS84', ellipsoid=Ellipsoids.WGS84, transform=Tran..., f=None, b=None, name='', **ALorder)
New AuxLat instance on an ellipsoid or datum.
 
Authalic(self, Phi, **diff_name)
Convert Geographic to Aunthalic latitude.
 
AuthalicRadius2(self, exact=False, f_max=0.1)
Get the Authalic radius squared.
 
Conformal(self, Phi, **diff_name)
Convert Geographic to Conformal latitude.
 
convert(self, auxout, Zeta_d, exact=False)
 
Geocentric(self, Phi, **diff_name)
Convert Geographic to Geocentric latitude.
 
Geodetic(self, Phi, **diff_name)
Convert Geographic to Geodetic latitude.
 
Parametric(self, Phi, **diff_name)
Convert Geographic to Parametric latitude.
 
Reduced(self, Phi, **diff_name)
Convert Geographic to Parametric latitude.
 
Rectifying(self, Phi, **diff_name)
Convert Geographic to Rectifying latitude.
 
RectifyingRadius(self, exact=False)
Get the Rectifying radius.

Inherited from auxAngle.AuxAngle: __abs__, __add__, __bool__, __eq__, __float__, __iadd__, __isub__, __ne__, __neg__, __pos__, __radd__, __rsub__, __str__, __sub__, copyquadrant, normal, toBeta, toChi, toMu, toPhi

Inherited from named._Named: __imatmul__, __matmul__, __repr__, __rmatmul__, attrs, classof, copy, dup, methodname, rename, toRepr, toStr, toStr2

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

Static Methods

Inherited from auxAngle.AuxAngle: fromDegrees, fromLambertianDegrees, fromLambertianRadians, fromRadians

Properties
  a
Get the equatorial radius (Meter, conventionally).
  equatoradius
Get the equatorial radius (Meter, conventionally).
  ALorder
Get the AuxLat order (int, 4, 6 or 8).
  b
Get the polar radius (Meter, conventionally).
  polaradius
Get the polar radius (Meter, conventionally).
  ellipsoid
Get the ellipsoid (Ellipsoid).
  f
Get the flattening (float).
  flattening
Get the flattening (float).

Inherited from auxAngle.AuxAngle: diff, iteration, normalized, tan, toDegrees, toLambertianDegrees, toLambertianRadians, toRadians, x, y

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

Inherited from object: __class__

Method Details

__init__ (self, a_earth=Datum(name='WGS84', ellipsoid=Ellipsoids.WGS84, transform=Tran..., f=None, b=None, name='', **ALorder)
(Constructor)

 

New AuxLat instance on an ellipsoid or datum.

Arguments:
  • a_earth - Equatorial radius, semi-axis (meter) or an ellipsoid or datum (Datum, Ellipsoid, Ellipsoid2 or a_f2Tuple).
  • f - Flattening: (a - b) / a (float, near zero for spherical), ignored if a_earth is not scalar.
  • b - Optional polar radius, semi-axis (meter, same units as a_earth), ignored if a_earth is not scalar.
  • ALorder - Optional keyword arguments ALorder to set AuxLat's order, see property ALorder.
  • name - Optional name (str).
Raises:
Overrides: object.__init__

Authalic (self, Phi, **diff_name)

 

Convert Geographic to Aunthalic latitude.

Arguments:
Returns:
Parametric latitude, Beta (AuxAngle).

AuthalicRadius2 (self, exact=False, f_max=0.1)

 

Get the Authalic radius squared.

Arguments:
  • exact - If True, use the exact expression, otherwise the Taylor series.
  • f_max - Flattening not to exceed (float).
Returns:
Authalic radius squared (meter squared, same units as the ellipsoid axes).
Raises:
  • AuxError - If exact=False and abs(flattening) exceeds f_max.

Conformal (self, Phi, **diff_name)

 

Convert Geographic to Conformal latitude.

Arguments:
Returns:
Conformal latitude, Chi (AuxAngle).

Geocentric (self, Phi, **diff_name)

 

Convert Geographic to Geocentric latitude.

Arguments:
Returns:
Geocentric latitude, Phi (AuxAngle).

Geodetic (self, Phi, **diff_name)

 

Convert Geographic to Geodetic latitude.

Arguments:
Returns:
Geodetic latitude, Phi (AuxAngle).

Parametric (self, Phi, **diff_name)

 

Convert Geographic to Parametric latitude.

Arguments:
Returns:
Parametric latitude, Beta (AuxAngle).

Reduced (self, Phi, **diff_name)

 

Convert Geographic to Parametric latitude.

Arguments:
Returns:
Parametric latitude, Beta (AuxAngle).

Rectifying (self, Phi, **diff_name)

 

Convert Geographic to Rectifying latitude.

Arguments:
Returns:
Rectifying latitude, Mu (AuxAngle).

RectifyingRadius (self, exact=False)

 

Get the Rectifying radius.

Arguments:
  • exact - If True, use the exact expression, otherwise the Taylor series.
Returns:
Rectifying radius (Meter, same units as the ellipsoid axes).

Property Details

a

Get the equatorial radius (Meter, conventionally).

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

equatoradius

Get the equatorial radius (Meter, conventionally).

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

ALorder

Get the AuxLat order (int, 4, 6 or 8).

Get method:
ALorder(self) - Get the AuxLat order (int, 4, 6 or 8).
Set method:
ALorder(self, order) - Set the AuxLat order (int, 4, 6 or 8).
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

b

Get the polar radius (Meter, conventionally).

Get method:
b(self) - Get the polar radius (Meter, conventionally).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

polaradius

Get the polar radius (Meter, conventionally).

Get method:
b(self) - Get the polar radius (Meter, conventionally).
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).

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

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

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