Package pybelbg :: Module belbgs :: Class _BeLBGbase

Class _BeLBGbase

            object --+        
                     |        
pygeodesy.named._Named --+    
                         |    
pygeodesy.named._NamedBase --+
                             |
                            _BeLBGbase

Known Subclasses:

(INTERNAL) Be*LBG base class.

Instance Methods

__init__(self, datum=None, raiser=False, **name)
New Be*LBG instance, optionally with a different conic's datum.

bounds4(self, asLb=False)
Get the South, West, North and East bounds of this Lambert conic projection.

forward(self, lat, lon, height=0, **raiser_name)
Convert geodetic (lat, lon) and (ellipsoidal) height to easting, northing and (orthometric) height H.

hBGh(self, lat, lon)
Interpolate the hybrid quasi-geoid hBG height for a geodetic point.

hBGh3(self, easting, northing)
Interpolate the hybrid quasi-geoid hBG height for a local point.

isinside(self, lat, lon, eps=0)
Is geodetic (lat, lon) inside the hBG region?

region4(self, asLb=False)
Get the South, West, North and East bounds of the hBG region.

reverse(self, easting, northing, H=0, **raiser_name)
Convert local easting, northing and (orthometric) height H to geodetic lat-, longitude and (ellipsoidal) height.

toStr(self, prec=9, **unused)
Return this Be*LBG instance as a string.

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
	conic Get the `Lambert` conic (`pygeodesy.Conic`).
	datum Get the `Lambert` conic's datum (`pygeodesy.Datum`).
	raiser Is an `BeLBGError` thrown for points outside the `hBG` region?
	Uccle Get `Uccle<https://ROBinfo.OMA.BE/en/astro-info/geographical-coordinates-of-our-sites>` (aka Ukkel) as `BelBG7Tuple`.
Inherited from `pygeodesy.named._Named`: `classname`, `classnaming`, `iteration`, `name`, `named`, `named2`, `named3`, `named4`, `sizeof`, `typename` Inherited from `object`: `__class__`

Method Details

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

New Be*LBG instance, optionally with a different conic's datum.

Arguments:

datum - Conic's datum to use (pygeodesy.Datums, ellipsoidal only).
raiser - If True raise a BeLBGError for lat- or longitudes outside region4 or below bounds4 (bool).
name - Optional name name='Be*LBG' (str).

Overrides: object.__init__

bounds4 (self, asLb=False)

Get the South, West, North and East bounds of this Lambert conic projection.

Arguments:

asLb - Use asLb=True for the bounds in local Lambert easting and northing, otherwise in geodetic lat- and longitudes (bool).

Returns:

A Bounds4Tuple(latS, lonW, latN, lonE) with (WGS84) geodetic lat- and longitudes in degrees or an Lb4Tuple(minE, minN, maxE, maxN) in meter.

Note: The bounds4 cover Belgium, Belgium's EEZ, the Netherlands, the Netherlands' EEZ and Luxemburg.

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

Convert geodetic (lat, lon) and (ellipsoidal) height to easting, northing and (orthometric) height H.

Arguments:

lat - Latitude (degrees, geodetic).
lon - Longitude (degrees, geodetic).
height - The (ellipsoidal) height (meter, conventionally) or None to ignore hBGh interpolation.

Returns:

A BeLBG7Tuple

(easting, northing, H, lat, 
          lon, height, beLBG)

with easting, northing and (orthometric) height H in meter or NAN and beLBG is this Be*LBG instance.

Raises:

BeLBGError - If the point is outside the BG region and property raiser is True or keyword argument raiser=True.

Notes:

H, easting and northing will all be NAN if lat or lon is below this converter's bounds4.
Orthometric height (H = h - N) euals ellipsoidal height h less (hybrid quasi-) geoid height N.

hBGh (self, lat, lon)

Interpolate the hybrid quasi-geoid hBG height for a geodetic point.

Arguments:

lat - Latitude (degrees, geodetic).
lon - Longitude (degrees, geodetic).

Returns:

Hybrid quasi-geoid hBG height N (meter) or NAN if lat or lon is outside region4.

hBGh3 (self, easting, northing)

Interpolate the hybrid quasi-geoid hBG height for a local point.

Arguments:

easting - Easting (meter, local).
northing - Northing (meter, local).

Returns:

LatLonN3Tuple(lat, lon, N) with the (hybrid quasi-) geoid hBG height N in meter or NAN if lat or lon is outside region4.

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

Is geodetic (lat, lon) inside the hBG region?

Arguments:

lat - Latitude (degrees, geodetic).
lon - Longitude (degrees, geodetic).
eps - Over-/undersize the hBG region (degrees).

Returns:

None if lat or lon is NAN, False if outside the hBG region, True otherwise.

See Also: Method isinside of bounds4, region4 and bounds4(asLb), region4(asLB)

region4 (self, asLb=False)

Get the South, West, North and East bounds of the hBG region.

Arguments:

asLb - Use asLb=True for the bounds in local Lambert easting and northing, otherwise in geodetic lat- and longitudes (bool).

Returns:

A Bounds4Tuple(latS, lonW, latN, lonE) with (WGS84) geodetic lat- and longitudes in degrees or an Lb4Tuple(minE, minN, maxE, maxN) in meter.

Note: The hBG region covers all of Belgium, Luxemburg and the southern half of the Netherlands.

reverse (self, easting, northing, H=0, **raiser_name)

Convert local easting, northing and (orthometric) height H to geodetic lat-, longitude and (ellipsoidal) height.

Arguments:

easting - Easting (meter, local).
northing - Northing (meter, local).
H - The (orthometric) height (meter, conventionally) or None to ignore hBGh interpolation.

Returns:

A BeLBG7Tuple

(easting, northing, H, lat, 
          lon, height, beLBG)

with geodetic lat and lon and (ellipsoidal) height in meter or NAN and beLBG is this Be*LBG instance.

Raises:

BeLBGError - If the point is outside the hBG region and property raiser is True or keyword argument raiser=True.

Notes:

All lon, lat and height will be NAN if easting or northing is below this converter's bounds4(asLb).
Ellipsoidal height (h = H + N) equals orthometric height H plus (hybrid quasi-) geoid height N.

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

Return this Be*LBG instance as a string.

Arguments:

prec - Precision, number of decimal digits (int, 0..9).

Returns:

This Be*LBG (str).

Overrides: pygeodesy.named._Named.toStr

Property Details

conic

Get the Lambert conic (pygeodesy.Conic).

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

datum

Get the Lambert conic's datum (pygeodesy.Datum).

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

raiser

Is an BeLBGError thrown for points outside the hBG region?

Get method:: raiser(self) - Is an BeLBGError thrown for points outside the hBG region?
Set method:: raiser(self, raiser) - Use True to throw an BeLBGError for points outside the hBG region.

Uccle

Get Uccle<https://ROBinfo.OMA.BE/en/astro-info/geographical-coordinates-of-our-sites> (aka Ukkel) as BelBG7Tuple.

Get method:: Uccle(self) - Get Uccle<https://ROBinfo.OMA.BE/en/astro-info/geographical-coordinates-of-our-sites> (aka Ukkel) as BelBG7Tuple.
Set method:: _fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:: _fdel(inst) - Zap the cached/memoized property value.

Class _BeLBGbase

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

bounds4 (self, asLb=False)

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

hBGh (self, lat, lon)

hBGh3 (self, easting, northing)

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

region4 (self, asLb=False)

reverse (self, easting, northing, H=0, **raiser_name)

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

conic

datum

raiser

Uccle

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