Package pygeodesy :: Module trf :: Class TransformXform

Class TransformXform

  object --+                
           |                
named._Named --+            
               |            
named._NamedBase --+        
                   |        
named._NamedEnumItem --+    
                       |    
        datums.Transform --+
                           |
                          TransformXform

Helmert transformation, extended with an Xform converter.

See Also: Transform and Xform.

Instance Methods

__init__(self, name='', **tx_ty_tz_s_sx_sy_sz)
New TransformXform.

toRefFrame(self, point, epoch=None, **epoch2_datum_name)
Convert a cartesian or geodetic point using this transform and refName1, refName2 and epoch of this transform's Xform.

velocities(self, factor=0.001)
Compute the X, Y and Z velocities of this transform.

Inherited from datums.Transform: __eq__, __hash__, __iter__, __matmul__, __neg__, inverse, items, toStr, transform

Inherited from named._NamedEnumItem: unregister

Inherited from named._NamedBase: __repr__, __str__, others, toRepr

Inherited from named._Named: __imatmul__, __rmatmul__, attrs, classof, copy, dup, methodname, rename, toStr2

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

Class Variables
Inherited from `datums.Transform`: `rx`, `ry`, `rz`, `s`, `s1`, `sx`, `sy`, `sz`, `tx`, `ty`, `tz`

Properties

Xform
Get the Xform of this Helmert (TRFXform or None).

Inherited from datums.Transform: isunity

Inherited from named._NamedEnumItem: name

Inherited from named._Named: classname, classnaming, iteration, named, named2, named3, named4, sizeof

Inherited from object: __class__

Method Details

init (self, name='', **tx_ty_tz_s_sx_sy_sz)
(Constructor)

New TransformXform.

Arguments:

name - Optional name (str), not registered.

Raises:

NameError - Transform with that name already exists.

Overrides: object.__init__

See Also: Transform for details.

Note: The name of this TransformXform starts with "-" if its Xform was applied inversed.

toRefFrame (self, point, epoch=None, **epoch2_datum_name)

Convert a cartesian or geodetic point using this transform and refName1, refName2 and epoch of this transform's Xform.

Arguments:

epoch - Optional epoch ((Epoch, scalar or str)), overriding this transform's Xform's epoch.

Returns:

A copy of the point, converted or renamed.

See Also: Method RefFrame.toRefFrame for more details.

velocities (self, factor=0.001)

Compute the X, Y and Z velocities of this transform.

Arguments:

factor - Factor to scale this Xform's rates (scalar), default from milli-meter- to meter-per-year.

Returns:

A Vector3Tuple(x, y, z) or None.

Raises:

TypeError - Invalid factor.

See Also: Alamimi, Z. "EUREF-TN-1-Jan-31-2024", Appendix A, equation (3).

Property Details

Xform

Get the Xform of this Helmert (TRFXform or None).

Get method:: Xform(self) - Get the Xform of this Helmert (TRFXform or None).
Set method:: Xform(self, Xform) - Set the Xform of this Helmert (TRFXform).
Delete Method:: _fdel(inst) - Zap the cached/memoized property value.

Class TransformXform

__init__ (self, name='', **tx_ty_tz_s_sx_sy_sz) (Constructor)

toRefFrame (self, point, epoch=None, **epoch2_datum_name)

velocities (self, factor=0.001)

Xform

init (self, name='', **tx_ty_tz_s_sx_sy_sz)
(Constructor)