Package pygeodesy3 :: Package earth :: Module trf :: Class TransformXform

Class TransformXform

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

Helmert transformation, extended with an Xform TRF converter.

See Also: Transform and Xform.

Instance Methods

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

__eq__(self, other)
Compare this and an other transform.

__hash__(self)
hash(x)

inverse(self, name='')
Return the inverse of this transform.

rename(self, name='')
Change this transform's name.

toRefFrame(self, point, name='')
Convert an ellipsoidal point using this transform and Xform.

toTransform(self, epoch1, **epoch2_inverse)
Return this transform observed at epoch1 as a Helmert TransformXform, optionally at epoch2 or epoch1.

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

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

Inherited from miscs.named._NamedEnumItem: unregister

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

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

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
Class property with retrievable name.

Inherited from datums.Transform: isunity

Inherited from miscs.named._NamedEnumItem: name

Inherited from miscs.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: This TransformXform's name starts with "-" iff inversed.

eq (self, other)
(Equality operator)

Compare this and an other transform.

Arguments:

other - The other transform (Transform).

Returns:

True if equal, False otherwise.

Overrides: datums.Transform.__eq__

(inherited documentation)

hash (self)
(Hashing function)

hash(x)

Overrides: object.__hash__: (inherited documentation)

inverse (self, name='')

Return the inverse of this transform.

Arguments:

name - Optional, unique name (str).

Returns:

Inverse (TransformXform), unregistered.

Overrides: datums.Transform.inverse

rename (self, name='')

Change this transform's name.

Arguments:

name - New name (str), overriding this transform's Xform's name.

Returns:

The previous name (str).

Overrides: miscs.named._Named.rename

toRefFrame (self, point, name='')

Convert an ellipsoidal point using this transform and Xform.

Arguments:

point - The point to convert (Cartesian or LatLon).

Returns:

A copy of the point, converted directly to this transform's Xform's refName2 and epoch.

Note: The point's original reframe and epoch are ignored, its datum and height are preserved but not taken into account.

toTransform (self, epoch1, **epoch2_inverse)

Return this transform observed at epoch1 as a Helmert TransformXform, optionally at epoch2 or epoch1.

Arguments:

epoch1 - Epoch to observe from (scalar).
epoch2_inverse - Optional epoch2=None to observe to and inverse=False, see method toTransform from TRFXform.

Returns:

The Helmert transform (TransformXform).

Raises:

TRFError - Invalid epoch1, epoch2 or missing Xform.

velocities (self, factor=0.001, **Vector_and_kwds)

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.
Vector_and_kwds - An optional, (3-D) Vector=None or cartesian class and additional Vector keyword arguments to return the velocities.

Returns:

A Vector3Tuple(x, y, z) unless some Vector_and_kwds are specified or None if this transform's Xform is missing.

Raises:

TypeError - Non-scalar factor.

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

Property Details

Xform

Class property with retrievable name.

Get method:: Xform(self) - Get this Helmert transform's Xform (TRFXform or None).
Set method:: Xform(self, Xform) - Set this Helmert transform's Xform (TRFXform).

Class TransformXform

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

__eq__ (self, other) (Equality operator)

__hash__ (self) (Hashing function)

inverse (self, name='')

rename (self, name='')

toRefFrame (self, point, name='')

toTransform (self, epoch1, **epoch2_inverse)

velocities (self, factor=0.001, **Vector_and_kwds)

Xform

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

eq (self, other)
(Equality operator)

hash (self)
(Hashing function)