API Reference Sidereon v#0.10.0

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.

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.

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.

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.

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.

One GLONASS broadcast state-vector record.

Broadcast ionosphere coefficients parsed from a RINEX NAV header.

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.

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.

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.

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

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

GPS LNAV clock and ephemeris parameters in engineering units.

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 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.

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.

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.

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

Float RTK baseline solution from code/carrier double differences.

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

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.

One SBAS log block with decoded message metadata.

Decoded SBAS message metadata.

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

An SP3 satellite state at one epoch.

State-space GNSS corrections.

SSR clock correction.

SSR orbit correction.

SSR solution identity.

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.

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 geodetic position: latitude, longitude, altitude.

Geoid undulation lookup and orthometric/ellipsoidal height conversion.

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.

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.

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

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.

Handle for one loaded DTED tile.