Package pygeodesy :: Module utm :: Class Utm

Class Utm

   object --+            
            |            
 named._Named --+        
                |        
 named._NamedBase --+    
                    |    
utmupsBase.UtmUpsBase --+
                        |
                       Utm

Known Subclasses:

etm.Etm

Universal Transverse Mercator (UTM) coordinate.

Instance Methods

__eq__(self, other)

__init__(self, zone=31, hemisphere='N', easting=166022, northing=0, band='', datum=Datum(name='WGS84', ellipsoid=Ellipsoids.WGS84, transform=Tran..., falsed=True, gamma=None, scale=None, name='', **convergence)
New Utm UTM coordinate.

__repr__(self)
Default repr(self).

__str__(self)
Default str(self).

parse(self, strUTM, name='')
Parse a string to a similar Utm instance.

parseUTM(self, strUTM)
DEPRECATED, use method Utm.parse.

toEtm(self)
Copy this UTM to an ETM coordinate.

toLatLon(self, LatLon=None, eps=2.220446049250313e-16, unfalse=True, **LatLon_kwds)
Convert this UTM coordinate to an (ellipsoidal) geodetic point.

toRepr(self, prec=0, fmt='[%s]', sep=', ', B=False, cs=False, **unused)
Return a string representation of this UTM coordinate.

toStr(self, prec=0, sep=' ', B=False, cs=False)
Return a string representation of this UTM coordinate.

toUps(self, pole='', eps=2.220446049250313e-16, falsed=True, **unused)
Convert this UTM coordinate to a UPS coordinate.

toUtm(self, zone, eps=2.220446049250313e-16, falsed=True, **unused)
Convert this UTM coordinate to a different zone.

Inherited from utmupsBase.UtmUpsBase: eastingnorthing2, to2en, toEpsg, toMgrs

Inherited from named._NamedBase: others

Inherited from named._Named: __imatmul__, __matmul__, __rmatmul__, attrs, classof, copy, dup, methodname, rename, toStr2

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

Properties
	band Class `property` with retrievable name.
	falsed2 Get the easting and northing falsing (EasNor2Tuple`(easting, northing)`).
	pole Get the top center of (stereographic) projection, `""` always.
	zone Get the (longitudinal) zone (`int`, 1..60).
Inherited from `utmupsBase.UtmUpsBase`: `convergence`, `datum`, `easting`, `eastingnorthing`, `falsed`, `gamma`, `hemisphere`, `northing`, `scale`, `scale0` Inherited from `named._Named`: `classname`, `classnaming`, `iteration`, `name`, `named`, `named2`, `named3`, `named4`, `sizeof` Inherited from `object`: `__class__`

Method Details

init (self, zone=31, hemisphere=`'N'`, easting=166022, northing=0, band='', datum=Datum(name='WGS84', ellipsoid=Ellipsoids.WGS84, transform=Tran`...`, falsed=True, gamma=None, scale=None, name='', **convergence)
(Constructor)

New Utm UTM coordinate.

Arguments:

zone - Longitudinal UTM zone (int, 1..60) or zone with/-out latitudinal Band letter (str, '1C'|..|'60X').
hemisphere - Northern or southern hemisphere (str, 'N[orth]' or 'S[outh]').
easting - Easting, see falsed (meter).
northing - Northing, see falsed (meter).
band - Optional, latitudinal band (str, 'C'|..|'X', no 'I'|'O').
datum - Optional, this coordinate's datum (Datum, Ellipsoid, Ellipsoid2 or a_f2Tuple).
falsed - If True, both easting and northing are falsed (bool).
gamma - Optional meridian convergence, bearing off grid North, clockwise from true North (degrees) or None.
scale - Optional grid scale factor (scalar) or None.
name - Optional name (str).
convergence - DEPRECATED, use keyword argument gamma=None.

Raises:

TypeError - Invalid or near-spherical datum.
UTMError - Invalid zone, hemishere, easting, northing, band, convergence or scale.

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)

parse (self, strUTM, name='')

Parse a string to a similar Utm instance.

Arguments:

strUTM - The UTM coordinate (str), see function parseUTM5.
name - Optional instance name (str), overriding this name.

Returns:

The similar instance (Utm).

Raises:

UTMError - Invalid strUTM.

See Also: Functions pygeodesy.parseUPS5 and pygeodesy.parseUTMUPS5.

parseUTM (self, strUTM)

DEPRECATED, use method Utm.parse.

Decorators:

@deprecated_method

toEtm (self)

Copy this UTM to an ETM coordinate.

Returns:: The ETM coordinate (Etm).

toLatLon (self, LatLon=None, eps=2.220446049250313e-16, unfalse=True, **LatLon_kwds)

Convert this UTM coordinate to an (ellipsoidal) geodetic point.

Arguments:

LatLon - Optional, ellipsoidal class to return the geodetic point (LatLon) or None.
eps - Optional convergence limit, EPS or above (float).
unfalse - Unfalse easting and northing if falsed (bool).
LatLon_kwds - Optional, additional LatLon keyword arguments, ignored if LatLon is None.

Returns:

This UTM as (LatLon) or if LatLon is None, as LatLonDatum5Tuple

(lat, lon, datum, gamma, 
          scale)

Raises:

TypeError - Invalid datum or LatLon is not ellipsoidal.
UTMError - Invalid meridional radius or H-value.

toRepr (self, prec=0, fmt='[%s]', sep=', ', B=False, cs=False, **unused)

Return a string representation of this UTM coordinate.

Note that UTM coordinates are rounded, not truncated (unlike MGRS grid references).

Arguments:

prec - Number of (decimal) digits, unstripped (int).
fmt - Enclosing backets format (str).
sep - Optional separator between name:value pairs (str).
B - Optionally, include latitudinal band (bool).
cs - Optionally, include meridian convergence and grid scale factor (bool or non-zero int to specify the precison like prec).

Returns:

This UTM as a string

"[Z:09[band], H:N|S, E:meter, 
          N:meter]"

plus

", C:degrees, 
          S:float"

if cs is True (str).

Overrides: named._Named.toRepr

toStr (self, prec=0, sep=' ', B=False, cs=False)

Return a string representation of this UTM coordinate.

To distinguish from MGRS grid zone designators, a space is left between the zone and the hemisphere.

Note that UTM coordinates are rounded, not truncated (unlike MGRS grid references).

Arguments:

prec - Number of (decimal) digits, unstripped (int).
sep - Optional separator to join (str) or None to return an unjoined tuple of strs.
B - Optionally, include latitudinal band (bool).
cs - Optionally, include meridian convergence and grid scale factor (bool or non-zero int to specify the precison like prec).

Returns:

This UTM as a string with

zone[band], hemisphere, easting, 
          northing, [convergence, scale]

"00 N|S meter
          meter"

plus " degrees float" if cs is True (str).

Overrides: named._Named.toStr

toUps (self, pole='', eps=2.220446049250313e-16, falsed=True, **unused)

Convert this UTM coordinate to a UPS coordinate.

Arguments:

pole - Optional top/center of the UPS projection, (str, 'N[orth]'|'S[outh]').
eps - Optional convergence limit, EPS or above (float), see method Utm.toLatLon.
falsed - False both easting and northing (bool).

Returns:

The UPS coordinate (Ups).

toUtm (self, zone, eps=2.220446049250313e-16, falsed=True, **unused)

Convert this UTM coordinate to a different zone.

Arguments:

zone - New UTM zone (int).
eps - Optional convergence limit, EPS or above (float), see method Utm.toLatLon.
falsed - False both easting and northing (bool).

Returns:

The UTM coordinate (Utm).

Property Details

band

Class property with retrievable name.

Get method:: band(self) - Get the latitudinal band ('C'|..|'X').
Set method:: band(self, band) - Set or reset the latitudinal band letter ('C'|..|'X') or None or "" to reset.

falsed2

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

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

pole

Get the top center of (stereographic) projection, "" always.

Get method:: pole(self) - Get the top center of (stereographic) projection, "" always.
Set method:: _fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:: _fdel(inst) - Zap the cached/memoized property value.

zone

Get the (longitudinal) zone (int, 1..60).

Get method:: zone(self) - Get the (longitudinal) zone (int, 1..60).
Set method:: _fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:: _fdel(inst) - Zap the cached/memoized property value.

Class Utm

__init__ (self, zone=31, hemisphere='N', easting=166022, northing=0, band='', datum=Datum(name='WGS84', ellipsoid=Ellipsoids.WGS84, transform=Tran..., falsed=True, gamma=None, scale=None, name='', **convergence) (Constructor)

__repr__ (self) (Representation operator)

__str__ (self) (Informal representation operator)

parse (self, strUTM, name='')

parseUTM (self, strUTM)

toEtm (self)

toLatLon (self, LatLon=None, eps=2.220446049250313e-16, unfalse=True, **LatLon_kwds)

toRepr (self, prec=0, fmt='[%s]', sep=', ', B=False, cs=False, **unused)

toStr (self, prec=0, sep=' ', B=False, cs=False)

toUps (self, pole='', eps=2.220446049250313e-16, falsed=True, **unused)

toUtm (self, zone, eps=2.220446049250313e-16, falsed=True, **unused)

band

falsed2

pole

zone

init (self, zone=31, hemisphere=`'N'`, easting=166022, northing=0, band='', datum=Datum(name='WGS84', ellipsoid=Ellipsoids.WGS84, transform=Tran`...`, falsed=True, gamma=None, scale=None, name='', **convergence)
(Constructor)

repr (self)
(Representation operator)

str (self)
(Informal representation operator)