Inheritance diagram for geographiclib.geodesicline.GeodesicLine:

[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 () &&

template<typename T >
T	cast () const &

template<>
void	cast () const &

	object ()=default

	object (const object &o)
	Copy constructor; always increases the reference count. More...

	object (handle h, borrowed_t)

	object (handle h, stolen_t)

	object (object &&other) noexcept
	Move constructor; steals the object from `other` and preserves its reference count. More...

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

template<typename T , detail::enable_if_t< detail::all_of< detail::none_of< std::is_base_of< handle, T >, detail::is_pyobj_ptr_or_nullptr_t< T >>, std::is_convertible< T, PyObject * >>::value, int > = 0>
	handle (T &obj)
	Enable implicit conversion through `T::operator PyObject *()`. More...

template<typename T , detail::enable_if_t< detail::is_pyobj_ptr_or_nullptr_t< T >::value, int > = 0>
	handle (T ptr)

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 ()

PyObject *	ptr () const
	Return the underlying `PyObject *` pointer. More...

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
Static Public Member Functions inherited from handle
static std::size_t	inc_ref_counter ()

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

◆ init()

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 66 of file geodesicline.py.

Member Function Documentation

◆ _GenPosition()

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.

◆ ArcPosition()

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.

◆ Position()

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.

◆ SetArc()

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.

◆ SetDistance()

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

◆ _A1m1

geographiclib.geodesicline.GeodesicLine._A1m1

private

Definition at line 143 of file geodesicline.py.

◆ _A2m1

geographiclib.geodesicline.GeodesicLine._A2m1

private

Definition at line 160 of file geodesicline.py.

◆ _A3c

geographiclib.geodesicline.GeodesicLine._A3c

private

Definition at line 169 of file geodesicline.py.

◆ _A4

geographiclib.geodesicline.GeodesicLine._A4

private

Definition at line 177 of file geodesicline.py.

◆ _b

geographiclib.geodesicline.GeodesicLine._b

private

Definition at line 88 of file geodesicline.py.

◆ _B11

geographiclib.geodesicline.GeodesicLine._B11

private

Definition at line 146 of file geodesicline.py.

◆ _B21

geographiclib.geodesicline.GeodesicLine._B21

private

Definition at line 163 of file geodesicline.py.

◆ _B31

geographiclib.geodesicline.GeodesicLine._B31

private

Definition at line 170 of file geodesicline.py.

◆ _B41

geographiclib.geodesicline.GeodesicLine._B41

private

Definition at line 178 of file geodesicline.py.

◆ _C1a

geographiclib.geodesicline.GeodesicLine._C1a

private

Definition at line 144 of file geodesicline.py.

◆ _C1pa

geographiclib.geodesicline.GeodesicLine._C1pa

private

Definition at line 156 of file geodesicline.py.

◆ _c2

geographiclib.geodesicline.GeodesicLine._c2

private

Definition at line 89 of file geodesicline.py.

◆ _C2a

geographiclib.geodesicline.GeodesicLine._C2a

private

Definition at line 161 of file geodesicline.py.

◆ _C3a

geographiclib.geodesicline.GeodesicLine._C3a

private

Definition at line 167 of file geodesicline.py.

◆ _C4a

geographiclib.geodesicline.GeodesicLine._C4a

private

Definition at line 174 of file geodesicline.py.

◆ _calp0

geographiclib.geodesicline.GeodesicLine._calp0

private

Definition at line 121 of file geodesicline.py.

◆ _comg1

geographiclib.geodesicline.GeodesicLine._comg1

private

Definition at line 132 of file geodesicline.py.

◆ _csig1

geographiclib.geodesicline.GeodesicLine._csig1

private

Definition at line 132 of file geodesicline.py.

◆ _ctau1

geographiclib.geodesicline.GeodesicLine._ctau1

private

Definition at line 151 of file geodesicline.py.

◆ _dn1

geographiclib.geodesicline.GeodesicLine._dn1

private

Definition at line 115 of file geodesicline.py.

◆ _f1

geographiclib.geodesicline.GeodesicLine._f1

private

Definition at line 90 of file geodesicline.py.

◆ _k2

geographiclib.geodesicline.GeodesicLine._k2

private

Definition at line 139 of file geodesicline.py.

◆ _salp0

geographiclib.geodesicline.GeodesicLine._salp0

private

Definition at line 118 of file geodesicline.py.

◆ _somg1

geographiclib.geodesicline.GeodesicLine._somg1

private

Definition at line 131 of file geodesicline.py.

◆ _ssig1

geographiclib.geodesicline.GeodesicLine._ssig1

private

Definition at line 131 of file geodesicline.py.

◆ _stau1

geographiclib.geodesicline.GeodesicLine._stau1

private

Definition at line 150 of file geodesicline.py.

◆ a

geographiclib.geodesicline.GeodesicLine.a

Definition at line 84 of file geodesicline.py.

◆ a13

geographiclib.geodesicline.GeodesicLine.a13

Definition at line 182 of file geodesicline.py.

◆ azi1

geographiclib.geodesicline.GeodesicLine.azi1

Definition at line 101 of file geodesicline.py.

◆ calp1

geographiclib.geodesicline.GeodesicLine.calp1

Definition at line 102 of file geodesicline.py.

◆ caps

geographiclib.geodesicline.GeodesicLine.caps

Definition at line 91 of file geodesicline.py.

◆ f

geographiclib.geodesicline.GeodesicLine.f

Definition at line 86 of file geodesicline.py.

◆ lat1

geographiclib.geodesicline.GeodesicLine.lat1

Definition at line 96 of file geodesicline.py.

◆ lon1

geographiclib.geodesicline.GeodesicLine.lon1

Definition at line 98 of file geodesicline.py.

◆ s13

geographiclib.geodesicline.GeodesicLine.s13

Definition at line 180 of file geodesicline.py.

◆ salp1

geographiclib.geodesicline.GeodesicLine.salp1

Definition at line 106 of file geodesicline.py.

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

geodesicline.py

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _GenPosition()

◆ ArcPosition()

◆ Position()

◆ SetArc()

◆ SetDistance()

Member Data Documentation

◆ _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

◆ a

◆ a13

◆ azi1

◆ calp1

◆ caps

◆ f

◆ lat1

◆ lon1

◆ s13

◆ salp1

◆ init()