Package pygeodesy :: Module geodsolve :: Class GeodesicLineSolve |
[frames] | no frames]

# Class GeodesicLineSolve

             object --+
                      |
           named._Named --+
                          |
           named._NamedBase --+
                              |
               karney._CapsBase --+
                                  |
    geodesicx.gxbases._GeodesicBase --+
                                      |
                     _GeodesicSolveBase --+
                                          |
                                         GeodesicLineSolve

Wrapper to invoke Karney's GeodSolve as an `Exact` version of Karney's Python class GeodesicLine.

Notes:

- Use property `GeodSolve` or env variable `PYGEODESY_GEODSOLVE` to specify the (fully qualified) path to the `GeodSolve` executable.
- This `geodesic` is intended for testing purposes only, it invokes the `GeodSolve` executable for every method call.

Instance Methods
__init__(self, geodesic, lat1, lon1, azi1, caps=32640, name='') New GeodesicLineSolve instance, allowing points to be found along a geodesic starting at `(lat1, lon1)` with azimuth `azi1`. |
ArcPosition(self, a12, *unused) Find the position on the line given `a12`. |
caps_(self, caps) Check the available capabilities. |
Position(self, s12, *unused) Find the position on the line given `s12`. |
Inherited from `_GeodesicSolveBase`: `invoke`, `toStr` Inherited from `named._NamedBase`: `__repr__`, `__str__`, `others`, `toRepr` Inherited from `named._Named`: `__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 `karney._CapsBase`: `ALL`, `AREA`, `AZIMUTH`, `DISTANCE`, `DISTANCE_IN`, `EMPTY`, `GEODESICSCALE`, `LATITUDE`, `LINE_OFF`, `LONGITUDE`, `LONG_UNROLL`, `REDUCEDLENGTH`, `STANDARD`

Properties
| 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`).
| ellipsoid Get the ellipsoid (`Ellipsoid`).
| lat1 Get the latitude of the first point (`degrees`).
| lon1 Get the longitude of the first point (`degrees`).
Inherited from `_GeodesicSolveBase`: `Exact`, `GeodSolve`, `a`, `f`, `invokation`, `prec`, `reverse2`, `status`, `unroll`, `verbose`, `version` Inherited from `karney._CapsBase`: `debug` Inherited from `named._Named`: `classname`, `classnaming`, `iteration`, `name`, `named`, `named2`, `named3`, `named4` Inherited from `object`: `__class__`

Method Details

### __init__ (self, geodesic, lat1, lon1, azi1, caps=32640, name='') (Constructor) |
New GeodesicLineSolve instance, allowing points to be found along a geodesic starting at `(lat1, lon1)` with azimuth `azi1`. Arguments: `geodesic` - The geodesic to use (GeodesicSolve). `lat1` - Latitude of the first point (`degrees`). `lon1` - Longitude of the first point (`degrees`). `azi1` - Azimuth at the first points (compass `degrees`). `caps` - Bit-or'ed combination of Caps values specifying the capabilities the GeodesicLineSolve instance should possess, always `Caps.ALL`. `name` - Optional name (`str`). Raises: `TypeError` - Invalid `geodesic`. Overrides: object.__init__

### ArcPosition (self, a12, *unused) |
Find the position on the line given `a12`. Arguments: `a12` - Spherical arc length from the first point to the second point (`degrees`). Returns: A `dict` with 12 items `lat1, lon1, azi1, lat2, lon2, azi2, m12, a12, s12, M12, M21, S12`.

### 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, *unused) |
Find the position on the line given `s12`. Arguments: `s12` - Distance from the first point to the second (`meter`). Returns: A `dict` with 12 items `lat1, lon1, azi1, lat2, lon2, azi2, m12, a12, s12, M12, M21, S12`, possibly `a12=NAN`.

Property Details

### 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.

### 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.

### 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.