API Reference Sidereon v#0.26.1

Copy Markdown View Source

Modules

Satellite toolkit for Elixir. SGP4 orbit propagation, coordinate transformations, and ground station pass prediction.

Angular geometry calculations for satellites.

Almanac event finders.

Kepler anomaly conversions and two-body propagation for classical elements.

Equinoctial and modified equinoctial orbital element conversions.

Equinoctial orbital elements.

Modified equinoctial orbital elements.

General topocentric body observation.

RSW, RTN, RIC, LVLH relative frames and Clohessy-Wiltshire motion.

Cartesian state used by relative-frame and Clohessy-Wiltshire helpers.

Atmospheric density via the NRLMSISE-00 empirical model.

Ground-observer Sun and Moon geometry.

Parse and encode CCSDS Conjunction Data Messages (CDM).

Object-specific data block inside a parsed CCSDS CDM.

Parse and encode CCSDS Orbit Ephemeris Messages (OEM).

One 6x6 covariance block inside a parsed CCSDS OEM segment.

Metadata block for one CCSDS OEM segment.

One metadata/data segment of a CCSDS OEM.

One Cartesian state sample inside a parsed CCSDS OEM segment.

Parse and encode CCSDS Orbit Parameter Messages (OPM).

Optional OPM 6x6 covariance. matrix is a row-major list of six six-element rows.

Optional OPM Keplerian elements.

One OPM maneuver block. dv_km_s is the {x, y, z} delta-v in the maneuver reference frame.

OPM metadata block.

Optional OPM spacecraft parameters. Every field is optional.

OPM Cartesian state vector.

Parse and encode CCSDS Tracking Data Messages (TDM) in KVN format.

One time-tagged TDM tracking data record.

TDM data block containing comments and records.

A preserved KVN key/value field.

Metadata block for one TDM segment.

Parsed TDM observable family.

One named TDM tracking participant.

Parsed TDM signal path.

A numeric TDM data value and its exact source token.

One TDM metadata/data segment.

Allan-family clock-stability estimators.

One clock-stability estimator curve.

Combined Allan-family output.

Power-law clock-noise identification result.

Options for power-law clock-noise identification.

Consecutive tau span used for one fitted power-law coefficient.

Per-octave power-law classification.

Collision probability calculation for close approaches.

Result of a collision-probability evaluation.

Time-of-closest-approach and conjunction screening helpers.

Manage and propagate satellite constellations.

Coordinate frame transformations for satellite state vectors.

Covariance matrix helpers for conjunction and orbit analysis.

Batch single-epoch coverage helpers backed by the Rust core.

Doppler shift calculation for satellite-ground links.

Atmospheric drag parameters, acceleration, and decay estimates.

Estimated decay time and reentry state.

Ballistic drag settings passed to propagation and drag-force calculations.

Space-weather inputs for the core drag model.

Earth shadow (eclipse) prediction for satellites.

Earth shape model used by eclipse shadow calculations.

Canonical representation of satellite orbital elements.

Encounter geometry helpers for conjunction assessment.

Relative encounter geometry at a common epoch.

JPL/NAIF SPK (DAF .bsp) ephemeris kernel reader.

Position error metrics derived from supplied covariance matrices.

Horizontal one-sigma error ellipse.

Exact percentile circle or sphere radius plus the named approximation.

Position covariance in ECEF and local ENU coordinates.

Standard horizontal, vertical, and three-dimensional position error metrics.

Scalar estimation and detection primitives.

Alpha-beta gain set for one scalar channel.

State of a scalar alpha-beta level and rate estimator.

Result of one alpha-beta predict and update step.

Normalized innovation squared gate result.

Steady-state gains for a scalar constant-velocity Kalman filter.

Fixed-interval RTS-smoothed track.

One fixed-interval smoothed track epoch.

Stateful no-IMU constant-velocity track filter.

Configuration for a no-IMU constant-velocity track filter.

NIS-gated track update result.

Measurement residual, residual covariance, and NIS for a track update.

Result of one constant-velocity track prediction.

One recorded forward-filter epoch for RTS smoothing.

Recorded forward-filter history accepted by the RTS smoother.

Builder for a forward track-filter pass that can be RTS-smoothed.

Track state and covariance over [position, velocity].

Applied track update with predicted and updated states.

Earth's oblateness (J2) perturbation force model.

Standard Keplerian Two-Body gravity force model.

Parse and encode CCSDS Orbit Mean-Elements Messages (OMM).

UTC calendar epoch carried by an OMM EPOCH field.

Parse and encode Two-Line Element sets.

Epoch-aware terrestrial reference-frame transforms.

Helmert parameters in the published table units.

Helmert parameter rates in the published table units.

One published Helmert transform catalog entry.

Supported terrestrial frame labels.

Transformed terrestrial position and optional station velocity.

ARAIM snapshot integrity protection levels.

Per-constellation ARAIM ISM defaults.

Per-hypothesis ARAIM monitor data.

ARAIM snapshot geometry.

ARAIM integrity and continuity risk allocation.

ARAIM integrity support message input.

ARAIM protection-level result.

One satellite row in an ARAIM geometry snapshot.

Per-satellite ARAIM ISM override.

Per-satellite integrity and accuracy model without a satellite identity.

Parser and lookup helpers for ANTEX 1.4 receiver and satellite antenna blocks.

DCB and OSB bias products backed by the core bias parsers.

One bias record decoded from a DCB or OSB product.

Parsed DCB or OSB bias product.

A parsed RINEX broadcast-navigation product (GPS LNAV, Galileo I/NAV+F/NAV, BeiDou D1/D2, GLONASS).

Broadcast satellite-clock polynomial.

Core-evaluated CNAV single-frequency clock corrections in seconds.

CNAV/CNAV-2 fields that have no LNAV counterpart.

One broadcast record with issue, time tags, group delays, and CNAV fields.

One GLONASS broadcast state-vector record.

Broadcast group-delay fields preserved from a NAV record.

Broadcast ionosphere coefficients parsed from a RINEX NAV header.

Broadcast issue value plus the navigation-message family that carried it.

Broadcast Keplerian orbital elements.

Klobuchar alpha and beta ionosphere coefficients.

One GPS, Galileo, or BeiDou broadcast ephemeris record from RINEX NAV.

A broadcast-evaluated satellite state at one epoch.

GNSS week and time-of-week tagged with its native time scale.

Broadcast-ephemeris accuracy: compare a broadcast navigation product against a precise SP3 product over a window.

The result of a broadcast and precise product comparison.

Orbit and clock difference statistics for one satellite (or the overall set).

Dual-frequency carrier-phase linear combinations and the precise-positioning prep tooling built on them: geometry-free and wide-lane phase, the narrow-lane code, Melbourne-Wubbena, cycle-slip detection, and Hatch carrier-smoothed code.

GNSS constellation identity catalogs and validation helpers.

The result of a lenient catalog build: the records that resolved, plus the OMM entries that did not.

Change report between two GNSS constellation catalog snapshots.

A parsed row from NAVCEN's GPS constellation status table.

A normalized GNSS satellite identity record.

An OMM entry that Sidereon.GNSS.Constellation.from_celestrak_omm_lenient/2 could not resolve to a Record for the requested system.

Validation report for a GNSS constellation catalog.

Code-differential GNSS (DGPS) positioning over single-frequency pseudoranges.

Cache-first acquisition for GNSS products and DTED terrain tiles.

SP3 center that did not contribute to a merge.

SP3 center that contributed a product to a merge.

Audit report for merged SP3 acquisition.

Pure identity for one GNSS archive product.

Result partition for region and tile-list terrain prefetches.

A unified satellite-ephemeris sampling surface over precise SP3 products and broadcast navigation messages.

One sampled satellite state at one epoch in the unified ephemeris table.

Canonical GNSS carrier-frequency lookups.

Stateful GNSS/INS fusion filters.

Opaque native GNSS/INS fusion filter handle.

One recorded GNSS/INS fusion epoch for RTS smoothing.

Recorded forward-pass history accepted by the fusion RTS smoother.

Builder for a recorded GNSS/INS fusion forward pass.

GNSS PVT measurement used by loose-coupled fusion updates.

IMU rate or increment sample accepted by the fusion propagator.

One fixed-interval smoothed GNSS/INS fusion epoch.

Fixed-interval RTS-smoothed GNSS/INS fusion trajectory.

Carrier-phase range row with a caller-supplied float ambiguity.

One receiver epoch of raw GNSS observations for a tight update.

Raw GNSS observation for one satellite in a tight update.

Doppler-derived range-rate row for one satellite in a tight update.

Retained-history limits for bounded-latency time synchronization.

One position and velocity sample used by outage velocity matching.

Endpoint velocity matching settings for one GNSS outage.

Satellite-geometry and mission-planning layer above the GNSS observables: from a static receiver position and a precise (SP3) ephemeris, answer the three planning questions: which satellites are visible, how good is the geometry (dilution of precision), and when does each satellite rise and set.

Single-frequency ionospheric group-delay corrections.

Whole-grid IONEX vertical-TEC samples.

One IONEX vertical-TEC grid-node sample.

The dual-frequency ionosphere-free linear combination for code and phase.

NMEA 0183 parsing, epoch accumulation, and GGA writing.

Resource-backed incremental NMEA accumulator.

One decoded NMEA sentence.

One accumulated NMEA epoch snapshot.

GPS L1 C/A LNAV navigation message synthesis and decoding (subframes 1-3).

GPS LNAV clock and ephemeris parameters in engineering units.

NTRIP client helpers and stream process.

NTRIP CAS record.

Position fields for NTRIP VRS GGA output.

NTRIP NET record.

Unknown NTRIP sourcetable record with fields preserved.

Parsed NTRIP sourcetable resource and record list.

NTRIP STR record.

GenServer that owns an NTRIP stream connection.

Predict the GNSS observables a receiver at a known ECEF position would see for a satellite, from a precise (SP3) or broadcast ephemeris source.

Precomputed, state-independent PPP per-range corrections for the static-arc float/fixed solve: solid-earth tide, carrier-phase wind-up, and satellite antenna PCO/PCV.

GNSS single-point positioning (SPP): recover a receiver position, clock bias, and geometry diagnostics from one epoch of pseudorange observations against a precise SP3 ephemeris or a broadcast navigation product.

A receiver position solution paired with an optional Doppler velocity solve.

A single-point-positioning solution at one receive epoch.

A single-point-positioning solution paired with the provenance of the ephemeris that produced it.

A precise-ephemeris source built directly from samples, with no SP3 text in the loop.

Cached precise-ephemeris interpolant and batched satellite-state queries.

Opened precise-ephemeris interpolant artifact.

Canonical precise-interpolant artifact facade.

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

One precise-ephemeris sample: a satellite's ECEF position (and optional clock) at one epoch, in SI units.

Carrier-phase precise-positioning primitives.

Static multi-epoch integer-fixed carrier-phase solution.

Static multi-epoch float-ambiguity phase positioning solution.

Float-ambiguity phase positioning solution for one epoch.

Measurement-quality control for single-point positioning.

Detected receiver-clock jump.

Aggregate dual-frequency cycle-slip counts.

Detected gap between adjacent observation epochs.

MP1/MP2 multipath RMS report.

RMS statistics for one multipath series.

Antenna identity from ANT # / TYPE.

Compact lint finding retained by a QC report.

Header metadata copied into a QC report.

Receiver identity from REC # / TYPE / VERS.

RINEX observation QC report.

Observation epoch with an optional RINEX time-scale label.

Post-solve RAIM input.

Post-solve RAIM fault-detection result.

Per-satellite MP1/MP2 RMS row.

Per-satellite observation completeness row.

Per-satellite, per-code observation completeness row.

Summary statistics over raw numeric S-code observations.

Histogram over RINEX SSI digits.

Per-constellation cycle-slip counts.

Per-constellation MP1/MP2 RMS row.

Per-constellation observation completeness row.

Per-constellation, per-code observation completeness row.

RINEX clock (.CLK) reader for satellite clock-bias records.

RINEX 3 observation products: parse a station's observation file, expose its header (including the surveyed APPROX POSITION XYZ, optional antenna DELTA H/E/N offset, and carrier phase-shift records), and extract the single-frequency pseudoranges that Sidereon.GNSS.Positioning.solve/4 consumes.

RTCM 3.x differential-GNSS stream decoding.

RTK-facing carrier/code double-difference primitives.

Complete typed configuration for a sequential RTK arc solve.

Cycle-slip split interval reported while preparing or solving an RTK arc.

One epoch of a sequential RTK arc solution.

Optional preprocessing chained ahead of the sequential RTK arc solve.

Solved sequential RTK arc.

Final carried sequential RTK arc state.

Per-epoch sequential-update controls for the RTK arc driver.

Optional dual-frequency cycle-slip preprocessing controls.

Integer-fixed RTK baseline solution from code/carrier double differences.

Iteration and integer-search controls for RTK fixed solving.

Float RTK baseline solution from code/carrier double differences.

Iteration controls for an RTK float solve.

Complete typed configuration for ionosphere-free RTK arc setup.

Ionosphere-free single-frequency-equivalent RTK arc prepared from fixed wide-lane ambiguities.

RTK measurement weighting and correction model.

Moving-baseline RTK: both receivers move each epoch (RTKLIB "moving-base").

Residual validation controls for RTK fixed solving.

Complete typed configuration for a static RTK arc solve.

Solved static RTK arc.

Carrier RTK detail from a static reference-station solve.

Code-DGNSS detail from a static reference-station solve.

Per-epoch diagnostic row from a static reference-station mode.

Per-mode attempt report for the static reference-station solver.

Position covariance blocks for a static reference-station coordinate.

Static reference-station coordinate with covariance and mode diagnostics.

Complete typed configuration for wide-lane RTK arc fixing.

Fixed wide-lane ambiguity solution for a dual-frequency RTK arc.

Wide-lane integer metadata attached to a static RINEX RTK solve.

Wide-lane integer estimation controls.

A compact, fitted mean-element approximation of a satellite's orbit.

A long position track approximated by a sequence of contiguous, independently fitted Sidereon.GNSS.ReducedOrbit segments.

Satellite-based augmentation corrections.

SBAS airborne receiver and multipath contribution model.

Supplied SBAS degradation terms for protection-level error modeling.

One SBAS log block with decoded message metadata.

Decoded SBAS message.

SBAS protection-level geometry.

One satellite row in an SBAS protection-level geometry snapshot.

Index-aligned SBAS range-error model for protection-level geometry rows.

SBAS protection-level multipliers.

SBAS protection-level error reasons.

SBAS protection-level output for one geometry snapshot.

One satellite's SBAS one-sigma range-error budget.

SP3-c / SP3-d precise-ephemeris products (IGS precise orbits + clocks).

An SP3 satellite state at one epoch.

RINEX observation convenience entry points for GNSS single-point positioning.

One RINEX observation epoch assembled into SPP solve inputs.

One assembled RINEX observation epoch paired with its SPP solve result.

State-space GNSS corrections.

SSR clock correction.

SSR orbit correction.

SSR solution identity.

Deterministic synthetic GNSS observable scenarios.

Closed-form GNSS signal spectrum and tracking metrics.

Inputs for code-tracking thermal-noise metrics.

Interfering signal and received power for C/N0 degradation metrics.

Inputs for one-path specular multipath envelope metrics.

GPS L1 coarse/acquisition (C/A) code generation and correlation.

Baseband simulation, correlation, and acquisition for the GPS L1 C/A signal.

Product-staleness graceful degradation for time-varying GNSS products.

A selected IONEX product paired with its staleness metadata.

Staleness cap for product selection.

A selected SP3 product paired with its staleness metadata.

Structured description of the product staleness behind a selection result.

Multi-epoch static GNSS single-point positioning.

Multi-epoch static receiver solution.

Epoch conversions shared by the GNSS correction wrappers.

Neutral-atmosphere (tropospheric) signal-delay corrections.

Recover receiver velocity and clock drift from one epoch of range-rate or Doppler observations against a precise SP3 or broadcast ephemeris source.

WGS84 geodesic direct and inverse solves.

Invalid-input detail returned by geodesic solves.

WGS84 geodetic position: latitude, longitude, altitude.

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

MIDAS pair-selection diagnostics for one ENU component.

Options for the MIDAS velocity estimator.

Network motion field in one output ENU frame.

One station input for network motion-field estimation.

One position sample in a geodetic time series.

Candidate displacement step from the labelled detector heuristic.

Options for displacement step detection.

Fitted trajectory coefficients and solver diagnostics.

Least-squares controls for trajectory fitting.

Linear trajectory model shape.

Robust ENU velocity estimate.

WGS84 geodesic polygon geofencing with position uncertainty.

A constructed WGS84 geodesic polygon fence.

Confidence thresholds for probabilistic fence crossing.

Geoid undulation lookup and orthometric/ellipsoidal height conversion.

Supported NGA EGM2008 interpolation-raster spacings.

Descriptor for a full or cropped EGM2008 raster window.

Geometry observability and covariance-validation diagnostics.

Integer least-squares search helpers.

Initial Orbit Determination methods.

Lambert problem solver (Battin's method).

Generic data-driven trust-region least squares.

A leave-one-out sweep: the base solve over all rows, one drops solve per masked residual row (in row order), and cost_delta giving how much the optimum cost moves when each row is removed.

A single converged trust-region solve.

Topocentric look angle from a ground station to a satellite.

Observational-astronomy geometry primitives.

Precise orbit fitting and residual ledgers.

Fitted state covariance or an unbounded marker.

Initial-state orbit fit for one satellite.

Residual summary grouped by satellite and constellation.

Classical (Keplerian) orbital elements and the two-body state transforms.

A satellite pass over a ground station.

Satellite pass prediction over a ground station.

High-precision numerical orbit propagation.

RF link budget primitives.

Classical Baarda/Teunissen reliability diagnostics.

Reliability diagnostics for one observation.

One range row for pre-data reliability design.

Options for classical reliability calculations.

Full reliability report.

Aggregate reliability diagnostics for a design.

SGP4/SDP4 orbit propagation from Two-Line Element sets.

Result of inverse SGP4 TLE fitting.

Sidereal repeat-period helpers and residual filtering.

Options for sidereal residual filtering.

Output from sidereal residual filtering.

Source localization from time of arrival or time difference of arrival.

State covariance or CRLB from a source-localization solve.

Timing CRLB and DOP for a proposed source and sensor geometry.

Compatibility namespace for source-localization geometry diagnostics.

Closed-form seed used to start a source-localization solve.

Options for ToA or TDOA source localization.

Solver residual associated with a sensor row.

Sensor with a known Cartesian position.

Per-sensor leave-one-out diagnostic.

Source-localization solution.

Space-weather tables for drag and decay inputs.

J2000-second coverage bounds for a parsed space-weather table.

Lookup policy for rejecting lower-trust rows or monthly Ap defaults.

Space-weather values plus source metadata for one lookup.

Residual-distribution diagnostics: sample moments and normality tests.

Represents the position and velocity of a satellite in the TEME coordinate system.

DTED terrain loading and elevation lookup.

Handle for a DTED terrain directory.

Options for DTED height lookup.

Handle for one loaded DTED tile.

Memory-mappable terrain store conversion and lookup.

Loaded EGM96 15-minute WW15MGH.DAC geoid grid.

WGS84 ellipsoidal terrain height h in metres.

Orthometric terrain height H in metres above the EGM96 mean sea level geoid.

Terrain vertical-datum conversion and optional geoid-grid loading error.

Geoid tier used for terrain orthometric-to-ellipsoidal conversion.

Terrain store conversion, parse, and checksum error.

Metadata for one tile record in a terrain store.

Vertical datum carried by terrain store tile records.