Package pygeodesy :: Module trf :: Class TransformXform
[frames] | no frames]

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.
 
__eq__(self, other)
Compare this and an other transform.
 
rename(self, name='')
Change this transform and its Xform'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)
Compute the X, Y and Z velocities of this transform.

Inherited from datums.Transform: __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, 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: This TransformXform's name starts with "-" if its Xform was inversed.

__eq__ (self, other)
(Equality operator)

 

Compare this and an other transform.

Arguments:
Returns:
True if equal, False otherwise.
Overrides: datums.Transform.__eq__
(inherited documentation)

rename (self, name='')

 

Change this transform and its Xform's name.

Arguments:
  • name - The new name (str), overriding the base name.
Returns:
The old name (str).
Overrides: 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 - Optional epoch to observe to (scalar).
  • epoch2_inverse - Optional epoch2=None and inverse=False, see TRFXform's method toTransform.
Returns:
The Helmert transform (TransformXform).
Raises:
  • TRFError - Invalid epoch1, epoch2 or missing Xform.

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 - Non-scalar factor.

See Also: Altamimi, 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.