Namespace inertialsim::geodesy::topocentric¶

Namespace List > inertialsim > geodesy > topocentric

Topocentric coordinate conversions (internal API). More...

Public Functions¶

Type	Name
std::pair< Vector3D, TransformMatrixArray >	FromEcef (const Vector3D & xyz, const TopocentricDatum & datum) Topocentric coordinates from ECEF coordinates.
std::pair< Vector3D, TransformMatrixArray >	FromTopocentric (const Vector3D & ned, const TopocentricDatum & datum) Topocentric coordinates from topocentric coordinates.
Vector3D	Validate (const Vector3D & ned) Validates inputs meet topocentric coordinate conventions.

Detailed Description¶

Internal API

This namespace is part of InertialSim's internal API. Most users should use the Coordinates class and its factory methods rather than calling these functions directly.

See also: Coordinates

Public Functions Documentation¶

function FromEcef¶

Topocentric coordinates from ECEF coordinates.

std::pair< Vector3D , TransformMatrixArray > inertialsim::geodesy::topocentric::FromEcef (
    const  Vector3D & xyz,
    const  TopocentricDatum & datum
)

Parameters:

xyz Earth-centered, Earth-fixed (ECEF) cartesian coordinates (3xN).
datum A datum describing the origin and axis order of the topocentric coordinates.

Returns:

Pair containing:

Topocentric coordinates (NED or ENU)
ECEF-to-topocentric transform matrices

function FromTopocentric¶

Topocentric coordinates from topocentric coordinates.

std::pair< Vector3D , TransformMatrixArray > inertialsim::geodesy::topocentric::FromTopocentric (
    const  Vector3D & ned,
    const  TopocentricDatum & datum
)

Validates the input coordinates and returns identity transforms.

Parameters:

ned Topocentric coordinates (NED or ENU).
datum A datum describing the origin and axis order of the topocentric coordinates.

Returns:

Pair containing:

Validated topocentric coordinates
Identity transform

function Validate¶

Validates inputs meet topocentric coordinate conventions.

Vector3D inertialsim::geodesy::topocentric::Validate (
    const  Vector3D & ned
)

Inputs are validated for shape. The input must be a 3xN matrix where N is the number of coordinate sets.

Parameters:

ned Topocentric coordinates (NED or ENU).

Returns:

Validated coordinates.

Exception:

std::invalid_argument if dimensions are invalid.

The documentation for this class was generated from the following file cpp/include/inertialsim/geodesy/topocentric.h