Sidereon.GNSS.PreciseEphemeris.StateBatch (Sidereon v0.13.0)

Copy Markdown View Source

Contiguous satellite-state arrays returned by a batched ephemeris query.

The positions are ITRF/IGS ECEF metres and clocks are seconds. Element i of every field belongs to the same input satellite/epoch pair:

  • :positions_ecef_m - {x_m, y_m, z_m} tuples. Failed elements carry the sentinel returned by missing_position_ecef_m/0.
  • :clocks_s - satellite clock offsets in seconds, or nil.
  • :statuses - :valid, :gap, or :error.
  • :results - :ok or {:error, reason} with the core scalar reason.

A :gap is a data gap such as an unknown satellite or an out-of-coverage epoch. Other failures are marked :error.

Summary

Types

element_result()
position_component()
status()
t()
vec3()

Functions

count(state_batch)

Number of elements in the batch.

element(batch, index)

Reconstruct one element as {:ok, %{position_ecef_m, clock_s}} or an error.

missing_position_ecef_m()

Position sentinel used when an element has no valid state.

Types

element_result()

@type element_result() :: :ok | {:error, term()}

position_component()

@type position_component() :: float() | :nan

status()

@type status() :: :valid | :gap | :error

t()

@type t() :: %Sidereon.GNSS.PreciseEphemeris.StateBatch{
  clocks_s: [float() | nil],
  positions_ecef_m: [vec3()],
  results: [element_result()],
  statuses: [status()]
}

vec3()

@type vec3() :: {position_component(), position_component(), position_component()}

Functions

count(state_batch)

@spec count(t()) :: non_neg_integer()

Number of elements in the batch.

element(batch, index)

@spec element(t(), non_neg_integer()) ::
  {:ok, %{position_ecef_m: vec3(), clock_s: float() | nil}} | {:error, term()}

Reconstruct one element as {:ok, %{position_ecef_m, clock_s}} or an error.

Indexing is zero-based to match the core batch element contract. Returns {:error, :out_of_range} when index is outside the batch.

missing_position_ecef_m()

@spec missing_position_ecef_m() :: vec3()

Position sentinel used when an element has no valid state.

The core sentinel is a NaN vector. BEAM NIFs cannot transport NaN floats, so this binding represents it as {:nan, :nan, :nan}. Check results or statuses before using a position row.