Package pygeodesy :: Package deprecated :: Class EcefCartesian |
[frames] | no frames]

# Class EcefCartesian

      object --+
               |
    named._Named --+
                   |
    named._NamedBase --+
                       |
      ltp.LocalCartesian --+
                           |
                          EcefCartesian

DEPRECATED, use class LocalCartesian.

Note: This class is named incorrectly, since it provides conversion to and from local cartesian coordinates in a local tangent plane and not geocentric (ECEF) ones, as the name suggests.

Instance Methods
__init__(self, latlonh0=0, lon0=0, height0=0, ecef=None, name='') New LocalCartesian converter. |
forward(self, latlonh, lon=None, height=0, M=False, name='') DEPRECATED, use method LocalCartesian.forward. |
reverse(self, xyz, y=None, z=None, M=False, name='') DEPRECATED, use method LocalCartesian.reverse. |
Inherited from `ltp.LocalCartesian`: `__eq__`, `reset`, `toStr` Inherited from `named._NamedBase`: `__repr__`, `__str__`, `others`, `toRepr` Inherited from `named._Named`: `_DOT_`, `__imatmul__`, `__matmul__`, `__rmatmul__`, `attrs`, `classof`, `copy`, `dup`, `rename`, `toStr2` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties
Inherited from `ltp.LocalCartesian`: `M`, `datum`, `ecef`, `height0`, `lat0`, `lon0` Inherited from `named._Named`: `classname`, `classnaming`, `name`, `named`, `named2`, `named3`, `named4` Inherited from `object`: `__class__`

Method Details

### __init__ (self, latlonh0=0, lon0=0, height0=0, ecef=None, name='') (Constructor) |
New LocalCartesian converter. Arguments: `latlonh0` - Either a `LatLon`, Ltp, Ecef9Tuple or `scalar` latitude of the (goedetic) origin (`degrees`). `lon0` - Optional `scalar` longitude of the (goedetic) origin `scalar` `latlonh0` (`degrees`). `height0` - Optional origin height (`meter`), vertically above (or below) the surface of the ellipsoid. `ecef` - An ECEF converter (EcefKarney). `name` - Optional name (`str`). Raises: `LocalError` - If `latlonh0` not `LatLon`, Ecef9Tuple, `scalar` or invalid or if `lon0` not `scalar` for `scalar` `latlonh0` or invalid or if `height0` invalid. `TypeError` - Invalid `ecef`, not EcefKarney. Overrides: object.__init__ (inherited documentation)

### forward (self, latlonh, lon=None, height=0, M=False, name='') |
DEPRECATED, use method LocalCartesian.forward. Arguments: `latlonh` - Either a `LatLon`, a Ltp, an Ecef9Tuple or `scalar` (geodetic) latitude (`degrees`). `lon` - Optional `scalar` (geodetic) longitude for `scalar` `latlonh` (`degrees`). `height` - Optional height (`meter`), vertically above (or below) the surface of the ellipsoid. `M` - Optionally, return the rotation EcefMatrix (`bool`). `name` - Optional name (`str`). Returns: Incorrectly, an Ecef9Tuple`(x, y, z, lat, lon, height, C, M, datum)` with local `(x, y, z)` coordinates for the given geodetic ones `(lat, lon, height)`, case `C=0` always, optionally concatenated EcefMatrix `M` and `datum`. Decorators: `@deprecated_method` Raises: `LocalError` - If `latlonh` not `scalar`, `LatLon`, Ltp, Ecef9Tuple or invalid or if `lon` not `scalar` for `scalar` `latlonh` or invalid or if `height` invalid. Overrides: ltp.LocalCartesian.forward

### reverse (self, xyz, y=None, z=None, M=False, name='') |
DEPRECATED, use method LocalCartesian.reverse. Arguments: `xyz` - A local (XyzLocal, Enu, Ned, Aer, Local9Tuple) or local `x` coordinate (`scalar`). `y` - Local `y` coordinate for `scalar` `xyz` and `z` (`meter`). `z` - Local `z` coordinate for `scalar` `xyz` and `y` (`meter`). `M` - Optionally, return the concatenated rotation EcefMatrix, iff avaialble (`bool`). `name` - Optional name (`str`). Returns: Incorrectly, an Ecef9Tuple`(x, y, z, lat, lon, height, C, M, datum)` with geodetic coordinates `(lat, lon, height)` for the given local ones `(x, y, z)`, case `C`, optionally concatenated EcefMatrix `M` and `datum`. Decorators: `@deprecated_method` Raises: `LocalError` - Invalid `xyz` or `scalar` `x` or `y` and/or `z` not `scalar` for `scalar` `xyz`. Overrides: ltp.LocalCartesian.reverse