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

# Class Georef

    object --+
             |
    basestring --+
                 |
               str --+
                     |
        object --+   |
                 |   |
      bases._Named --+
                     |
                    Georef

Georef class, sub-class of `str`.

Instance Methods
__repr__(self) repr(x) |
toLatLon(self, LatLon, height=None, **kwds) Return (the center of) this georef cell as an instance of the supplied `LatLon` class. |
Inherited from `str`: `__add__`, `__contains__`, `__eq__`, `__format__`, `__ge__`, `__getattribute__`, `__getitem__`, `__getnewargs__`, `__getslice__`, `__gt__`, `__hash__`, `__le__`, `__len__`, `__lt__`, `__mod__`, `__mul__`, `__ne__`, `__rmod__`, `__rmul__`, `__sizeof__`, `__str__`, `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 `bases._Named`: `copy` 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
| height Get this georef's height in `meter` or `None` if missing.
| latlon Get this georef's (center) lat- and longitude in `degrees`.
| precision Get this georef's precision (`int`).
| radius Get this georef's radius in `meter` or `None` if missing.
Inherited from `bases._Named`: `classname`, `classnaming`, `name` 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`. Parameters: `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. `ValueError` - INValid or non-alphanumeric cll. Overrides: object.__new__

### __repr__(self) (Representation operator) |
repr(x) Overrides: object.__repr__ (inherited documentation)

### toLatLon(self, LatLon, height=None, **kwds) |
Return (the center of) this georef cell as an instance of the supplied `LatLon` class. Parameters: `LatLon` - Class to use (`LatLon`). `height` - Optional height ({meter}). `kwds` - Optional keyword arguments for LatLon. Returns: This georef location (LatLon). Raises: `ValueError` - Invalid LatLon.

Property Details

### 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: Read_Only(self, ignored) - Throws an `AttributeError`, always.

### latlon Get this georef's (center) lat- and longitude in `degrees`. Get Method: latlon(self) - Get this georef's (center) lat- and longitude in `degrees`. Set Method: Read_Only(self, ignored) - Throws an `AttributeError`, always.

### precision Get this georef's precision (`int`). Get Method: precision(self) - Get this georef's precision (`int`). Set Method: Read_Only(self, ignored) - Throws an `AttributeError`, always.

### 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: Read_Only(self, ignored) - Throws an `AttributeError`, always.