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

# Class RefFrame

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

Terrestrial Reference Frame (TRF).

Instance Methods
__init__(self, epoch, ellipsoid, name=`'````'`) New RefFrame. |
toStr(self) Return this reference frame as a text string. |
Inherited from `named._NamedEnumItem`: `__ne__`, `unregister` Inherited from `named._NamedBase`: `__repr__`, `__str__`, `others`, `toStr2` Inherited from `named._Named`: `__copy__`, `classof`, `copy` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

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

Method Details

### __init__(self, epoch, ellipsoid, name=`'````'`) (Constructor) |
New RefFrame. Parameters: `epoch` - Epoch, a fractional calendar year (`scalar`). `ellipsoid` - The ellipsoid (Ellipsoid). `name` - Optional, unique name (`str`). Raises: `NameError` - A RefFrame with that `name` already exists. `TypeError` - If `epoch` is not `scalar` or `ellipsoid` is not an Ellipsoid. Overrides: object.__init__

### toStr(self) |
Return this reference frame as a text string. Parameters: `kwds` - Optional, keyword arguments. Returns: This RefFrame's attributes (`str`). Overrides: named._NamedBase.toStr

Property Details

### ellipsoid Get this reference frame's ellipsoid (Ellipsoid). Get Method: ellipsoid(self) - Get this reference frame's ellipsoid (Ellipsoid). Set Method: Read_Only(self, ignored) - Throws an `AttributeError`, always.

### epoch Get this reference frame's epoch (`float`). Get Method: epoch(self) - Get this reference frame's epoch (`float`). Set Method: Read_Only(self, ignored) - Throws an `AttributeError`, always.