API Reference

This reference manual details the modules, classes, and methods included in Scarabaeus. Each module contains classes relevant to itself. For more in-depth descriptions of each module, see its respective section below.

---

Body Module

The classes described in this module define body objects in the orbit determination process. This includes planets, ground stations, and spacecraft.

All Body Classes:

• 1. Body
• 2. GroundStation
• 3. CelestialBody

---

Dynamics Module

The classes described in this module provide functionality for modeling the dynamic environment acting on a spacecraft. This includes modeling of Keplerian accelerations, 3rd body perturbations, solar radiation pressure, higher-order fidelity gravitational modeling (spherical harmonics, polyhedral), and finite burn modeling.

All Dynamics Classes:

• 1. CannonBallSRP
• 2. DynamicModel
• 3. FiniteBurn
• 4. ForceModel
• 5. ImpulsiveBurn
• 6. nPlateSRP
• 7. PointMassGravity
• 8. SphericalHarmonicsGravity
• 9. ThreeBodyGravity

---

Environment Module

The classes described in this module provide a set of high-level representations used to define the environment describing an orbit-determination scenario.

All Environment Classes:

• 1. MissionSequence
• 2. Propagator
• 3. ScenarioSetup
• 4. StateArray
• 5. Trajectory

---

Guidance Module

The classes described in this module provide functionality for guidance tasks such as B-Plane targeting and maneuver execution.

All Guidance Classes:

• 1. Bplane

---

Measurements Module

The classes described in this module provide functionality for both computed and observed modeling, multi-type modeling, generating measurement datasets, and the computation of partial derivatives. These capabilities are supported by a set of ideal and real measurement models that can be used to generate both radiometric and optical observables.

All Measurement Classes:

• 1. CentroidingIdeal
• 2. DiffOneWayRangeIdeal
• 3. DopplerIdeal
• 4. DopplerReal
• 5. Measurement
• 6. MeasurementDataSet
• 7. MeasurementSimulator
• 8. MediaCorrections
• 9. RampTableManager
• 10. RangeIdeal
• 11. RangeRateIdeal
• 12. SequentialRangingReal

---

Orbit Determination Module

The classes described in this module implement both orbit determination and filtering algorithms. They also include filter management classes and parent methods to handle filter iteration, handling, and visualization.

All Orbit Determination Classes:

• 1. FilterDataManager
• 2. FilterOD
• 3. LKF
• 4. LSB
• 5. ProcessNoiseCovariance
• 6. SolutionOD
• 7. SRIF

---

Spacecraft Module

The classes described in this module provide functionalities that define various properties of a spacecraft body. This includes sensors (such as imagers, antennas) and actuators (such as thrusters), structural elements, solar panels, power-generation models, etc.

All Spacecraft Classes:

• 1. Actuator
• 2. Antenna
• 3. Camera
• 4. Geometry
• 5. Instrument
• 6. nPlateModel
• 7. PowerModel
• 8. SolarPanel
• 9. Spacecraft
• 10. Thruster

---

Time and Frame Module

The classes described in this module provide tools for handling reference frame and time referencing systems. As these are critical elements in any orbit determination process, a dedicated set of classes are used to handle reference frame definition, transformation, and storage.

All Time & Frame Classes:

• 1. ArrayWFrame
• 2. EpochArray
• 3. Frame
• 4. SpiceManager

---

Units Module

The classes described in this module provide tools to manage both physical dimensions as well as units across the tool. This capability is important to ensure correct operations, facilitate clear interfaces, and maintain continuity when performing calculations using physical properties.

All Units Classes:

• 1. ArrayWUnits
• 2. Units
• 3. Dimensions

---

Utilities Module

The classes described in this module provide utility tools leveraged across the entirety of Scarabaeus.

All Utility Classes:

• 1. CovarianceMatrix
• 2. DatabaseManager
• 3. Noise
• 4. OrbitalElements
• 5. OutlierRejection
• 6. Plotting
• 7. Utils

Additional Classes

Any additional classes that are not categorized within a module are documented here. This includes things like the Scarabaes constants library and typing library.

All Additional Classes:

• 1. Constants