Sidereon.FrameCatalog (Sidereon v0.17.0)

Copy Markdown View Source

Epoch-aware terrestrial reference-frame transforms.

The built-in catalog contains published 14-parameter Helmert transforms for ITRF and ETRF realizations. Positions are geocentric Cartesian metres, velocities are metres per year, and epochs are decimal years.

Summary

Types

error_reason()

Frame catalog error detail.

Functions

catalog()

Return all built-in Helmert catalog entries.

catalog_entry(from, to)

Return the direct published catalog entry for from to to.

propagate_position(position_m, velocity_m_per_year, from_epoch_year, to_epoch_year)

Propagate a station position from one decimal-year epoch to another.

transform(position_m, velocity_m_per_year, from, to, epoch_year)

Transform a Cartesian station position and optional velocity between frames.

transform_from_epoch(position_m, velocity_m_per_year, position_epoch_year, from, to, transform_epoch_year)

Propagate a station to transform_epoch_year, then transform it between frames.

Types

error_reason()

@type error_reason() :: :invalid_frame | map()

Frame catalog error detail.

Functions

catalog()

@spec catalog() :: [Sidereon.FrameCatalog.HelmertTransform.t()]

Return all built-in Helmert catalog entries.

catalog_entry(from, to)

@spec catalog_entry(
  Sidereon.FrameCatalog.TerrestrialFrame.t(),
  Sidereon.FrameCatalog.TerrestrialFrame.t()
) ::
  {:ok, Sidereon.FrameCatalog.HelmertTransform.t()} | {:error, error_reason()}

Return the direct published catalog entry for from to to.

propagate_position(position_m, velocity_m_per_year, from_epoch_year, to_epoch_year)

@spec propagate_position(Sidereon.vec3(), Sidereon.vec3(), number(), number()) ::
  {:ok, Sidereon.vec3()} | {:error, error_reason()}

Propagate a station position from one decimal-year epoch to another.

transform(position_m, velocity_m_per_year, from, to, epoch_year)

@spec transform(
  Sidereon.vec3(),
  Sidereon.vec3() | nil,
  Sidereon.FrameCatalog.TerrestrialFrame.t(),
  Sidereon.FrameCatalog.TerrestrialFrame.t(),
  number()
) ::
  {:ok, Sidereon.FrameCatalog.TerrestrialState.t()} | {:error, error_reason()}

Transform a Cartesian station position and optional velocity between frames.

transform_from_epoch(position_m, velocity_m_per_year, position_epoch_year, from, to, transform_epoch_year)

@spec transform_from_epoch(
  Sidereon.vec3(),
  Sidereon.vec3(),
  number(),
  Sidereon.FrameCatalog.TerrestrialFrame.t(),
  Sidereon.FrameCatalog.TerrestrialFrame.t(),
  number()
) ::
  {:ok, Sidereon.FrameCatalog.TerrestrialState.t()} | {:error, error_reason()}

Propagate a station to transform_epoch_year, then transform it between frames.