Actuator#
- class Actuator(name: str, spice_id: int | str = None)#
Bases:
SpacecraftAny spacecraft component that applies thrust, torque, or other forces.
- Parameters:
- namestr
The name of the Actuator object.
- spice_idint or str, optional
The NAIF ID code of the object. Defaults to
None.
- Attributes:
areaThe cross-sectional area of the spacecraft.
body_fixed_frame_idThe SPICE ID assigned to the spacecraft’s body-fixed frame.
instrument_listThe list of instruments attached to the spacecraft.
mass_profileStored constant or polynomial mass profile.
n_plate_modelThe N-Plate model representing the spacecraft’s geometry.
nameThe name of the spacecraft.
ref_coeffThe reflectivity coefficient of the spacecraft.
spice_idThe SPICE ID of the Body object.
thrusterThruster actuator attached to this spacecraft, or
Noneif not set.
Methods
add_instrument(instruments)Adds an instrument or instruments to the spacecraft.
fit_mass_profile_from_data(t_array, m_array, ...)Fits a polynomial to a mass time history and sets it as the new mass profile.
get_attitude(from_frame, epoch[, tol])Computes the rotation from a given inertial frame to the spacecraft-fixed frame, from the C-kernel of frame ID
spice_id * 1000.Collects the SPICE ID's of all attached frames and instruments into a dictionary.
get_mass(t)Evaluates the time-varying mass profile at specified epochs.
get_state(epoch_0[, reference_frame, origin])Retrieves the state of the body relative to a given origin in a specified reference frame.
Computes the Direction Cosine Matrix (DCM) that points the body frame's -X axis toward the Sun (nadir-to-sun), using inertial quantities.
mass([t])Returns the mass of the body.
Restore the mass the body was built with and forget fitted profiles.
set_mass_profile(poly, units)Sets the mass profile of the body using a polynomial function and associated units.
See also
scarabaeus.SpacecraftParent class providing SPICE registration and mass tracking.
scarabaeus.InstrumentSibling subclass for sensing instruments.
Notes
Actuator is a lightweight subclass of
Spacecraft. It inherits all spacecraft state and SPICE-registration methods while adding no additional properties, leaving specialisation to concrete subclasses (e.g. thrusters).- add_instrument(instruments) None#
Adds an instrument or instruments to the spacecraft.
- Parameters:
- instrumentslist of Instrument
The instruments to be attached to the spacecraft.
- Returns:
- None
- fit_mass_profile_from_data(t_array: ndarray, m_array: ndarray, domain: tuple, units: Units) None#
Fits a polynomial to a mass time history and sets it as the new mass profile.
- Parameters:
- t_arraynumpy.ndarray
Time values in seconds (ephemeris time).
- m_arraynumpy.ndarray
Corresponding mass values.
- degint
Degree of the polynomial.
- domaintuple
Domain [t0, tf] for the polynomial conversion.
- unitsArrayWUnits
Units to assign to the mass profile. If None, uses existing mass profile units.
- Returns:
- None
- get_attitude(from_frame: Frame, epoch: EpochArray, tol: int = 0) ndarray#
Computes the rotation from a given inertial frame to the spacecraft-fixed frame, from the C-kernel of frame ID
spice_id * 1000.- Parameters:
- from_frameFrame
The intertial reference frame for which the spacecraft-fixed frame will be transformed from.
- epochEpochArray
The epoch at which the transformation will be performed. Given in ephemeris time (seconds past J2000).
- tolint, optional
The time tolerance for retrieving attitude and angular velocity from the specified spacecraft clock time, given in sclock ticks. Defaults to
0.
- Returns:
- quatnumpy.ndarray
The
(4,)SPICE quaternion (spice.m2q) of the rotation fromfrom_frameto spacecraft-fixed coordinates.
Notes
The
epochargument is converted from ephemeris time in seconds to continuous encoded spacecraft clock ticks.
- get_dependent_spice_ids()#
Collects the SPICE ID’s of all attached frames and instruments into a dictionary.
- Parameters:
- None
- Returns:
- idsdict
A dictionary containing the keys:
'instruments': list The SPICE ID’s of all attachedInstrumentobjects.'plates': list The SPICE ID’s of all C-frames for CK type panels defined in thenPlateModelif one has been assigned to the Spacecraft.
- get_mass(t: EpochArray) ArrayWUnits#
Evaluates the time-varying mass profile at specified epochs.
- Parameters:
- tEpochArray
Time(s) in ephemeris seconds (TDB).
- Returns:
- massArrayWUnits
Evaluated mass at each input epoch.
- get_state(epoch_0, reference_frame: str = 'J2000', origin: str = 'EARTH') ArrayWFrame#
Retrieves the state of the body relative to a given origin in a specified reference frame.
- Parameters:
- epoch_0EpochArray
The epoch times for which the state is to be computed.
- reference_framestr
The reference frame in which the state is desired. Defaults to ‘J2000’.
- originstr
The origin body relative to which the state is computed. Defaults to
'EARTH'.
- Returns:
- state_vectorArrayWFrame
The state vector of the body relative to the origin.
- inertial_to_body_DCM_nadirPointingSun(origin_name, frame, sun2body_pos, current_state: dict, epoch, body)#
Computes the Direction Cosine Matrix (DCM) that points the body frame’s -X axis toward the Sun (nadir-to-sun), using inertial quantities.
Deprecated since version 2026.0.0: Use
nadirPointingSun(), which returns the spacecraft-fixed to inertial DCM (the transpose of this one) and, on request, its position and velocity derivatives. This method now delegates to it.- Parameters:
- origin_namestr
Name of the origin at which current_state is defined (e.g., ‘EARTH’, ‘SUN’).
- frameFrame or str
Frame in which current_state is expressed (e.g., J2000).
- sun2body_posArrayWUnits
Position of the body w.r.t. SUN (km).
- current_statedict
State of the body w.r.t. the origin, keyed either by
('velocity', spice_id)or by'velocity', with an array orArrayWUnitsvalue (and similarly for'position'if ever needed).- epochfloat
Epoch (TDB seconds past J2000) at which the state is computed.
- bodyCelestialBody or Spacecraft
The body whose state we are extracting from current_state (used for spice_id lookup).
- Returns:
- DCM_inertial_to_body(3,3) ndarray
DCM that rotates inertial vectors into the body-fixed frame realizing the nadir-to-sun pointing.
- Raises:
- DynamicalUtils.MissingVelocityError
If current_state holds no velocity for body (a
KeyError).
- mass(t: EpochArray | float | ndarray = None) ArrayWUnits#
Returns the mass of the body. If the mass is time-varying, evaluates it at time t. If the mass is constant, returns the same value regardless of t.
- Parameters:
- tEpochArray, float, or np.ndarray, optional
Time(s) in ephemeris seconds (TDB) at which to evaluate the mass. Or None for constant mass.
- Returns:
- ArrayWUnits
Mass at time t or constant mass.
- reset_mass_history() None#
Restore the mass the body was built with and forget fitted profiles.
Every propagated leg appends the profile it fitted, and the next leg starts from the last one. Propagating the same mission again (a filter re-linearizing its reference, say) would otherwise start the first leg from the mass the previous run ended with, and
get_mass()would return profiles from earlier runs that cover the same epochs.The profile lists are cleared in place: force-model copies of this body share them by reference.
- Returns:
- None
- set_mass_profile(poly: SCBPolynomial, units: Units) None#
Sets the mass profile of the body using a polynomial function and associated units.
- Parameters:
- polySCBPolynomial
A polynomial object representing the mass profile.
- unitsUnits
The units associated with the mass profile.
- Returns:
- None
- property area: ArrayWUnits#
The cross-sectional area of the spacecraft. Expressed in units of square meters.
- property mass_profile: ArrayWUnits | SCBPolynomial#
Stored constant or polynomial mass profile.
- property n_plate_model: nPlateModel#
The N-Plate model representing the spacecraft’s geometry.
- property thruster#
Thruster actuator attached to this spacecraft, or
Noneif not set.