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

# Class Transform

      object --+
               |
    bases._Named --+
                   |
        bases._Based --+
                       |
             _Registered --+
                           |
                          Transform

Helmert transformation.

Instance Methods
__init__(self, name=`'````'`, tx=0, ty=0, tz=0, sx=0, sy=0, sz=0, s=0) New transform. |
__eq__(self, other) Compare this and an other transform. |
copy(self) Copy this transform. |
inverse(self, name=`'````'`) Return the inverse of this transform. |
toStr(self, prec=5) Return this transform as a string. |
transform(self, x, y, z, inverse=False) Transform a (geocentric) Cartesian point, forward or inverse. |
Inherited from `_Registered`: `__ne__`, `unregister` Inherited from `bases._Based`: `__repr__`, `__str__`, `classof`, `others`, `toStr2` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Class Variables
| tx = `0` X translation (`meter`).
| ty = `0` Y translation (`meter`).
| tz = `0` Z translation (`meter`).
| rx = `0` X rotation (`radians`).
| ry = `0` Y rotation (`radians`).
| rz = `0` Z rotation (`radians`).
| s = `0` Scale ppm (`float`).
| s1 = `1` Scale + 1 (`float`).
| sx = `0` X rotation (degree seconds).
| sy = `0` Y rotation (degree seconds).
| sz = `0` Z rotation (degree seconds).

Properties
Inherited from `_Registered`: `name` Inherited from `bases._Named`: `classname`, `classnaming` Inherited from `object`: `__class__`

Method Details

### __init__(self, name=`'````'`, tx=0, ty=0, tz=0, sx=0, sy=0, sz=0, s=0) (Constructor) |
New transform. Parameters: `name` - Optional, unique name (`str`). `tx` - Optional X translation (`meter`). `ty` - Optional Y translation (`meter`). `tz` - Optional Z translation (`meter`). `s` - Optional scale ppm (`float`). `sx` - Optional X rotation (`degree seconds`). `sy` - Optional Y rotation (`degree seconds`). `sz` - Optional Z rotation (`degree seconds`). Raises: `NameError` - Transform with that name already exists. Overrides: object.__init__

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

### copy(self) |
Copy this transform. Returns: The copy, unregistered (Transform or subclass thereof). Overrides: bases._Named.copy

### inverse(self, name=`'````'`) |
Return the inverse of this transform. Parameters: `name` - Optional, unique name (`str`). Returns: Inverse (Transform). Raises: `NameError` - Transform with that name already exists.

### toStr(self, prec=5) |
Return this transform as a string. Parameters: `prec` - Optional number of decimals, unstripped (`int`). Returns: Transform attributes (`str`). Overrides: bases._Based.toStr

### transform(self, x, y, z, inverse=False) |
Transform a (geocentric) Cartesian point, forward or inverse. Parameters: `x` - X coordinate (`meter`). `y` - Y coordinate (`meter`). `z` - Z coordinate (`meter`). `inverse` - Optional direction, forward or inverse (`bool`). Returns: 3-Tuple (x, y, z) transformed.