imap_processing.spice.spin.get_spin_data

imap_processing.spice.spin.get_spin_data() → DataFrame

Read spin-tables and return spin data.

The spin-tables to read are stored in the mutable module level attribute named spin_table_paths.

Returns:

spin_data –

Spin data. The DataFrame will have the following columns:

• spin_number: Unique integer spin number.

• spin_start_sec_sclk: MET seconds of spin start time.

• spin_start_subsec_sclk: MET microseconds of spin start time.

• spin_start_met: Floating point MET seconds of spin start.

• spin_start_utc: UTC string of spin start time.

• spin_period_sec: Floating point spin period in seconds (estimated).

• actual_spin_period: Floating point actual spin period computed from consecutive spin start times. More accurate than spin_period_sec.

• spin_period_valid: Boolean indicating whether spin period is valid.

• spin_phase_valid: Boolean indicating whether spin phase is valid.

• spin_period_source: Source used for determining spin period.

• thruster_firing: Boolean indicating whether thruster is firing.

Return type:

pandas.DataFrame

Raises:

ValueError – If no spin-table paths have been set.