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

Class NvectorBase

  object --+            
           |            
named._Named --+        
               |        
named._NamedBase --+    
                   |    
   vector3d.Vector3d --+
                       |
                      NvectorBase
Known Subclasses:

Base class for ellipsoidal and spherical Nvectors.

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.
 
to2ll(self)
DEPRECATED, use property latlon.
 
to3abh(self, height=None)
DEPRECATED, use method philamheight or philam.to3Tuple(height).
 
to3llh(self, height=None)
DEPRECATED, use property latlonheight or latlon.to3Tuple)height).
 
to4xyzh(self, h=None)
DEPRECATED, use property xyzh or xyz.to4Tuple(h).
 
toCartesian(self, h=None, Cartesian=None, datum=None, **Cartesian_kwds)
Convert this n-vector to Nvector-based cartesian (ECEF) coordinates.
 
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.
 
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, iscolinearWith, isequalTo, minus, nearestOn, negate, others, parse, plus, rotate, rotateAround, sum, times, to3xyz, trilaterate3d2

Inherited from named._NamedBase: __repr__, __str__, toRepr

Inherited from named._Named: _DOT_, attrs, classof, copy, rename, toStr2

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Properties
  Ecef
Get the ECEF class (EcefKarney), lazily.
  H
Property to get and set the height prefix (str).
  datum
Get the pass-thru datum (Datum) or None.
  h
Property to get and set the height above surface (meter).
  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)).
  latlonheightdatum
Get the lat-, longitude in degrees with height and datum (LatLon4Tuple(lat, lon, height, datum)).
  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)).
  philamheightdatum
Get the lat-, longitude in radians with height and datum (PhiLam4Tuple(phi, lam, height, datum)).
  xyzh
Get this n-vector's components (Vector4Tuple(x, y, z, h))

Inherited from vector3d.Vector3d: crosserrors, euclid, length, length2, x, xyz, y, z

Inherited from named._Named: classname, classnaming, name, named, named2, named3, named4

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:
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).
Decorators:
  • @deprecated_method
Overrides: vector3d.Vector3d.to2ab

to2ll (self)

 

DEPRECATED, use property latlon.

Returns:
A LatLon2Tuple(lat, lon).
Decorators:
  • @deprecated_method
Overrides: vector3d.Vector3d.to2ll

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).
Decorators:
  • @deprecated_method
Raises:
  • ValueError - Invalid height.

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).
Decorators:
  • @deprecated_method
Raises:
  • ValueError - Invalid height.

to4xyzh (self, h=None)

 

DEPRECATED, use property xyzh or xyz.to4Tuple(h).

Decorators:
  • @deprecated_method

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 datum (Datum), overriding this 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

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:
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

Ecef

Get the ECEF class (EcefKarney), lazily.

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

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.

datum

Get the pass-thru datum (Datum) or None.

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

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.

isEllipsoidal

Check whether this n-vector is ellipsoidal (bool or None if unknown).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

isSpherical

Check whether this n-vector is spherical (bool or None if unknown).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

lam

Get the (geodetic) longitude in radians (float).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

lat

Get the (geodetic) latitude in degrees (float).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

latlon

Get the (geodetic) lat-, longitude in degrees (LatLon2Tuple(lat, lon)).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

latlonheight

Get the (geodetic) lat-, longitude in degrees and height (LatLon3Tuple(lat, lon, height)).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

latlonheightdatum

Get the lat-, longitude in degrees with height and datum (LatLon4Tuple(lat, lon, height, datum)).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

lon

Get the (geodetic) longitude in degrees (float).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

phi

Get the (geodetic) latitude in radians (float).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

philam

Get the (geodetic) lat-, longitude in radians (PhiLam2Tuple(phi, lam)).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

philamheight

Get the (geodetic) lat-, longitude in radians and height (PhiLam3Tuple(phi, lam, height)).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

philamheightdatum

Get the lat-, longitude in radians with height and datum (PhiLam4Tuple(phi, lam, height, datum)).

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)

xyzh

Get this n-vector's components (Vector4Tuple(x, y, z, h))

Get method:
_fget(inst)
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst)