Package pygeodesy :: Module cartesianBase :: Class CartesianBase |
[frames] | no frames]

# Class CartesianBase

      object --+
               |
    named._Named --+
                   |
    named._NamedBase --+
                       |
       vector3d.Vector3d --+
                           |
                          CartesianBase

Known Subclasses:
  - ellipsoidalBase.CartesianEllipsoidalBase
  - , sphericalBase.CartesianSphericalBase

(INTERNAL) Base class for ellipsoidal and spherical `Cartesian`.

Instance Methods
__init__(self, xyz, y=None, z=None, datum=None, ll=None, name=`'````'`) New `Cartesian...`. |
convertDatum(self, datum2, datum=None) Convert this cartesian from one datum to an other. |
to3llh(self, datum=None) DEPRECATED, use property `latlonheightdatum` or property `latlonheight`. |
toEcef(self) Convert this cartesian to geodetic (lat-/longitude) coordinates. |
toLatLon(self, datum=None, LatLon=None, **kwds) Convert this cartesian to a geodetic (lat-/longitude) point. |
toNvector(self, Nvector=None, datum=None, **kwds) Convert this cartesian to `n-vector` components. |
toStr(self, prec=3, fmt=`'``[%s]``'`, sep=`'``,` `'`) Return the string representation of this cartesian. |
toVector(self, Vector=None, **kwds) Return this cartesian's components as vector. |
Inherited from `vector3d.Vector3d`: `__abs__`, `__add__`, `__cmp__`, `__div__`, `__eq__`, `__ge__`, `__gt__`, `__le__`, `__lt__`, `__matmul__`, `__mul__`, `__ne__`, `__neg__`, `__pos__`, `__radd__`, `__rmatmul__`, `__rsub__`, `__sub__`, `__truediv__`, `angleTo`, `cmp`, `cross`, `dividedBy`, `dot`, `equals`, `isequalTo`, `minus`, `negate`, `others`, `parse`, `plus`, `rotate`, `rotateAround`, `sum`, `times`, `to2ab`, `to2ll`, `to3xyz`, `unit` Inherited from `named._NamedBase`: `__repr__`, `__str__`, `toStr2` Inherited from `named._Named`: `_dot_`, `attrs`, `classof`, `copy` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties
| Ecef An immutable property (`Read Only`).
| datum Property to get and set this cartesian's datum (Datum).
| isEllipsoidal An immutable property (`Read Only`).
| isSpherical An immutable property (`Read Only`).
| latlon An immutable property (`Read Only`).
| latlonheight An immutable property (`Read Only`).
| latlonheightdatum An immutable property (`Read Only`).
| philam An immutable property (`Read Only`).
| philamheight An immutable property (`Read Only`).
| philamheightdatum An immutable property (`Read Only`).
Inherited from `vector3d.Vector3d`: `crosserrors`, `length`, `x`, `xyz`, `y`, `z` Inherited from `named._Named`: `classname`, `classnaming`, `name`, `named`, `named2` Inherited from `object`: `__class__`

Method Details

### __init__(self, xyz, y=None, z=None, datum=None, ll=None, name=`'````'`) (Constructor) |
New `Cartesian...`. Parameters: `xyz` - An Ecef9Tuple, Vector3Tuple, Vector4Tuple or the `X` coordinate (`scalar`). `y` - The `Y` coordinate (`scalar`) if `xyz` `scalar`. `z` - The `Z` coordinate (`scalar`) if `xyz` `scalar`. `datum` - Optional datum (Datum). `ll` - Optional, original latlon (`LatLon`). `name` - Optional name (`str`). Raises: `TypeError` - Non-scalar `xyz`, `y` or `z` coordinate or `xyz` not an Ecef9Tuple, Vector3Tuple or Vector4Tuple. Overrides: object.__init__

### convertDatum(self, datum2, datum=None) |
Convert this cartesian from one datum to an other. Parameters: `datum2` - Datum to convert to (Datum). `datum` - Datum to convert from (Datum). Returns: The converted point (`Cartesian`). Raises: `TypeError` - `datum2` or `datum` not a Datum.

### to3llh(self, datum=None) |
DEPRECATED, use property `latlonheightdatum` or property `latlonheight`. Returns: A LatLon4Tuple`(lat, lon, height, datum)`. Note: This method returns a `-4Tuple` and not a `-3Tuple` as its name suggests.

### toEcef(self) |
Convert this cartesian to geodetic (lat-/longitude) coordinates. Returns: An Ecef9Tuple`(x, y, z, lat, lon, height, C, M, datum)` with `C` and `M` if available. Raises: `EcefError` - A `.datum` or an ECEF issue.

### toLatLon(self, datum=None, LatLon=None, **kwds) |
Convert this cartesian to a geodetic (lat-/longitude) point. Parameters: `datum` - Optional datum (Datum) or `None`. `LatLon` - Optional (sub-)class to return the geodetic point (`LatLon`) or `None`. `kwds` - Optional, additional `LatLon` keyword arguments, ignored if `LatLon=None`. Returns: The `LatLon` point or if `LatLon=None`, an Ecef9Tuple`(x, y, z, lat, lon, height, C, M, datum)` with `C` and `M` if available. Raises: `TypeError` - Invalid `datum` or `kwds`.

### toNvector(self, Nvector=None, datum=None, **kwds) |
Convert this cartesian to `n-vector` components. Parameters: `Nvector` - Optional (sub-)class to return the `n-vector` components (`Nvector`) or `None`. `datum` - Optional datum (Datum) overriding this cartesian's datum. `kwds` - Optional, additional `Nvector` keyword arguments, ignored if `Nvector=None`. Returns: Unit vector `Nvector` or a Vector4Tuple`(x, y, z, h)` if `Nvector`=None. Raises: `ValueError` - The `Cartesian` at origin. Example:
    >>> c = Cartesian(3980581, 97, 4966825)
    >>> n = c.toNvector()  # (x=0.622818, y=0.00002, z=0.782367, h=0.242887)

### toStr(self, prec=3, fmt=`'``[%s]``'`, sep=`'``,` `'`) |
Return the string representation of this cartesian. Parameters: `prec` - Optional number of decimals, unstripped (`int`). `fmt` - Optional enclosing backets format (string). `sep` - Optional separator to join (string). Returns: Cartesian represented as "[x, y, z]" (string). Raises: `AssertionError` - Always, see function notOverloaded. Overrides: named._Named.toStr

### toVector(self, Vector=None, **kwds) |
Return this cartesian's components as vector. Parameters: `Vector` - Optional (sub-)class to return the `n-vector` components (Vector3d) or `None`. `kwds` - Optional, additional `Vector` keyword arguments, ignored if `Vector=None`. Returns: A `Vector` or an Vector3Tuple`(x, y, z)` if `Vector=None`. Raises: `TypeError` - Invalid `Vector` or `kwds`.

Property Details

### Ecef An immutable property (`Read Only`). Get Method: Ecef(self) - Get the ECEF class (EcefKarney or EcefVeness). Set Method: immutable(inst, value) - Throws an `AttributeError`, always.

### datum Property to get and set this cartesian's datum (Datum). Get Method: datum(self) - Get this cartesian's datum (Datum). Set Method: datum(self, datum) - Set this cartesian's `datum` without conversion.

### isEllipsoidal An immutable property (`Read Only`). Get Method: isEllipsoidal(self) - Check whether this cartesian is ellipsoidal (`bool` or `None` if unknown). Set Method: immutable(inst, value) - Throws an `AttributeError`, always.

### isSpherical An immutable property (`Read Only`). Get Method: isSpherical(self) - Check whether this cartesian is spherical (`bool` or `None` if unknown). Set Method: immutable(inst, value) - Throws an `AttributeError`, always.

### latlon An immutable property (`Read Only`). Get Method: latlon(self) - Get this cartesian's (geodetic) lat- and longitude in `degrees` (LatLon2Tuple`(lat, lon)`). Set Method: immutable(inst, value) - Throws an `AttributeError`, always.

### latlonheight An immutable property (`Read Only`). Get Method: latlonheight(self) - Get this cartesian's (geodetic) lat-, longitude in `degrees` with height (LatLon3Tuple`(lat, lon, height)`). Set Method: immutable(inst, value) - Throws an `AttributeError`, always.

### latlonheightdatum An immutable property (`Read Only`). Get Method: latlonheightdatum(self) - Get this cartesian's (geodetic) lat-, longitude in `degrees` with height and datum (LatLon4Tuple`(lat, lon, height, datum)`). Set Method: immutable(inst, value) - Throws an `AttributeError`, always.

### philam An immutable property (`Read Only`). Get Method: philam(self) - Get this cartesian's (geodetic) lat- and longitude in `radians` (PhiLam2Tuple`(phi, lam)`). Set Method: immutable(inst, value) - Throws an `AttributeError`, always.

### philamheight An immutable property (`Read Only`). Get Method: philamheight(self) - Get this cartesian's (geodetic) lat-, longitude in `radians` with height (PhiLam3Tuple`(phi, lam, height)`). Set Method: immutable(inst, value) - Throws an `AttributeError`, always.

### philamheightdatum An immutable property (`Read Only`). Get Method: philamheightdatum(self) - Get this cartesian's (geodetic) lat-, longitude in `radians` with height and datum (PhiLam4Tuple`(phi, lam, height, datum)`). Set Method: immutable(inst, value) - Throws an `AttributeError`, always.