Package pygeodesy :: Module ellipsoidalNvector :: Class Ned |
[frames] | no frames]

# Class Ned

      object --+
               |
    named._Named --+
                   |
                  Ned

North-Eeast-Down (NED), also known as Local Tangent Plane (LTP), is a vector in the local coordinate frame of a body.

Instance Methods
__init__(self, north, east, down, name=`'````'`) New North-East-Down vector. |
__str__(self) str(x) |
to3ned(self) Return this NED vector as north/east/down components. |
toStr(self, prec=3, fmt=`'``[%s]``'`, sep=`'``,` `'`) Return a string representation of this NED vector. |
toStr2(self, prec=None, fmt=`'``[%s]``'`, sep=`'``,` `'`) Return a string representation of this NED vector as length, bearing and elevation. |
toVector3d(self) Return this NED vector as a 3-d vector. |
Inherited from `named._Named`: `__copy__`, `__repr__`, `classof`, `copy` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties
| bearing Get the bearing of this NED vector (compass `degrees360`).
| down Gets the Down component of this NED vector (`meter`).
| east Gets the East component of this NED vector (`meter`).
| elevation Get the elevation, tilt of this NED vector in degrees from horizontal, i.e.
| length Gets the length of this NED vector (`meter`).
| north Gets the North component of this NED vector (`meter`).
Inherited from `named._Named`: `classname`, `classnaming`, `name`, `named`, `named2` Inherited from `object`: `__class__`

Method Details

### __init__(self, north, east, down, name=`'````'`) (Constructor) |
New North-East-Down vector. Parameters: `north` - North component (`meter`). `east` - East component (`meter`). `down` - Down component, normal to the surface of the ellipsoid (`meter`). `name` - Optional name (`str`). Overrides: object.__init__ Example:
    >>> from ellipsiodalNvector import Ned
    >>> delta = Ned(110569, 111297, 1936)
    >>> delta.toStr(prec=0)  #  [N:110569, E:111297, D:1936]

### __str__(self) (Informal representation operator) |
str(x) Overrides: object.__str__ (inherited documentation)

### to3ned(self) |
Return this NED vector as north/east/down components. Returns: An Ned3Tuple`(north, east, down)`.

### toStr(self, prec=3, fmt=`'``[%s]``'`, sep=`'``,` `'`) |
Return a string representation of this NED vector. Parameters: `prec` - Optional number of decimals, unstripped (`int`). `fmt` - Optional enclosing backets format (`str`). `sep` - Optional separator between NEDs (`str`). Returns: This Ned as "[N:f, E:f, D:f]" (`str`).

### toStr2(self, prec=None, fmt=`'``[%s]``'`, sep=`'``,` `'`) |
Return a string representation of this NED vector as length, bearing and elevation. Parameters: `prec` - Optional number of decimals, unstripped (`int`). `fmt` - Optional enclosing backets format (`str`). `sep` - Optional separator between NEDs (`str`). Returns: This Ned as "[L:f, B:degrees360, E:degrees90]" (`str`).

### toVector3d(self) |
Return this NED vector as a 3-d vector. Returns: The vector(north, east, down) (Vector3d).

Property Details

### bearing Get the bearing of this NED vector (compass `degrees360`). Get Method: bearing(self) - Get the bearing of this NED vector (compass `degrees360`). Set Method: Read_Only(self, ignored) - Throws an `AttributeError`, always.

### down Gets the Down component of this NED vector (`meter`). Get Method: down(self) - Gets the Down component of this NED vector (`meter`). Set Method: Read_Only(self, ignored) - Throws an `AttributeError`, always.

### east Gets the East component of this NED vector (`meter`). Get Method: east(self) - Gets the East component of this NED vector (`meter`). Set Method: Read_Only(self, ignored) - Throws an `AttributeError`, always.

### elevation Get the elevation, tilt of this NED vector in degrees from horizontal, i.e. tangent to ellipsoid surface (`degrees90`). Get Method: elevation(self) - Get the elevation, tilt of this NED vector in degrees from horizontal, i.e. Set Method: Read_Only(self, ignored) - Throws an `AttributeError`, always.

### length Gets the length of this NED vector (`meter`). Get Method: length(self) - Gets the length of this NED vector (`meter`). Set Method: Read_Only(self, ignored) - Throws an `AttributeError`, always.

### north Gets the North component of this NED vector (`meter`). Get Method: north(self) - Gets the North component of this NED vector (`meter`). Set Method: Read_Only(self, ignored) - Throws an `AttributeError`, always.