Package pygeodesy :: Package geodesicx :: Module gxline :: Class _GeodesicLineExact |
[frames] | no frames]

# Class _GeodesicLineExact

       object --+
                |
     named._Named --+
                    |
     named._NamedBase --+
                        |
    gxbases._GeodesicBase --+
                            |
                           _GeodesicLineExact

Known Subclasses:
  - gx.GeodesicLineExact

(INTERNAL) Base class for GeodesicLineExact.

Instance Methods
__init__(self, gX, lat1, lon1, azi1, caps, _debug, *salp1_calp1, **name_append) (INTERNAL) New `[_]GeodesicLineExact` instance. |
__del__(self) |
ArcPosition(self, a12, outmask=3968) Find the position on the line given `a12`. |
caps_(self, caps) Check the available capabilities. |
Position(self, s12, outmask=3968) Find the position on the line given `s12`. |
SetArc(self, a13) Set reference point 3 in terms of distance to the first point. |
SetDistance(self, s13) Set reference point 3 in terms of distance to the first point. |
toStr(self, prec=6, sep=', ', **unused) Return this `GeodesicExactLine` as string. |
Inherited from `named._NamedBase`: `__repr__`, `__str__`, `others`, `toRepr` Inherited from `named._Named`: `_DOT_`, `__imatmul__`, `__matmul__`, `__rmatmul__`, `attrs`, `classof`, `copy`, `dup`, `rename`, `toStr2` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Class Variables
Inherited from `gxbases._GeodesicBase`: `ALL`, `AREA`, `AZIMUTH`, `DISTANCE`, `DISTANCE_IN`, `EMPTY`, `GEODESICSCALE`, `LATITUDE`, `LONGITUDE`, `LONG_UNROLL`, `REDUCEDLENGTH`, `STANDARD`

Properties
| a13 Get (spherical) arc length from the first to the reference point (`degrees`).
| azi0 Get the equatorial azimuth, the azimuth of this geodesic line as it crosses the equator in a northward direction (`degrees90`).
| azi0_sincos2 Get the sine and cosine of the equatorial azimuth (2-tuple `(sin, cos)`).
| azi1 Get the azimuth at the first point (compass `degrees`).
| azi1_sincos2 Get the sine and cosine of the first point's azimuth (2-tuple `(sin, cos)`).
| caps Get the capabilities (bit-or'ed `Caps`).
| geodesic Get the exact geodesic (GeodesicExact).
| lat1 Get the latitude of the first point (`degrees`).
| lon1 Get the longitude of the first point (`degrees`).
| s13 Get the distance from the first to the reference point C({meter}).
Inherited from `gxbases._GeodesicBase`: `debug` Inherited from `named._Named`: `classname`, `classnaming`, `name`, `named`, `named2`, `named3`, `named4` Inherited from `object`: `__class__`

Method Details

### __init__ (self, gX, lat1, lon1, azi1, caps, _debug, *salp1_calp1, **name_append) (Constructor) |
(INTERNAL) New `[_]GeodesicLineExact` instance. Overrides: object.__init__

### ArcPosition (self, a12, outmask=3968) |
Find the position on the line given `a12`. Arguments: `a12` - Spherical arc length from the first point to the second point (`degrees`). `outmask` - Bit-or'ed combination of Caps values specifying the quantities to be returned. Returns: A GDict with up to 12 items `lat1, lon1, azi1, lat2, lon2, azi2, m12, a12, s12, M12, M21, S12` with `lat1`, `lon1`, `azi1` and arc length `a12` always included, except when `a12=NAN`. Note: By default, `outmask=STANDARD`, meaning thc `lat1`, `lon1`, `azi1`, `lat2`, `lon2`, `azi2`, `s12` and `a12` entries are returned, except when `a12=NAN`.

### caps_ (self, caps) |
Check the available capabilities. Arguments: `caps` - Bit-or'ed combination of Caps values for all capabilities to be checked. Returns: `True` if all `caps` are available, `False` otherwise (`bool`).

### Position (self, s12, outmask=3968) |
Find the position on the line given `s12`. Arguments: `s12` - Distance from the first point to the second C({meter}). `outmask` - Bit-or'ed combination of Caps values specifying the quantities to be returned. Returns: A GDict with up to 12 items `lat1, lon1, azi1, lat2, lon2, azi2, m12, a12, s12, M12, M21, S12` with `lat1`, `lon1`, `azi1` and arc length `a12` always included, except when `a12=NAN`. Notes: By default, `outmask=STANDARD`, meaning thc `lat1`, `lon1`, `azi1`, `lat2`, `lon2`, `azi2`, `s12` and `a12` entries are returned, except when `a12=NAN`. This GeodesicLineExact instance must have been constructed with capability `Caps.DISTANCE_IN` set.

### SetArc (self, a13) |
Set reference point 3 in terms of distance to the first point. Arguments: `a13` - Spherical arc length from the first to the reference point (`degrees`). Returns: The distance `s13` (`meter`) between the first and the reference point.

### SetDistance (self, s13) |
Set reference point 3 in terms of distance to the first point. Arguments: `s13` - Distance from the first to the reference point C({meter}). Returns: The arc length `a13` (`degrees`) between the first and the reference point or `NAN`.

### toStr (self, prec=6, sep=', ', **unused) |
Return this `GeodesicExactLine` as string. Arguments: `prec` - The `float` precision, number of decimal digits (0..9). Trailing zero decimals are stripped for `prec` values of 1 and above, but kept for negative `prec` values. `sep` - Optional separator to join (`str`). Returns: `GeodesicExactLine` (`str`). Overrides: named._Named.toStr

Property Details

### a13 Get (spherical) arc length from the first to the reference point (`degrees`). Get method: a13(self) - Get (spherical) arc length from the first to the reference point (`degrees`). Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value. See Also: Method SetArc.

### azi0 Get the equatorial azimuth, the azimuth of this geodesic line as it crosses the equator in a northward direction (`degrees90`). Get method: azi0(self) - Get the equatorial azimuth, the azimuth of this geodesic line as it crosses the equator in a northward direction (`degrees90`). Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### azi0_sincos2 Get the sine and cosine of the equatorial azimuth (2-tuple `(sin, cos)`). Get method: azi0_sincos2(self) - Get the sine and cosine of the equatorial azimuth (2-tuple `(sin, cos)`). Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### azi1 Get the azimuth at the first point (compass `degrees`). Get method: azi1(self) - Get the azimuth at the first point (compass `degrees`). Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### azi1_sincos2 Get the sine and cosine of the first point's azimuth (2-tuple `(sin, cos)`). Get method: azi1_sincos2(self) - Get the sine and cosine of the first point's azimuth (2-tuple `(sin, cos)`). Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### caps Get the capabilities (bit-or'ed `Caps`). Get method: caps(self) - Get the capabilities (bit-or'ed `Caps`). Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### geodesic Get the exact geodesic (GeodesicExact). Get method: geodesic(self) - Get the exact geodesic (GeodesicExact). Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### lat1 Get the latitude of the first point (`degrees`). Get method: lat1(self) - Get the latitude of the first point (`degrees`). Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### lon1 Get the longitude of the first point (`degrees`). Get method: lon1(self) - Get the longitude of the first point (`degrees`). Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### s13 Get the distance from the first to the reference point C({meter}). Get method: s13(self) - Get the distance from the first to the reference point C({meter}). Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value. See Also: Method SetDistance.