Package pygeodesy :: Module points :: Class LatLon_
[frames] | no frames]

Class LatLon_

object --+
         |
        LatLon_
Known Subclasses:

Low-overhead LatLon class for Numpy2LatLon and Tuple2LatLon.

Instance Methods
 
__eq__(self, other)
 
__init__(self, lat, lon, name='', height=0, datum=None)
Creat a new, mininal, low-overhead LatLon_ instance, without heigth and datum.
 
__ne__(self, other)
 
__repr__(self)
repr(x)
 
__str__(self)
str(x)
 
classof(self, *args, **kwds)
Instantiate this very class.
 
copy(self, deep=False)
Make a shallow or deep copy of this instance.
 
heightStr(self, prec=-2)
Return a string for the height height.
 
others(self, *other, **name_other_up)
Refined class comparison.
 
points(self, points, closed=False, base=None)
DEPRECATED, use method points2.
 
points2(self, points, closed=False, base=None)
Check a path or polygon represented by points.
 
to2ab(self)
DEPRECATED, use property philam.
 
toNvector(self, h=None, Nvector=<class 'pygeodesy.nvectorBase.NvectorBase'>, **Nvector_kwds)
Convert this point to n-vector (normal to the earth's surface) components, including height.
 
toRepr(self, **kwds)
This LatLon_ as a string "class(<degrees>, ...)".
 
toStr(self, form='d', prec=6, sep=', ', **kwds)
This LatLon_ as a string "<degrees>, <degrees>".
 
toStr2(self, **kwds)
DEPRECATED, used method LatLon_.toRepr.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Properties
  datum
  height
  lat
  latlon
Get the lat- and longitude in degrees (LatLon2Tuple(lat, lon)).
  latlonheight
Get the lat-, longitude and height (LatLon3Tuple(lat, lon, height)).
  lon
  name
  philam
Get the lat- and longitude in radians (PhiLam2Tuple(phi, lam)).
  philamheight
Get the lat-, longitude in radians and height (PhiLam3Tuple(phi, lam, height)).

Inherited from object: __class__

Method Details

__init__ (self, lat, lon, name='', height=0, datum=None)
(Constructor)

 

Creat a new, mininal, low-overhead LatLon_ instance, without heigth and datum.

Arguments:
  • lat - Latitude (degrees).
  • lon - Longitude (degrees).
  • name - Optional name (str).
  • height - Optional height (float or int).
  • datum - Optional datum (Datum, Ellipsoid, Ellipsoid2, a_f2Tuple or scalar radius) or None.
Raises:
  • TypeError - Invalid datum.
Overrides: object.__init__

Note: The lat- and longitude are taken as-given, un-clipped and un-validated .

__repr__ (self)
(Representation operator)

 

repr(x)

Overrides: object.__repr__
(inherited documentation)

__str__ (self)
(Informal representation operator)

 

str(x)

Overrides: object.__str__
(inherited documentation)

classof (self, *args, **kwds)

 

Instantiate this very class.

Arguments:
  • args - Optional, positional arguments.
  • kwds - Optional, keyword arguments.
Returns:
New instance (self.__class__).

copy (self, deep=False)

 

Make a shallow or deep copy of this instance.

Arguments:
  • deep - If True make a deep, otherwise a shallow copy (bool).
Returns:
The copy (This class or subclass thereof).

heightStr (self, prec=-2)

 

Return a string for the height height.

Arguments:
  • prec - Optional number of decimals, unstripped (int).

See Also: Function hstr.

others (self, *other, **name_other_up)

 

Refined class comparison.

Arguments:
  • other - The other instance (any).
  • name_other_up - Overriding name=other and up=1 keyword arguments.
Returns:
The other if compatible.
Raises:
  • TypeError - Incompatible other type.

points2 (self, points, closed=False, base=None)

 

Check a path or polygon represented by points.

Arguments:
  • points - The path or polygon points (LatLon[])
  • closed - Optionally, consider the polygon closed, ignoring any duplicate or closing final points (bool).
  • base - Optionally, check all points against this base class, if None don't check.
Returns:
A Points2Tuple(number, points) with the number of points and the points list or tuple.
Raises:
  • PointsError - Insufficient number of points.
  • TypeError - Some points are not base.

to2ab (self)

 

DEPRECATED, use property philam.

Returns:
A PhiLam2Tuple(phi, lam).

toNvector (self, h=None, Nvector=<class 'pygeodesy.nvectorBase.NvectorBase'>, **Nvector_kwds)

 

Convert this point to n-vector (normal to the earth's surface) components, including height.

Arguments:
  • h - Optional height, overriding this point's height (meter).
  • Nvector - Optional class to return the n-vector components (Nvector) or None.
  • Nvector_kwds - Optional, additional Nvector keyword arguments, ignored if Nvector=None.
Returns:
The n-vector components Nvector or if Nvector is None, a Vector4Tuple(x, y, z, h).
Raises:
  • TypeError - Invalid Nvector or Nvector_kwds.

toRepr (self, **kwds)

 

This LatLon_ as a string "class(<degrees>, ...)".

Arguments:
  • kwds - Optional, keyword arguments.
Returns:
Class instance (str).

toStr (self, form='d', prec=6, sep=', ', **kwds)

 

This LatLon_ as a string "<degrees>, <degrees>".

Arguments:
  • form - Optional format, F_D, F_DM, F_DMS for deg°, deg°min′, deg°min′sec″ (str).
  • prec - Optional number of decimal digits (0..8 or None).
  • sep - Optional separator to join (str).
  • kwds - Optional, keyword arguments.
Returns:
Instance (str).

toStr2 (self, **kwds)

 

DEPRECATED, used method LatLon_.toRepr.

Arguments:
  • kwds - Optional, keyword arguments.
Returns:
Class instance (str).

Property Details

latlon

Get the lat- and longitude in degrees (LatLon2Tuple(lat, lon)).

Get method:
latlon(self) - Get the lat- and longitude in degrees (LatLon2Tuple(lat, lon)).
Set method:
immutable(inst, value) - Throws an AttributeError, always.

latlonheight

Get the lat-, longitude and height (LatLon3Tuple(lat, lon, height)).

Get method:
latlonheight(self) - Get the lat-, longitude and height (LatLon3Tuple(lat, lon, height)).
Set method:
immutable(inst, value) - Throws an AttributeError, always.

philam

Get the lat- and longitude in radians (PhiLam2Tuple(phi, lam)).

Get method:
philam(self) - Get the lat- and longitude in radians (PhiLam2Tuple(phi, lam)).
Set method:
immutable(inst, value) - Throws an AttributeError, always.

philamheight

Get the lat-, longitude in radians and height (PhiLam3Tuple(phi, lam, height)).

Get method:
philamheight(self) - Get the lat-, longitude in radians and height (PhiLam3Tuple(phi, lam, height)).
Set method:
immutable(inst, value) - Throws an AttributeError, always.