Package pygeodesy :: Module mgrs :: Class Mgrs

Class Mgrs

  object --+        
           |        
named._Named --+    
               |    
named._NamedBase --+
                   |
                  Mgrs

Military Grid Reference System (MGRS/NATO) references, with method to convert to UTM coordinates.

Instance Methods

__init__(self, zone, en100k, easting, northing, band='', datum=Datum(name='WGS84', ellipsoid=Ellipsoids.WGS84, transform=Tran..., name='')
New Mgrs Military grid reference.

parse(self, strMGRS)
Parse a string to a MGRS grid reference.

toStr(self, prec=10, sep=' ')
Return a string representation of this MGRS grid reference.

toStr2(self, prec=10, fmt='[%s]', sep=', ')
Return a string representation of this MGRS grid reference.

toUtm(self, Utm=<class 'pygeodesy.utm.Utm'>)
Convert this MGRS grid reference to a UTM coordinate.

Inherited from named._NamedBase: __repr__, __str__, others

Inherited from named._Named: _dot_, attrs, classof, copy

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

Properties
	band An immutable property (`Read Only`).
	bandLatitude An immutable property (`Read Only`).
	datum An immutable property (`Read Only`).
	en100k An immutable property (`Read Only`).
	digraph An immutable property (`Read Only`).
	easting An immutable property (`Read Only`).
	northing An immutable property (`Read Only`).
	zone An immutable property (`Read Only`).
Inherited from `named._Named`: `classname`, `classnaming`, `name`, `named`, `named2` Inherited from `object`: `__class__`

Method Details

init(self, zone, en100k, easting, northing, band=`''`, datum=Datum(name='WGS84', ellipsoid=Ellipsoids.WGS84, transform=Tran`...`, name=`''`)
(Constructor)

New Mgrs Military grid reference.

Parameters:

zone - 6° longitudinal zone (int), 1..60 covering 180°W..180°E.
en100k - Two-letter EN digraph (str), 100 km grid square.
easting - Easting (meter), within 100 km grid square.
northing - Northing (meter), within 100 km grid square.
band - Optional 8° latitudinal band (str), C..X covering 80°S..84°N.
datum - Optional this reference's datum (Datum).
name - Optional name (str).

Raises:

MGRSError - Invalid MGRS grid reference, zone, en100k or band.

Overrides: object.__init__

Example:

>>> from pygeodesy import Mgrs
>>> m = Mgrs('31U', 'DQ', 48251, 11932)  # 31U DQ 48251 11932

parse(self, strMGRS)

Parse a string to a MGRS grid reference.

Parameters:

strMGRS - MGRS grid reference (str).

Returns:

MGRS reference (Mgrs).

Raises:

MGRSError - Invalid strMGRS.

See Also: Function parseMGRS in this module mgrs.

toStr(self, prec=10, sep=`'` `'`)

Return a string representation of this MGRS grid reference.

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

Parameters:

prec - Optional number of digits (int), 4:km, 10:m.
sep - Optional separator to join (str).

Returns:

This Mgrs as "00B EN easting northing" (str).

Raises:

ValueError - Invalid prec.

Overrides: named._Named.toStr

Example:

>>> m = Mgrs(31, 'DQ', 48251, 11932, band='U')
>>> m.toStr()  # '31U DQ 48251 11932'

toStr2(self, prec=10, fmt=`'[%s]'`, sep=`',` `'`)

Return a string representation of this MGRS grid reference.

Parameters:

prec - Optional number of digits (int), 4:km, 10:m.
fmt - Optional enclosing backets format (str).
sep - Optional separator between name:values (str).

Returns:

This Mgrs as "[Z:00B, G:EN, E:meter, N:meter]" (str).

Overrides: named._Named.toStr2

toUtm(self, Utm=<class 'pygeodesy.utm.Utm'>)

Convert this MGRS grid reference to a UTM coordinate.

Parameters:

Utm - Optional (sub-)class to return the UTM coordinate (Utm) or None.

Returns:

The UTM coordinate (Utm) or a UtmUps4Tuple

(zone, hemipole, easting, 
          northing)

if Utm is None.

Example:

>>> m = Mgrs('31U', 'DQ', 448251, 11932)
>>> u = m.toUtm()  # 31 N 448251 5411932

Property Details