Package pyaxqg :: Module axqgs :: Class Ax2QG

Class Ax2QG

            object --+            
                     |            
pygeodesy.named._Named --+        
                         |        
pygeodesy.named._NamedBase --+    
                             |    
                     _AxQGbase --+
                                 |
                                Ax2QG

Biaxial WGS84 transformer.

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 N 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?

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 _AxQGbase: toStr

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

Inherited from _AxQGbase: ellipsoid, kind, lon0, onEPS, raiser, smooth, 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.

Overrides: _AxQGbase.axN

axN3 (self, x, y, z)

Interpolate the quasi-geoid height N 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.

Overrides: _AxQGbase.axN3

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.

Overrides: _AxQGbase.forward

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.

Overrides: _AxQGbase.forwardOn

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.

Overrides: _AxQGbase.isinside

See Also: Method Bounds4Tuple.isinside.

region4 (self, **unused)

Get the South, West, North and East bounds of the axQG region as Bounds4Tuple(latS, lonW, latN, lonE).

Overrides: _AxQGbase.region4

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.

Overrides: _AxQGbase.reverse

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.

Overrides: _AxQGbase.reverseOn

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.

Overrides: _AxQGbase.sideOf

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.

Overrides: _AxQGbase.unrotate

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

Class Ax2QG

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

axN (self, lat, lon)

axN3 (self, x, y, z)

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

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

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

region4 (self, **unused)

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

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

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

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

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