Package pygeodesy :: Module utmupsBase :: Class UtmUpsBase
[frames] | no frames]

Class UtmUpsBase

  object --+        
           |        
named._Named --+    
               |    
named._NamedBase --+
                   |
                  UtmUpsBase
Known Subclasses:

(INTERNAL) Base class for Utm and Ups coordinates.

Instance Methods
 
__init__(self, easting, northing, band='', datum=None, falsed=True, convergence=None, scale=None)
(INTERNAL) New UtmUpsBase.
 
__repr__(self)
Default repr(self).
 
__str__(self)
Default str(self).
 
eastingnorthing2(self, falsed=True)
Return easting and northing, falsed or unfalsed.
 
to2en(self, falsed=True)
DEPRECATED, use method eastingnorthing2.
 
toEpsg(self)
Determine the EPSG (European Petroleum Survey Group) code.

Inherited from named._NamedBase: others, toRepr, toStr

Inherited from named._Named: _DOT_, attrs, classof, copy, rename, toStr2

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

Properties
  convergence
Get the meridian convergence (degrees) or None if not available.
  datum
Get the datum (Datum).
  easting
Get the easting (meter).
  eastingnorthing
Get easting and northing (EasNor2Tuple(easting, northing)).
  falsed
Get easting and northing falsed (bool).
  falsed2
(INTERNAL) Must be overloaded, see function notOverloaded.
  hemisphere
Get the hemisphere (str, 'N'|'S').
  northing
Get the northing (meter).
  scale
Get the grid scale (float) or None.
  scale0
Get the central scale factor (float).

Inherited from named._Named: classname, classnaming, name, named, named2, named3, named4

Inherited from object: __class__

Method Details

__init__ (self, easting, northing, band='', datum=None, falsed=True, convergence=None, scale=None)
(Constructor)

 

(INTERNAL) New UtmUpsBase.

Overrides: object.__init__

__repr__ (self)
(Representation operator)

 

Default repr(self).

Overrides: object.__repr__
(inherited documentation)

__str__ (self)
(Informal representation operator)

 

Default str(self).

Overrides: object.__str__
(inherited documentation)

eastingnorthing2 (self, falsed=True)

 

Return easting and northing, falsed or unfalsed.

Arguments:
  • falsed - Return easting and northing falsed (bool), otherwise unfalsed.
Returns:
An EasNor2Tuple(easting, northing) in meters.

to2en (self, falsed=True)

 

DEPRECATED, use method eastingnorthing2.

Returns:
An EasNor2Tuple(easting, northing).
Decorators:
  • @deprecated_method

toEpsg (self)

 

Determine the EPSG (European Petroleum Survey Group) code.

Returns:
EPSG code (int).
Raises:

Property Details

convergence

Get the meridian convergence (degrees) or None if not available.

Get method:
convergence(self) - Get the meridian convergence (degrees) or None if not available.
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

datum

Get the datum (Datum).

Get method:
datum(self) - Get the datum (Datum).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

easting

Get the easting (meter).

Get method:
easting(self) - Get the easting (meter).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

eastingnorthing

Get easting and northing (EasNor2Tuple(easting, northing)).

Get method:
eastingnorthing(self) - Get easting and northing (EasNor2Tuple(easting, northing)).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

falsed

Get easting and northing falsed (bool).

Get method:
falsed(self) - Get easting and northing falsed (bool).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

falsed2

(INTERNAL) Must be overloaded, see function notOverloaded.

Get method:
falsed2(self) - (INTERNAL) Must be overloaded, see function notOverloaded.
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

hemisphere

Get the hemisphere (str, 'N'|'S').

Get method:
hemisphere(self) - Get the hemisphere (str, 'N'|'S').
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

northing

Get the northing (meter).

Get method:
northing(self) - Get the northing (meter).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

scale

Get the grid scale (float) or None.

Get method:
scale(self) - Get the grid scale (float) or None.
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.

scale0

Get the central scale factor (float).

Get method:
scale0(self) - Get the central scale factor (float).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.