Package pygeodesy :: Module wgrs :: Class Georef |
[frames] | no frames]

# Class Georef

      object --+
               |
      basestring --+
                   |
                 str --+
                       |
      object --+       |
               |       |
    named._Named --+   |
                   |   |
    units._NamedUnit --+
                       |
               units.Str --+
                           |
                          Georef

Georef class, a named `str`.

Instance Methods
toLatLon(self, LatLon=None, height=None, **LatLon_kwds) Return (the center of) this georef cell as an instance of the supplied `LatLon` class. |
Inherited from `units.Str`: `__repr__`, `__str__`, `toRepr`, `toStr` Inherited from `str`: `__add__`, `__contains__`, `__eq__`, `__format__`, `__ge__`, `__getattribute__`, `__getitem__`, `__getnewargs__`, `__getslice__`, `__gt__`, `__hash__`, `__le__`, `__len__`, `__lt__`, `__mod__`, `__mul__`, `__ne__`, `__rmod__`, `__rmul__`, `__sizeof__`, `capitalize`, `center`, `count`, `decode`, `encode`, `endswith`, `expandtabs`, `find`, `format`, `index`, `isalnum`, `isalpha`, `isdigit`, `islower`, `isspace`, `istitle`, `isupper`, `join`, `ljust`, `lower`, `lstrip`, `partition`, `replace`, `rfind`, `rindex`, `rjust`, `rpartition`, `rsplit`, `rstrip`, `split`, `splitlines`, `startswith`, `strip`, `swapcase`, `title`, `translate`, `upper`, `zfill` Inherited from `named._Named`: `_DOT_`, `attrs`, `classof`, `copy`, `rename`, `toStr2` Inherited from `object`: `__delattr__`, `__init__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__subclasshook__`

Static Methods
a new object with type S, a subtype of T |
__new__(cls, cll, precision=3, name='') New Georef from an other Georef instance or georef `str` or from a `LatLon` instance or lat-/longitude `str`. |

Properties
| decoded3 Get this georef's attributes (LatLonPrec3Tuple).
| decoded5 Get this georef's attributes (LatLonPrec5Tuple) with height and radius set to `None` if missing.
| height Get this georef's height in `meter` or `None` if missing.
| latlon Get this georef's (center) lat- and longitude (LatLon2Tuple).
| latlonheight Get this georef's (center) lat-, longitude and height (LatLon3Tuple), with height set to `0` if missing.
| precision Get this georef's precision (`int`).
| radius Get this georef's radius in `meter` or `None` if missing.
Inherited from `units._NamedUnit`: `std_repr`, `units` Inherited from `named._Named`: `classname`, `classnaming`, `name`, `named`, `named2`, `named3`, `named4` Inherited from `object`: `__class__`

Method Details

### __new__ (cls, cll, precision=3, name='') Static Method |
New Georef from an other Georef instance or georef `str` or from a `LatLon` instance or lat-/longitude `str`. Arguments: `cll` - Cell or location (Georef or `str`, `LatLon` or `str`). `precision` - Optional, the desired georef resolution and length (`int` 0..11), see function wgrs.encode for more details. `name` - Optional name (`str`). Returns: a new object with type S, a subtype of T New Georef. Raises: `RangeError` - Invalid `cll` lat- or longitude. `TypeError` - Invalid `cll`. `WGRSError` - INValid or non-alphanumeric `cll`. Overrides: object.__new__

### toLatLon (self, LatLon=None, height=None, **LatLon_kwds) |
Return (the center of) this georef cell as an instance of the supplied `LatLon` class. Arguments: `LatLon` - Class to use (`LatLon`) or `None`. `height` - Optional height ({meter}). `LatLon_kwds` - Optional, additional `LatLon` keyword arguments, ignored if `LatLon is None`. Returns: This georef location (`LatLon`) or if `LatLon` is `None`, a LatLon3Tuple`(lat, lon, height)`. Raises: `TypeError` - Invalid `LatLon` or `LatLon_kwds`.

Property Details

### decoded3 Get this georef's attributes (LatLonPrec3Tuple). Get method: decoded3(self) - Get this georef's attributes (LatLonPrec3Tuple). Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### decoded5 Get this georef's attributes (LatLonPrec5Tuple) with height and radius set to `None` if missing. Get method: decoded5(self) - Get this georef's attributes (LatLonPrec5Tuple) with height and radius set to `None` if missing. Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### height Get this georef's height in `meter` or `None` if missing. Get method: height(self) - Get this georef's height in `meter` or `None` if missing. Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### latlon Get this georef's (center) lat- and longitude (LatLon2Tuple). Get method: latlon(self) - Get this georef's (center) lat- and longitude (LatLon2Tuple). Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### latlonheight Get this georef's (center) lat-, longitude and height (LatLon3Tuple), with height set to `0` if missing. Get method: latlonheight(self) - Get this georef's (center) lat-, longitude and height (LatLon3Tuple), with height set to `0` if missing. Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### precision Get this georef's precision (`int`). Get method: precision(self) - Get this georef's precision (`int`). Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### radius Get this georef's radius in `meter` or `None` if missing. Get method: radius(self) - Get this georef's radius in `meter` or `None` if missing. Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.