5. Instrument#

class Instrument(name: str, spice_id: int | str = None, measurement_type: str = None)#

Represents a generic instrument object. Provides functionalities related to spacecraft instrumentation.

Parameters:

Notes

References

Examples

Attributes

`area`	The cross-sectional area of the spacecraft.
`dry_mass`	The dry mass of the spacecraft.
`dv_fuel_mass`	The mass of the fuel spent during delta-v burns.
`fb_fuel_mass`	The mass of the fuel spent during finite burns.
`instrument_list`	The list of instruments attached to the spacecraft.
`mass`	The mass of the Body object.
`measurement_type`	Description.
`n_plate_model`	The N-Plate model representing the spacecraft's geometry.
`name`	The name of the spacecraft.
`ref_coeff`	The reflectivity coefficient of the spacecraft.
`spice_id`	The SPICE ID of the Body object.

Methods

`add_instrument`(instruments)	Adds an instrument or instruments to the spacecraft.
`field_of_view`()	Placeholder for Field of View functionality.
`get_state`(epoch_0[, reference_frame, origin])	Retrieves the state of the body relative to a given origin in a specified reference frame.

add_instrument(instruments) → None#

Adds an instrument or instruments to the spacecraft.

Parameters:: instruments (Instrument or list of Instrument) – The instrument or instruments to be attached to the spacecraft.
Return type:: None

field_of_view()#

Placeholder for Field of View functionality.

TODO: Implement the method to handle field of view.: This could be split into ‘set FOV’ and ‘get FOV’ methods.

get_state(epoch_0, reference_frame: str = 'J2000', origin: str = 'EARTH')#

Retrieves the state of the body relative to a given origin in a specified reference frame.

Parameters:

epoch_0 (EpochArray) – The epoch times for which the state is to be computed.
reference_frame (str) – The reference frame in which the state is desired. Defaults to ‘J2000’.
origin (str) – The origin body relative to which the state is computed. Defaults to 'EARTH'.

Returns:

state_vector – The state vector of the body relative to the origin.

Return type:

ArrayWUnits

property area: ArrayWUnits#: The cross-sectional area of the spacecraft. Expressed in units of square meters.

property dry_mass: ArrayWUnits#: The dry mass of the spacecraft. Expressed in units of kilograms.

property dv_fuel_mass: ArrayWUnits#: The mass of the fuel spent during delta-v burns. Expressed in units of kilograms.

property fb_fuel_mass: ArrayWUnits#: The mass of the fuel spent during finite burns. Expressed in units of kilograms.

property instrument_list: list#: The list of instruments attached to the spacecraft.

property n_plate_model#: The N-Plate model representing the spacecraft’s geometry.

property ref_coeff: float#: The reflectivity coefficient of the spacecraft.