Package pygeodesy :: Module trf :: Class TRFXform

Class TRFXform

  object --+    
           |    
named._Named --+
               |
              TRFXform

Terrestrial Reference Frame (TRF) converter between two reference frames observed at an epoch.

Instance Methods

__init__(self, refName1, refName2, epoch=None, xform=None, rates=None, name='')
New trfXform.

__lt__(self, other)

__neg__(self)

__repr__(self)
Default repr(self).

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

toEpoch(self, epoch)
Convert this Xform to epoch, if needed.

toRefFrame(self, point, epoch=None, datum=Datum(name='GRS80', ellipsoid=Ellipsoids.GRS80, transform=Tran..., **epoch2_name)
Convert a cartesian or geodetic point using this Xform's refName1, refName2, epoch and Transform.

toRepr(self, **unused)
Return the represention of this Xform (str).

toStr(self, epoch=None, **unused)
Return this Xform as "fromRef@epoch_toRef" (str).

toTransform(self, epoch1, epoch2=None, inverse=False)
Combine this Xform observed at epoch1 into a Helmert TransformXform, optionally at epoch2 or epoch1.

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

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

Class Variables
	epoch = `epoch (0)`
	refName2 = `''`
	refName1 = `''`
	xform = `TRFXform7Tuple(tx=0.0, ty=0.0, tz=0.0, s=0.0, sx=0.0, ...`
	rates = `TRFXform7Tuple(tx=0.0, ty=0.0, tz=0.0, s=0.0, sx=0.0, ...`

Properties

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

Inherited from object: __class__

Method Details

init (self, refName1, refName2, epoch=None, xform=None, rates=None, name='')
(Constructor)

New trfXform.

Arguments:

refName1 - Source reframe (str), converting from.
refName2 - Destination reframe (str), converting to.
epoch - Epoch, a fractional year (Epoch, scalar or str).
xform - Transform parameters (TRFXform7Tuple).
rates - Rate parameters (TRFXform7Tuple), as xform, but in units-per-year.
name - Optional name (str)

Returns:

The new TRF converter (TRFXform).

Raises:

TRFError - Invalid epoch, xform or rates.

Overrides: object.__init__

repr (self)
(Representation operator)

Default repr(self).

Overrides: object.__repr__: (inherited documentation)

inverse (self, name='')

Return the inverse of this Xform.

Arguments:

name - Optional name (str).

Returns:

Inverse (TRFXform).

toEpoch (self, epoch)

Convert this Xform to epoch, if needed.

Arguments:

epoch - Epoch, fractional year (Epoch, scalar or str).

Returns:

This Xform or a copy converted to epoch.

Raises:

TRFError - Invalid epoch.

toRefFrame (self, point, epoch=None, datum=Datum(name='GRS80', ellipsoid=Ellipsoids.GRS80, transform=Tran`...`, **epoch2_name)

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

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.

toRepr (self, **unused)

Return the represention of this Xform (str).

Overrides: named._Named.toRepr

toStr (self, epoch=None, **unused)

Return this Xform as "fromRef@epoch_toRef" (str).

Arguments:

epoch - Epoch (scalar), overriding this Xform's epoch.

Overrides: named._Named.toStr

toTransform (self, epoch1, epoch2=None, inverse=False)

Combine this Xform observed at epoch1 into a Helmert TransformXform, optionally at epoch2 or epoch1.

Arguments:

epoch1 - Epoch to observe from (scalar).
epoch2 - Optional epoch to observe to (scalar).
inverse - Invert the Helmert tranformation (bool).

Raises:

TRFError - Invalid epoch1 or epoch2.

Note: Translations are converted from milli-meter to meter, shift rates from milli-arc-seconds to arc-seconds and scale from ppb to ppM.

Class Variable Details

xform

Value:

TRFXform7Tuple(tx=0.0, ty=0.0, tz=0.0, s=0.0, sx=0.0, sy=0.0, sz=0.0)

rates

Value:

TRFXform7Tuple(tx=0.0, ty=0.0, tz=0.0, s=0.0, sx=0.0, sy=0.0, sz=0.0)

Class TRFXform

__init__ (self, refName1, refName2, epoch=None, xform=None, rates=None, name='') (Constructor)

__repr__ (self) (Representation operator)

inverse (self, name='')

toEpoch (self, epoch)

toRefFrame (self, point, epoch=None, datum=Datum(name='GRS80', ellipsoid=Ellipsoids.GRS80, transform=Tran..., **epoch2_name)

toRepr (self, **unused)

toStr (self, epoch=None, **unused)

toTransform (self, epoch1, epoch2=None, inverse=False)

xform

rates

init (self, refName1, refName2, epoch=None, xform=None, rates=None, name='')
(Constructor)

repr (self)
(Representation operator)

toRefFrame (self, point, epoch=None, datum=Datum(name='GRS80', ellipsoid=Ellipsoids.GRS80, transform=Tran`...`, **epoch2_name)