Package pygeodesy :: Module ellipsoidalBase :: Class CartesianEllipsoidalBase |
[frames] | no frames]

# Class CartesianEllipsoidalBase

           object --+
                    |
         named._Named --+
                        |
         named._NamedBase --+
                            |
    vector3dBase.Vector3dBase --+
                                |
                vector3d.Vector3d --+
                                    |
          cartesianBase.CartesianBase --+
                                        |
                                       CartesianEllipsoidalBase

Known Subclasses:
  - ellipsoidalExact.Cartesian
  - , ellipsoidalGeodSolve.Cartesian
  - , ellipsoidalKarney.Cartesian
  - , ellipsoidalNvector.Cartesian
  - , ellipsoidalVincenty.Cartesian

(INTERNAL) Base class for ellipsoidal `Cartesian`s.

Instance Methods
convertRefFrame(self, reframe2, reframe, epoch=None) DEPRECATED, use method toRefFrame. |
intersections2(self, radius, center2, radius2, sphere=True, Vector=None, **Vector_kwds) Compute the intersection of two spheres or circles, each defined by a cartesian center point and a radius. |
toRefFrame(self, reframe2, reframe=None, epoch=None) Convert this cartesian point from one to an other reference frame. |
toTransforms_(self, *transforms, **datum) Apply none, one or several Helmert transforms. |
Inherited from `cartesianBase.CartesianBase`: `__init__`, `cassini`, `collins`, `collins5`, `convertDatum`, `destinationXyz`, `hartzell`, `height4`, `pierlot`, `tienstra`, `tienstra7`, `to2ab`, `to2ll`, `to3llh`, `toDatum`, `toEcef`, `toLatLon`, `toLocal`, `toLtp`, `toNvector`, `toStr`, `toTransform`, `toVector` Inherited from `vector3d.Vector3d`: `bearing`, `circin6`, `circum3`, `circum4_`, `iscolinearWith`, `meeus2`, `nearestOn`, `nearestOn6`, `parse`, `radii11`, `soddy4`, `trilaterate2d2`, `trilaterate3d2` Inherited from `vector3dBase.Vector3dBase`: `__abs__`, `__add__`, `__bool__`, `__ceil__`, `__cmp__`, `__div__`, `__divmod__`, `__eq__`, `__float__`, `__floor__`, `__floordiv__`, `__format__`, `__ge__`, `__gt__`, `__hash__`, `__iadd__`, `__idiv__`, `__ifloordiv__`, `__imatmul__`, `__imod__`, `__imul__`, `__int__`, `__ipow__`, `__isub__`, `__itruediv__`, `__le__`, `__long__`, `__lt__`, `__matmul__`, `__mod__`, `__mul__`, `__ne__`, `__neg__`, `__nonzero__`, `__pos__`, `__pow__`, `__radd__`, `__rdiv__`, `__rdivmod__`, `__rfloordiv__`, `__rmatmul__`, `__rmod__`, `__rmul__`, `__round__`, `__rpow__`, `__rsub__`, `__rtruediv__`, `__sizeof__`, `__sub__`, `__truediv__`, `__trunc__`, `angleTo`, `apply`, `cmp`, `cross`, `dividedBy`, `dot`, `equals`, `equirectangular`, `intermediateTo`, `isconjugateTo`, `isequalTo`, `minus`, `minus_`, `negate`, `others`, `plus`, `plus_`, `rotate`, `rotateAround`, `sum`, `times`, `times_`, `to3xyz`, `unit` Inherited from `named._NamedBase`: `__repr__`, `__str__`, `toRepr` Inherited from `named._Named`: `attrs`, `classof`, `copy`, `dup`, `methodname`, `rename`, `toStr2` Inherited from `object`: `__delattr__`, `__getattribute__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__subclasshook__`

Properties
| reframe Class `property` with retrievable name.
Inherited from `cartesianBase.CartesianBase`: `Ecef`, `datum`, `height`, `isEllipsoidal`, `isSpherical`, `latlon`, `latlonheight`, `latlonheightdatum`, `philam`, `philamheight`, `philamheightdatum` Inherited from `vector3dBase.Vector3dBase`: `crosserrors`, `euclid`, `length`, `length2`, `x`, `x2y2z2`, `xyz`, `y`, `z` Inherited from `named._Named`: `classname`, `classnaming`, `iteration`, `name`, `named`, `named2`, `named3`, `named4` Inherited from `object`: `__class__`

Method Details

### convertRefFrame (self, reframe2, reframe, epoch=None) |
DEPRECATED, use method toRefFrame. Decorators: `@deprecated_method`

### intersections2 (self, radius, center2, radius2, sphere=True, Vector=None, **Vector_kwds) |
Compute the intersection of two spheres or circles, each defined by a cartesian center point and a radius. Arguments: `radius` - Radius of this sphere or circle (same units as this point's coordinates). `center2` - Center of the second sphere or circle (`Cartesian`, Vector3d, `Vector3Tuple` or `Vector4Tuple`). `radius2` - Radius of the second sphere or circle (same units as this and the `other` point's coordinates). `sphere` - If `True` compute the center and radius of the intersection of two spheres. If `False`, ignore the `z`-component and compute the intersection of two circles (`bool`). `Vector` - Class to return intersections (`Cartesian`, Vector3d or `Vector3Tuple`) or `None` for an instance of this (sub-)class. `Vector_kwds` - Optional, additional `Vector` keyword arguments, ignored if `Vector is None`. Returns: If `sphere` is `True`, a 2-tuple of the `center` and `radius` of the intersection of the spheres. The `radius` is `0.0` for abutting spheres (and the `center` is aka radical center). If `sphere` is `False`, a 2-tuple with the two intersection points of the circles. For abutting circles, both points are the same instance, aka radical center. Raises: `IntersectionError` - Concentric, invalid or non-intersecting spheres or circles. `TypeError` - Invalid `center2`. `UnitError` - Invalid `radius` or `radius2`. See Also: Sphere-Sphere, Circle-Circle Intersection and function pygeodesy.radical2.

### toRefFrame (self, reframe2, reframe=None, epoch=None) |
Convert this cartesian point from one to an other reference frame. Arguments: `reframe2` - Reference frame to convert to (RefFrame). `reframe` - Reference frame to convert from (RefFrame), overriding this cartesian's `reframe`. `epoch` - Optional epoch to observe (`scalar`, fractional calendar year), overriding `reframe`'s epoch. Returns: The converted point (`Cartesian`) or this point if conversion is `nil`. Raises: `TRFError` - No conversion available from `reframe` to `reframe2` or invalid `epoch`. `TypeError` - `reframe2` or `reframe` not a RefFrame.

### toTransforms_ (self, *transforms, **datum) |
Apply none, one or several Helmert transforms. Arguments: `transforms` - Transforms to apply, in order (Transforms). `datum` - Datum for the transformed point (Datum), overriding this point's datum. Returns: The transformed point (`Cartesian`) or this point if the `transforms` produce the same point.

Property Details

### reframe Class `property` with retrievable name. Get method: reframe(self) - Get this cartesian's reference frame (RefFrame) or `None`. Set method: reframe(self, reframe) - Set or clear this cartesian's reference frame (RefFrame) or `None`.