Package pygeodesy :: Module datum :: Class Datum |
[frames] | no frames]

# Class Datum

      object --+
               |
    named._Named --+
                   |
    named._NamedBase --+
                       |
    named._NamedEnumItem --+
                           |
                          Datum

Ellipsoid and transform parameters for an earth model.

Instance Methods
__init__(self, ellipsoid, transform=None, name=`'````'`) New Datum. |
__eq__(self, other) Compare this and an other datum. |
ecef(self, Ecef=None) Return ECEF converter. |
toStr(self, **unused) Return this datum as a string. |
Inherited from `named._NamedEnumItem`: `__ne__`, `unregister` Inherited from `named._NamedBase`: `__repr__`, `__str__`, `others`, `toStr2` Inherited from `named._Named`: `_dot_`, `attrs`, `classof`, `copy` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties
| ellipsoid An immutable property (`Read Only`).
| exactTM An immutable property (`Read Only`).
| isEllipsoidal An immutable property (`Read Only`).
| isSpherical An immutable property (`Read Only`).
| transform An immutable property (`Read Only`).
Inherited from `named._NamedEnumItem`: `name` Inherited from `named._Named`: `classname`, `classnaming`, `named`, `named2` Inherited from `object`: `__class__`

Method Details

### __init__(self, ellipsoid, transform=None, name=`'````'`) (Constructor) |
New Datum. Parameters: `ellipsoid` - The ellipsoid (Ellipsoid). `transform` - Optional transform (Transform). `name` - Optional, unique name (`str`). Raises: `NameError` - Datum with that `name` already exists. `TypeError` - If `ellipsoid` is not an Ellipsoid or `transform` is not a Transform. Overrides: object.__init__

### __eq__(self, other) (Equality operator) |
Compare this and an other datum. Parameters: `other` - The other datum (Datum). Returns: `True` if equal, `False` otherwise.

### ecef(self, Ecef=None) |
Return ECEF converter. Parameters: `Ecef` - ECEF class to use (EcefKarney, EcefVeness or EcefYou). Returns: An ECEF converter for this `datum` (EcefKarney, EcefVeness or EcefYou). Raises: `TypeError` - Invalid `Ecef`.

### toStr(self, **unused) |
Return this datum as a string. Returns: Datum attributes (`str`). Raises: `AssertionError` - Always, see function notOverloaded. Overrides: named._Named.toStr

Property Details

### ellipsoid An immutable property (`Read Only`). Get Method: ellipsoid(self) - Get this datum's ellipsoid (Ellipsoid). Set Method: immutable(inst, value) - Throws an `AttributeError`, always.

### exactTM An immutable property (`Read Only`). Get Method: exactTM(self) - Get the `ExactTM` projection (ExactTransverseMercator). Set Method: immutable(inst, value) - Throws an `AttributeError`, always.

### isEllipsoidal An immutable property (`Read Only`). Get Method: isEllipsoidal(self) - Check whether this datum is ellipsoidal (`bool`). Set Method: immutable(inst, value) - Throws an `AttributeError`, always.

### isSpherical An immutable property (`Read Only`). Get Method: isSpherical(self) - Check whether this datum is spherical (`bool`). Set Method: immutable(inst, value) - Throws an `AttributeError`, always.

### transform An immutable property (`Read Only`). Get Method: transform(self) - Get this datum's transform (Transform). Set Method: immutable(inst, value) - Throws an `AttributeError`, always.