Sidereon.GeodeticTimeSeries (Sidereon v0.27.0)

Geodetic position time-series velocity, trajectory, step, and network tools.

Epochs are decimal years. Positions are metres in the selected frame.

Summary

Types

error_reason()

frame()

sample()

Functions

detect_steps(samples, opts \\ [])

Detect displacement step candidates.

fit_trajectory(samples, model \\ %TrajectoryModel{}, opts \\ [])

Fit a linear geodetic trajectory model.

network_field(stations, origin, opts \\ [])

Estimate a network motion field in one output frame.

velocity_midas(samples, opts \\ [])

Estimate station velocity with MIDAS.

Types

error_reason()

@type error_reason() ::
  :invalid_input
  | :too_few_samples
  | :insufficient_pairs
  | :singular_trajectory
  | :did_not_converge
  | :solver
  | term()

frame()

@type frame() :: :enu | {:ecef, {number(), number(), number()}}

sample()

@type sample() ::
  Sidereon.GeodeticTimeSeries.PositionSample.t()
  | {number(), {number(), number(), number()}}

Functions

detect_steps(samples, opts \\ [])

@spec detect_steps(
  [sample()],
  keyword() | Sidereon.GeodeticTimeSeries.StepDetectionOptions.t()
) ::
  {:ok, [Sidereon.GeodeticTimeSeries.StepCandidate.t()]}
  | {:error, error_reason()}

Detect displacement step candidates.

fit_trajectory(samples, model \\ %TrajectoryModel{}, opts \\ [])

@spec fit_trajectory(
  [sample()],
  Sidereon.GeodeticTimeSeries.TrajectoryModel.t(),
  keyword() | Sidereon.GeodeticTimeSeries.TrajectoryFitOptions.t()
) ::
  {:ok, Sidereon.GeodeticTimeSeries.Trajectory.t()} | {:error, error_reason()}

Fit a linear geodetic trajectory model.

Pass a TrajectoryModel as the second argument and fit options as the third. The :frame option selects :enu or {:ecef, reference} input positions.

network_field(stations, origin, opts \\ [])

@spec network_field(
  [Sidereon.GeodeticTimeSeries.NetworkStation.t()],
  {number(), number(), number()},
  keyword()
) ::
  {:ok, Sidereon.GeodeticTimeSeries.MotionField.t()} | {:error, error_reason()}

Estimate a network motion field in one output frame.

origin is {lat_rad, lon_rad, height_m} for the output local ENU frame.

velocity_midas(samples, opts \\ [])

@spec velocity_midas(
  [sample()],
  keyword() | Sidereon.GeodeticTimeSeries.MidasOptions.t()
) ::
  {:ok, Sidereon.GeodeticTimeSeries.Velocity.t()} | {:error, error_reason()}

Estimate station velocity with MIDAS.

Options accept the MidasOptions fields plus :frame, which defaults to :enu.