Home       Trees       Indices       Help   
pyaxqg
Package pyaxqg :: Module axqgs :: Class _AxQGbase
[frames] | no frames]

Class _AxQGbase

            object --+        
                     |        
pygeodesy.named._Named --+    
                         |    
pygeodesy.named._NamedBase --+
                             |
                            _AxQGbase
Known Subclasses:

(INTERNAL) Ax*QG base class.

Instance Methods
 
__init__(self, raiser=False, **name)
New Ax*QG transformer instance.
 
axN(self, lat, lon)
Interpolate the quasi-geoid height N for a geodetic point.
 
axN3(self, x, y, z)
Interpolate the quasi-geoid height H for a cartesian point.
 
forward(self, lat, lon, height=0, **raiser_name)
Convert a geodetic lat, lon point and ellipsoidal height to cartesian x, y, z on this triaxial and orthometric height H.
 
forwardOn(self, lat, lon, **raiser_name)
Interpolate the (reference) triaxial's geoid grid x, y and z and geoid height N at a geodetic lat- and longitude.
 
isinside(self, lat, lon, eps=0)
Is geodetic lat and lon inside region4?
 
region4(self, **unused)
Get the South, West, North and East bounds of the axQG region as Bounds4Tuple(latS, lonW, latN, lonE).
 
reverse(self, x, y, z, H=0, **raiser_name)
Convert a cartesian x, y, z and orthometric height H point to geodetic lat-, longitude and ellipsoidal height.
 
reverseOn(self, x, y, z, H=0, normal=True, **name)
Project cartesian x, y, z onto this triaxial's surface.
 
sideOf(self, x, y, z, **eps)
Is a cartesian on, above or below this triaxial's surface?
 
toStr(self, prec=9, **unused)
Return this Ax*QG instance as a string.
 
unrotate(self, x, y, z=0, lon=None)
Reverse a cartesian to Earth-Centered, Earth-Fixed (ECEF) by this triaxial's prime-meridian rotation lon0.

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

Inherited from pygeodesy.named._Named: __format__, __imatmul__, __matmul__, __rmatmul__, attrs, classof, copy, dup, methodname, rename, renamed, toStr2

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

Properties
  ellipsoid
Get the WGS84 biaxial or EGM2008 triaxial ellipsoid.
  kind
Get the interpolation kind (int or None).
  lon0
Get the triaxial's prime-meridian rotation (degrees).
  onEPS
Get the default sideOf tolerance (meter, squared).
  raiser
Do points outside region4 cause an AxQGError?
  smooth
Get the smoothing factor (int or None).
  triaxial
Get the WGS84 or EGM2008 reference triaxial (TriAxial).

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

Inherited from object: __class__

Method Details

__init__ (self, raiser=False, **name)
(Constructor)

 

New Ax*QG transformer instance.

Arguments:
  • raiser - If True raise an AxQGError for points outside region4 (bool).
  • name - Optional name name=NN (str).
Overrides: object.__init__

axN (self, lat, lon)

 

Interpolate the quasi-geoid height N for a geodetic point.

Arguments:
  • lat - Latitude (degrees, geodetic).
  • lon - Longitude (degrees, geodetic).
Returns:
Normal or quasi-geoid height N (meter) or NAN if lat or lon is outside region4.

axN3 (self, x, y, z)

 

Interpolate the quasi-geoid height H for a cartesian point.

Arguments:
  • x - X coordinate (meter, cartesian).
  • y - Y coordinate (meter, cartesian).
  • z - Z coordinate (meter, cartesian).
Returns:
LatLonNgeoid3Tuple(lat, lon, N) with the quasi-geoid height N in meter or NAN if the point is not on the triaxial's surface.

forward (self, lat, lon, height=0, **raiser_name)

 

Convert a geodetic lat, lon point and ellipsoidal height to cartesian x, y, z on this triaxial and orthometric height H.

Arguments:
  • lat - Latitude (degrees, geodetic).
  • lon - Longitude (degrees, geodetic).
  • height - The (ellipsoidal) height (meter, conventionally) or None to ignore height interpolation.
  • raiser_name - Use raiser=True to raise an AxQGError if lat or lon is outside region4, overriding property raiser (bool) and optional name='forward' (str).
Returns:
An AxQG8Tuple(x, y, z, H, lat, lon, height, axQG) with cartesian x, y, z and (orthometric) height H all in meter or NAN and axQG this Ax*BG instance.
Raises:
  • AxQGError - If the geodetic point is outside region4 and property raiser is True or keyword argument raiser=True.

Note: Orthometric height (H = h - N) equals ellipsoidal height h less (quasi-)geoid height N.

forwardOn (self, lat, lon, **raiser_name)

 

Interpolate the (reference) triaxial's geoid grid x, y and z and geoid height N at a geodetic lat- and longitude.

Arguments:
  • lat - Latitude (degrees, geodetic).
  • lon - Longitude (degrees, geodetic).
  • raiser_name - Use raiser=True to raise an AxQGError if lat or lon is outside region4, overriding property raiser (bool) and optional name='forwardOn' (str).
Returns:
An AxyzNgeoid4Tuple(x, y, z, N) with cartesian x, y, z and geoid height N, all interpolated and in meter or NAN.
Raises:
  • AxQGError - If the geodetic point is outside region4 and property raiser is True or keyword argument raiser=True.

See Also: Geoid grid file format in Supplementary File 3.

isinside (self, lat, lon, eps=0)

 

Is geodetic lat and lon inside region4?

Arguments:
  • lat - Latitude (degrees, geodetic).
  • lon - Longitude (degrees, geodetic).
  • eps - Over-/undersize region4 (degrees).
Returns:
None if lat or lon is NAN, False if outside region4, True otherwise.

See Also: Method Bounds4Tuple.isinside.

reverse (self, x, y, z, H=0, **raiser_name)

 

Convert a cartesian x, y, z and orthometric height H point to geodetic lat-, longitude and ellipsoidal height.

Arguments:
  • x - X coordinate (meter, cartesian).
  • y - Y coordinate (meter, cartesian).
  • z - Z coordinate (meter, cartesian).
  • H - The (orthometric) height (meter, conventionally) or None to ignore height interpolation.
  • raiser_name - Use raiser=True to raise an AxQGError for points outside region4, overriding property raiser (bool) and optional name='reverse' (str).
Returns:
An AxQG8Tuple(x, y, z, H, lat, lon, height, axQG) with geodetic lat and lon and (ellipsoidal) height in meter or NAN and axQG is this Ax*QG instance.
Raises:
  • AxQGError - If the point is not on the triaxial's surface and property raiser is True or keyword argument raiser=True.

Note: Ellipsoidal height (h = H + N) equals orthometric height H plus (hybrid quasi-) geoid height N.

reverseOn (self, x, y, z, H=0, normal=True, **name)

 

Project cartesian x, y, z onto this triaxial's surface.

Arguments:
  • x - X coordinate (meter, cartesian).
  • y - Y coordinate (meter, cartesian).
  • z - Z coordinate (meter, cartesian).
  • H - The (orthometric) height (meter, conventionally) or None to ignore height interpolation.
  • normal - If True, the projection is perpendicular to the surface, otherwise radial to the center of this triaxial (bool).
  • name - Optional name='reverseOn' (str).
Returns:
An AxQG8Tuple(x, y, z, H, lat, lon, height, axQG) with cartesian x, y, z on this triaxial's surface, geodetic lat and lon and (ellipsoidal) height in meter and axQG is this Ax*QG instance.

sideOf (self, x, y, z, **eps)

 

Is a cartesian on, above or below this triaxial's surface?

Arguments:
  • x - X coordinate (meter, cartesian).
  • y - Y coordinate (meter, cartesian).
  • z - Z coordinate (meter, cartesian).
  • eps - Optional on-surface tolerance (meter, squared), overriding default onEPS.
Returns:
Signed, radial distance to this triaxial's surface (meter squared), INT0 if within tolerance eps, positive if outside or negative if inside this triaxial.

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

 

Return this Ax*QG instance as a string.

Arguments:
  • prec - Precision, number of decimal digits (int, 0..9).
Returns:
This Ax*QG (str).
Overrides: pygeodesy.named._Named.toStr

unrotate (self, x, y, z=0, lon=None)

 

Reverse a cartesian to Earth-Centered, Earth-Fixed (ECEF) by this triaxial's prime-meridian rotation lon0.

Arguments:
  • x - Rotated X coordinate (meter, cartesian).
  • y - Rotated Y coordinate (meter, cartesian).
  • z - Rotated Z coordinate (meter, cartesian).
  • lon - Optional rotation (Ang, Degrees, degrees or str), overriding this triaxial's prime-meridian rotation lon0. Negative lon rotates clockwise, positive counter-clockwise.
Returns:
Vector3Tuple(x, y, z) with x and y reversed to ECEF.

See Also: Geoid grid file format in Supplementary File 3.


Property Details

ellipsoid

Get the WGS84 biaxial or EGM2008 triaxial ellipsoid.

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

kind

Get the interpolation kind (int or None).

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

lon0

Get the triaxial's prime-meridian rotation (degrees).

Get method:
lon0(self) - Get the triaxial's prime-meridian rotation (degrees).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

onEPS

Get the default sideOf tolerance (meter, squared).

Get method:
onEPS(self) - Get the default sideOf tolerance (meter, squared).
Set method:
onEPS(self, eps) - Set the default sideOf tolerance (meter, squared).

raiser

Do points outside region4 cause an AxQGError?

Get method:
raiser(self) - Do points outside region4 cause an AxQGError?
Set method:
raiser(self, raiser) - Use True to throw an AxQGError for points outside region4.

smooth

Get the smoothing factor (int or None).

Get method:
smooth(self) - Get the smoothing factor (int or None).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

triaxial

Get the WGS84 or EGM2008 reference triaxial (TriAxial).

Get method:
triaxial(self) - Get the WGS84 or EGM2008 reference triaxial (TriAxial).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

   Home       Trees       Indices       Help   
pyaxqg
Generated by Epydoc 3.0.1 on Fri Aug 28 17:55:31 2026 http://epydoc.sourceforge.net