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

# Class RefFrame

      object --+
               |
    named._Named --+
                   |
    named._NamedBase --+
                       |
    named._NamedEnumItem --+
                           |
                          RefFrame

Terrestrial Reference Frame (TRF) parameters.

Instance Methods
__init__(self, epoch, ellipsoid, name='') New RefFrame. |
__matmul__(self, other) Convert cartesian or ellipsoidal `other` to this reframe. |
toStr(self, name='', **unused) Return this reference frame as a text string. |
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__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties
| ellipsoid Get this reference frame's ellipsoid (Ellipsoid or Ellipsoid2).
| epoch Get this reference frame's epoch (`Epoch`).
Inherited from `named._NamedEnumItem`: `name` Inherited from `named._Named`: `classname`, `classnaming`, `iteration`, `named`, `named2`, `named3`, `named4` Inherited from `object`: `__class__`

Method Details

### __init__ (self, epoch, ellipsoid, name='') (Constructor) |
New RefFrame. Arguments: `epoch` - Epoch, a fractional calendar year (`scalar` or `str`). `ellipsoid` - The ellipsoid (Ellipsoid, Ellipsoid2, Datum or a_f2Tuple). `name` - Optional, unique name (`str`). Raises: `NameError` - A RefFrame with that `name` already exists. `TRFError` - Invalid `epoch`. `TypeError` - Invalid `ellipsoid`. Overrides: object.__init__

### __matmul__ (self, other) |
Convert cartesian or ellipsoidal `other` to this reframe. Raises: `TypeError` - Invalid `other`. Overrides: named._Named.__matmul__

### toStr (self, name='', **unused) |
Return this reference frame as a text string. Arguments: `name` - Override name (`str`) or `None` to exclude the reframe's name. Returns: This RefFrame's attributes (`str`). Overrides: named._Named.toStr

Property Details

### ellipsoid Get this reference frame's ellipsoid (Ellipsoid or Ellipsoid2). Get method: ellipsoid(self) - Get this reference frame's ellipsoid (Ellipsoid or Ellipsoid2). Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.

### epoch Get this reference frame's epoch (`Epoch`). Get method: epoch(self) - Get this reference frame's epoch (`Epoch`). Set method: _fset_error(inst, val) - Throws an `AttributeError`, always. Delete Method: _fdel(inst) - Zap the cached/memoized `property` value.