Package pygeodesy :: Module nvectorBase :: Class NvectorBase |
[frames] | no frames]

# Class NvectorBase

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

Known Subclasses:
  - ellipsoidalNvector.Nvector
  - , sphericalNvector.Nvector
  - , _N_vector_

Base class for ellipsoidal and spherical `Nvector`s.

Instance Methods
__init__(self, x, y=None, z=None, h=0, ll=None, datum=None, name=`'````'`) New n-vector normal to the earth's surface. |
hStr(self, prec=-2, m=`'````'`) Return a string for the height `h`. |
to2ab(self) DEPRECATED, use property `philam`. |
to3abh(self, height=None) DEPRECATED, use method `philamheight` or `philam.to3Tuple``(``height``)`. |
toCartesian(self, h=None, Cartesian=None, datum=None, **Cartesian_kwds) Convert this n-vector to `Nvector`-based cartesian (ECEF) coordinates. |
to2ll(self) DEPRECATED, use property `latlon`. |
to3llh(self, height=None) DEPRECATED, use property `latlonheight` or `latlon.to3Tuple``)``height``)`. |
toLatLon(self, height=None, LatLon=None, datum=None, **LatLon_kwds) Convert this n-vector to an `Nvector`-based geodetic point. |
toStr(self, prec=5, fmt=`'``(%s)``'`, sep=`'``,` `'`) Return a string representation of this n-vector. |
toVector3d(self, norm=True) Convert this n-vector to a 3-D vector, ignoring the height. |
to4xyzh(self, h=None) DEPRECATED, use property `xyzh` or `xyz.to4Tuple``(``h``)`. |
unit(self, ll=None) Normalize this n-vector to unit length. |
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`, `to3xyz` Inherited from `named._NamedBase`: `__repr__`, `__str__`, `toRepr` Inherited from `named._Named`: `_dot_`, `attrs`, `classof`, `copy`, `toStr2` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties
| datum Get the pass-thru datum (`Datum`) or `None`.
| Ecef Get the ECEF class (EcefKarney or EcefVeness).
| h Property to get and set the height above surface (`meter`).
| H Property to get and set the height prefix (`str`).
| isEllipsoidal Check whether this n-vector is ellipsoidal (`bool` or `None` if unknown).
| isSpherical Check whether this n-vector is spherical (`bool` or `None` if unknown).
| lam Get the (geodetic) longitude in `radians` (`float`).
| lat Get the (geodetic) latitude in `degrees` (`float`).
| latlon Get the (geodetic) lat-, longitude in `degrees` (LatLon2Tuple`(lat, lon)`).
| latlonheight Get the (geodetic) lat-, longitude in `degrees` and height (LatLon3Tuple`(lat, lon, height)`).
| lon Get the (geodetic) longitude in `degrees` (`float`).
| phi Get the (geodetic) latitude in `radians` (`float`).
| philam Get the (geodetic) lat-, longitude in `radians` (PhiLam2Tuple`(phi, lam)`).
| philamheight Get the (geodetic) lat-, longitude in `radians` and height (PhiLam3Tuple`(phi, lam, height)`).
| xyzh Get this n-vector's components (Vector4Tuple`(x, y, z, h)`)
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, x, y=None, z=None, h=0, ll=None, datum=None, name=`'````'`) (Constructor) |
New n-vector normal to the earth's surface. Arguments: `x` - An `Nvector`, Vector3Tuple, Vector4Tuple or the `X` coordinate (`scalar`). `y` - The `Y` coordinate (`scalar`) if `x` `scalar`. `z` - The `Z` coordinate (`scalar`) if `x` `scalar`. `h` - Optional height above surface (`meter`). `ll` - Optional, original latlon (`LatLon`). `datum` - Optional, pass-thru datum (`Datum`). `name` - Optional name (`str`). Raises: `TypeError` - Non-scalar `x`, `y` or `z` coordinate or `x` not an `Nvector`, Vector3Tuple or Vector4Tuple. Overrides: object.__init__ Example:
    >>> from pygeodesy.sphericalNvector import Nvector
    >>> v = Nvector(0.5, 0.5, 0.7071, 1)
    >>> v.toLatLon()  # 45.0°N, 045.0°E, +1.00m

### hStr (self, prec=-2, m=`'````'`) |
Return a string for the height `h`. Arguments: `prec` - Optional number of decimals, unstripped (`int`). `m` - Optional unit of the height (`str`). See Also: Function hstr.

### to2ab (self) |
DEPRECATED, use property `philam`. Returns: A PhiLam2Tuple`(phi, lam)`. Overrides: vector3d.Vector3d.to2ab

### to3abh (self, height=None) |
DEPRECATED, use method `philamheight` or `philam.to3Tuple``(``height``)`. Arguments: `height` - Optional height, overriding this n-vector's height (`meter`). Returns: A PhiLam3Tuple`(phi, lam, height)`. Raises: `ValueError` - Invalid `height`.

### toCartesian (self, h=None, Cartesian=None, datum=None, **Cartesian_kwds) |
Convert this n-vector to `Nvector`-based cartesian (ECEF) coordinates. Arguments: `h` - Optional height, overriding this n-vector's height (`meter`). `Cartesian` - Optional class to return the (ECEF) coordinates (`Cartesian`). `datum` - Optional, spherical datum (`Datum`). `Cartesian_kwds` - Optional, additional `Cartesian` keyword arguments, ignored if `Cartesian=None`. Returns: The cartesian (ECEF) coordinates (`Cartesian`) or if `Cartesian` is `None`, an Ecef9Tuple`(x, y, z, lat, lon, height, C, M, datum)` with `C` and `M` if available. Raises: `TypeError` - Invalid `Cartesian`. `ValueError` - Invalid `h`. Example:
    >>> v = Nvector(0.5, 0.5, 0.7071)
    >>> c = v.toCartesian()  # [3194434, 3194434, 4487327]
    >>> p = c.toLatLon()  # 45.0°N, 45.0°E

### to2ll (self) |
DEPRECATED, use property `latlon`. Returns: A LatLon2Tuple`(lat, lon)`. Overrides: vector3d.Vector3d.to2ll

### to3llh (self, height=None) |
DEPRECATED, use property `latlonheight` or `latlon.to3Tuple``)``height``)`. Arguments: `height` - Optional height, overriding this n-vector's height (`meter`). Returns: A LatLon3Tuple`(lat, lon, height)`. Raises: `ValueError` - Invalid `height`.

### toLatLon (self, height=None, LatLon=None, datum=None, **LatLon_kwds) |
Convert this n-vector to an `Nvector`-based geodetic point. Arguments: `height` - Optional height, overriding this n-vector's height (`meter`). `LatLon` - Optional class to return the geodetic point (`LatLon`) or `None`. `datum` - Optional, spherical datum (`Datum`). `LatLon_kwds` - Optional, additional `LatLon` keyword arguments, ignored if `LatLon=None`. Returns: The geodetic point (`LatLon`) or if `LatLon` is is `None`, an Ecef9Tuple`(x, y, z, lat, lon, height, C, M, datum)` with `C` and `M` if available. Raises: `TypeError` - Invalid `LatLon`. `ValueError` - Invalid `height`. Example:
    >>> v = Nvector(0.5, 0.5, 0.7071)
    >>> p = v.toLatLon()  # 45.0°N, 45.0°E

### toStr (self, prec=5, fmt=`'``(%s)``'`, sep=`'``,` `'`) |
Return a string representation of this n-vector. Height component is only included if non-zero. Arguments: `prec` - Optional number of decimals, unstripped (`int`). `fmt` - Optional enclosing backets format (`str`). `sep` - Optional separator between components (`str`). Returns: Comma-separated `"(x, y, z [, h])"` enclosed in `fmt` brackets (`str`). Raises: `_AssertionError` - Always, see function notOverloaded. Overrides: named._Named.toStr Example:
    >>> Nvector(0.5, 0.5, 0.7071).toStr()  # (0.5, 0.5, 0.7071)
    >>> Nvector(0.5, 0.5, 0.7071, 1).toStr(-3)  # (0.500, 0.500, 0.707, +1.00)

### toVector3d (self, norm=True) |
Convert this n-vector to a 3-D vector, ignoring the height. Arguments: `norm` - Normalize the 3-D vector (`bool`). Returns: The (normalized) vector (Vector3d).

### unit (self, ll=None) |
Normalize this n-vector to unit length. Arguments: `ll` - Optional, original latlon (`LatLon`). Returns: Normalized vector (`Nvector`). Overrides: vector3d.Vector3d.unit

Property Details

### datum Get the pass-thru datum (`Datum`) or `None`. Get method: datum(self) - Get the pass-thru datum (`Datum`) or `None`. Set method: immutable(inst, value) - Throws an `AttributeError`, always.

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

### h Property to get and set the height above surface (`meter`). Get method: h(self) - Get the height above surface (`meter`). Set method: h(self, h) - Set the height above surface.

### H Property to get and set the height prefix (`str`). Get method: H(self) - Get the height prefix (`str`). Set method: H(self, H) - Set the height prefix.

### isEllipsoidal Check whether this n-vector is ellipsoidal (`bool` or `None` if unknown). Get method: isEllipsoidal(self) - Check whether this n-vector is ellipsoidal (`bool` or `None` if unknown). Set method: immutable(inst, value) - Throws an `AttributeError`, always.

### isSpherical Check whether this n-vector is spherical (`bool` or `None` if unknown). Get method: isSpherical(self) - Check whether this n-vector is spherical (`bool` or `None` if unknown). Set method: immutable(inst, value) - Throws an `AttributeError`, always.

### lam Get the (geodetic) longitude in `radians` (`float`). Get method: lam(self) - Get the (geodetic) longitude in `radians` (`float`). Set method: immutable(inst, value) - Throws an `AttributeError`, always.

### lat Get the (geodetic) latitude in `degrees` (`float`). Get method: lat(self) - Get the (geodetic) latitude in `degrees` (`float`). Set method: immutable(inst, value) - Throws an `AttributeError`, always.

### latlon Get the (geodetic) lat-, longitude in `degrees` (LatLon2Tuple`(lat, lon)`). Get method: latlon(self) - Get the (geodetic) lat-, longitude in `degrees` (LatLon2Tuple`(lat, lon)`). Set method: immutable(inst, value) - Throws an `AttributeError`, always.

### latlonheight Get the (geodetic) lat-, longitude in `degrees` and height (LatLon3Tuple`(lat, lon, height)`). Get method: latlonheight(self) - Get the (geodetic) lat-, longitude in `degrees` and height (LatLon3Tuple`(lat, lon, height)`). Set method: immutable(inst, value) - Throws an `AttributeError`, always.

### lon Get the (geodetic) longitude in `degrees` (`float`). Get method: lon(self) - Get the (geodetic) longitude in `degrees` (`float`). Set method: immutable(inst, value) - Throws an `AttributeError`, always.

### phi Get the (geodetic) latitude in `radians` (`float`). Get method: phi(self) - Get the (geodetic) latitude in `radians` (`float`). Set method: immutable(inst, value) - Throws an `AttributeError`, always.

### philam Get the (geodetic) lat-, longitude in `radians` (PhiLam2Tuple`(phi, lam)`). Get method: philam(self) - Get the (geodetic) lat-, longitude in `radians` (PhiLam2Tuple`(phi, lam)`). Set method: immutable(inst, value) - Throws an `AttributeError`, always.

### philamheight Get the (geodetic) lat-, longitude in `radians` and height (PhiLam3Tuple`(phi, lam, height)`). Get method: philamheight(self) - Get the (geodetic) lat-, longitude in `radians` and height (PhiLam3Tuple`(phi, lam, height)`). Set method: immutable(inst, value) - Throws an `AttributeError`, always.

### xyzh Get this n-vector's components (Vector4Tuple`(x, y, z, h)`) Get method: xyzh(self) - Get this n-vector's components (Vector4Tuple`(x, y, z, h)`) Set method: immutable(inst, value) - Throws an `AttributeError`, always.