Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
geographiclib.geodesicline.GeodesicLine Class Reference
Inheritance diagram for geographiclib.geodesicline.GeodesicLine:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, geod, lat1, lon1, azi1, caps=GeodesicCapability.STANDARD|GeodesicCapability.DISTANCE_IN, salp1=Math.nan, calp1=Math.nan)
 
def ArcPosition (self, a12, outmask=GeodesicCapability.STANDARD)
 
def Position (self, s12, outmask=GeodesicCapability.STANDARD)
 
def SetArc (self, a13)
 
def SetDistance (self, s13)
 
- Public Member Functions inherited from object
template<typename T >
T cast () const &
 
template<typename T >
T cast ()&&
 
template<>
void cast () const &
 
template<>
void cast ()&&
 
 object ()=default
 
 object (const object &o)
 Copy constructor; always increases the reference count. More...
 
 object (object &&other) noexcept
 Move constructor; steals the object from other and preserves its reference count. More...
 
 object (handle h, borrowed_t)
 
 object (handle h, stolen_t)
 
object & operator= (const object &other)
 
object & operator= (object &&other) noexcept
 
 PYBIND11_DEPRECATED ("Use reinterpret_borrow<object>() or reinterpret_steal<object>()") object(handle h
 
handle release ()
 
 ~object ()
 Destructor; automatically calls handle::dec_ref() More...
 
- Public Member Functions inherited from handle
template<typename T >
T cast () const
 
template<>
void cast () const
 
bool check () const
 
const handle & dec_ref () const &
 
 handle ()=default
 The default constructor creates a handle with a nullptr-valued pointer. More...
 
 handle (PyObject *ptr)
 Creates a handle from the given raw Python object pointer. More...
 
const handle & inc_ref () const &
 
 operator bool () const
 Return true when the handle wraps a valid Python object. More...
 
bool operator!= (const handle &h) const
 
bool operator== (const handle &h) const
 
PyObject * ptr () const
 Return the underlying PyObject * pointer. More...
 
PyObject *& ptr ()
 

Public Attributes

 a
 
 a13
 
 azi1
 
 calp1
 
 caps
 
 f
 
 lat1
 
 lon1
 
 s13
 
 salp1
 
- Public Attributes inherited from object
bool is_borrowed: handle(h) { if (is_borrowed) inc_ref()
 

Private Member Functions

def _GenPosition (self, arcmode, s12_a12, outmask)
 

Private Attributes

 _A1m1
 
 _A2m1
 
 _A3c
 
 _A4
 
 _b
 
 _B11
 
 _B21
 
 _B31
 
 _B41
 
 _C1a
 
 _C1pa
 
 _c2
 
 _C2a
 
 _C3a
 
 _C4a
 
 _calp0
 
 _comg1
 
 _csig1
 
 _ctau1
 
 _dn1
 
 _f1
 
 _k2
 
 _salp0
 
 _somg1
 
 _ssig1
 
 _stau1
 

Additional Inherited Members

- Protected Attributes inherited from handle
PyObject * m_ptr = nullptr
 

Detailed Description

Points on a geodesic path

Definition at line 63 of file geodesicline.py.

Constructor & Destructor Documentation

def geographiclib.geodesicline.GeodesicLine.__init__ (   self,
  geod,
  lat1,
  lon1,
  azi1,
  caps = GeodesicCapability.STANDARD |                GeodesicCapability.DISTANCE_IN,
  salp1 = Math.nan,
  calp1 = Math.nan 
) 
Construct a GeodesicLine object

:param geod: a :class:`~geographiclib.geodesic.Geodesic` object
:param lat1: latitude of the first point in degrees
:param lon1: longitude of the first point in degrees
:param azi1: azimuth at the first point in degrees
:param caps: the :ref:`capabilities <outmask>`

This creates an object allowing points along a geodesic starting at
(*lat1*, *lon1*), with azimuth *azi1* to be found.  The default
value of *caps* is STANDARD | DISTANCE_IN.  The optional parameters
*salp1* and *calp1* should not be supplied; they are part of the
private interface.

Definition at line 69 of file geodesicline.py.

Member Function Documentation

def geographiclib.geodesicline.GeodesicLine._GenPosition (   self,
  arcmode,
  s12_a12,
  outmask 
)
private 
Private: General solution of position along geodesic

Definition at line 189 of file geodesicline.py.

def geographiclib.geodesicline.GeodesicLine.ArcPosition (   self,
  a12,
  outmask = GeodesicCapability.STANDARD 
) 
Find the position on the line given *a12*

:param a12: spherical arc length from the first point to the second
  in degrees
:param outmask: the :ref:`output mask <outmask>`
:return: a :ref:`dict`

The default value of *outmask* is STANDARD, i.e., the *lat1*,
*lon1*, *azi1*, *lat2*, *lon2*, *azi2*, *s12*, *a12* entries are
returned.

Definition at line 374 of file geodesicline.py.

def geographiclib.geodesicline.GeodesicLine.Position (   self,
  s12,
  outmask = GeodesicCapability.STANDARD 
) 
Find the position on the line given *s12*

:param s12: the distance from the first point to the second in
  meters
:param outmask: the :ref:`output mask <outmask>`
:return: a :ref:`dict`

The default value of *outmask* is STANDARD, i.e., the *lat1*,
*lon1*, *azi1*, *lat2*, *lon2*, *azi2*, *s12*, *a12* entries are
returned.  The :class:`~geographiclib.geodesicline.GeodesicLine`
object must have been constructed with the DISTANCE_IN capability.

Definition at line 341 of file geodesicline.py.

def geographiclib.geodesicline.GeodesicLine.SetArc (   self,
  a13 
) 
Specify the position of point 3 in terms of arc length

:param a13: spherical arc length from point 1 to point 3 in degrees

Definition at line 416 of file geodesicline.py.

def geographiclib.geodesicline.GeodesicLine.SetDistance (   self,
  s13 
) 
Specify the position of point 3 in terms of distance

:param s13: distance from point 1 to point 3 in meters

Definition at line 406 of file geodesicline.py.

Member Data Documentation

geographiclib.geodesicline.GeodesicLine._A1m1
private

Definition at line 146 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._A2m1
private

Definition at line 163 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._A3c
private

Definition at line 172 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._A4
private

Definition at line 180 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._b
private

Definition at line 91 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._B11
private

Definition at line 149 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._B21
private

Definition at line 166 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._B31
private

Definition at line 173 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._B41
private

Definition at line 181 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._C1a
private

Definition at line 147 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._C1pa
private

Definition at line 159 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._c2
private

Definition at line 92 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._C2a
private

Definition at line 164 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._C3a
private

Definition at line 170 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._C4a
private

Definition at line 177 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._calp0
private

Definition at line 124 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._comg1
private

Definition at line 135 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._csig1
private

Definition at line 135 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._ctau1
private

Definition at line 154 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._dn1
private

Definition at line 118 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._f1
private

Definition at line 93 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._k2
private

Definition at line 142 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._salp0
private

Definition at line 121 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._somg1
private

Definition at line 134 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._ssig1
private

Definition at line 134 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine._stau1
private

Definition at line 153 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine.a

Definition at line 87 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine.a13

Definition at line 185 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine.azi1

Definition at line 104 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine.calp1

Definition at line 105 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine.caps

Definition at line 94 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine.f

Definition at line 89 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine.lat1

Definition at line 99 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine.lon1

Definition at line 101 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine.s13

Definition at line 183 of file geodesicline.py.

geographiclib.geodesicline.GeodesicLine.salp1

Definition at line 109 of file geodesicline.py.

The documentation for this class was generated from the following file:

gtsam
Author(s):
autogenerated on Sat May 8 2021 02:58:00