imap_processing.spice.spin.get_spin_data#

imap_processing.spice.spin.get_spin_data() DataFrame#

Read spin file using environment variable and return spin data.

SPIN_DATA_FILEPATH environment variable would be a fixed value. It could be s3 filepath that can be used to download the data through API or it could be path EFS or Batch volume mount path.

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.

  • 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