imap-processing 0.6.0__py3-none-any.whl

imap_processing/cdf/config/imap_swe_l1a_variable_attrs.yaml

@@ -0,0 +1,234 @@
+# <=== Coordinates ===>
+
+spin_angle:
+  CATDESC: 180 measurements per quarter cycle. See VAR_NOTES for details
+  FIELDNAM: Spin Angle
+  FILLVAL: -9223370000000000000
+  FORMAT: I3
+  LABLAXIS: Angle
+  SCALE_TYP: linear
+  UNITS: " "
+  VALIDMAX: 179
+  VALIDMIN: 0
+  VAR_NOTES: Combination of energy and spin angle. 180 measurements per quarter cycle.
+    At this point, we don't know about energy or spin angle information.
+  VAR_TYPE: support_data
+
+polar_angle:
+  CATDESC: This is angle of 7 CEMs
+  FIELDNAM: Polar Angle
+  FILLVAL: -9223370000000000000
+  FORMAT: I1
+  LABLAXIS: Angle
+  SCALE_TYP: linear
+  UNITS: int
+  VALIDMAX: 6
+  VALIDMIN: 0
+  VAR_NOTES: " "
+  VAR_TYPE: support_data
+
+# <=== Label Attributes ===>
+# LABL_PTR_i expects VAR_TYPE of metadata with char data type.
+# We need to define this if we have DEPEND_1 or more.
+# TODO: I am not sure what the FIELDNAM should be.
+# I tried best to match this: https://spdf.gsfc.nasa.gov/istp_guide/variables.html#Metadata_eg1
+spin_angle_label:
+  CATDESC: 180 measurements per quarter cycle
+  FIELDNAM: Spin Angle
+  FORMAT: A3
+  VAR_TYPE: metadata
+
+polar_angle_label:
+  CATDESC: This is angle of 7 CEMs
+  FIELDNAM: CEM Counts
+  FORMAT: A1
+  VAR_TYPE: metadata
+
+# <=== Data Variables ===>
+# Default Attrs for all data variables unless overridden
+
+default_attrs: &default
+  DEPEND_0: epoch
+  DISPLAY_TYPE: 'no_plot'
+  LABLAXIS: ' '
+  FILLVAL: -9223372036854775808
+  FORMAT: I19
+  UNITS: ' '
+  VALIDMIN: 0
+  VALIDMAX: 9223372036854769664
+  VAR_TYPE: support_data
+  SCALETYP: linear
+
+raw_counts:
+  <<: *default
+  CATDESC: Raw Counts stored in 8bits length
+  DEPEND_1: spin_angle
+  DEPEND_2: polar_angle
+  LABL_PTR_1: spin_angle_label
+  LABL_PTR_2: polar_angle_label
+  DISPLAY_TYPE: spectrogram
+  FIELDNAM: Raw Counts
+  FORMAT: I3
+  UNITS: counts
+  VALIDMAX: 255
+  VALIDMIN: 0
+  VAR_TYPE: data
+
+science_data:
+  <<: *default
+  CATDESC: Decompressed Counts
+  DEPEND_1: spin_angle
+  DEPEND_2: polar_angle
+  LABL_PTR_1: spin_angle_label
+  LABL_PTR_2: polar_angle_label
+  DISPLAY_TYPE: spectrogram
+  FIELDNAM: Decompressed Counts
+  FORMAT: I5
+  UNITS: counts
+  VALIDMAX: 66539
+  VALIDMIN: 0
+  VAR_TYPE: data
+
+shcoarse:
+  <<: *default
+  CATDESC: Mission elapsed time
+  FIELDNAM: SHCOARSE
+
+acq_start_coarse:
+  <<: *default
+  CATDESC: Acquisition start time coarse in seconds
+  FIELDNAM: Acquisition Time Coarse
+
+acq_start_fine:
+  <<: *default
+  CATDESC: Acquisition start time fine in microseconds
+  FIELDNAM: Acquisition Time Fine
+  FORMAT: I10
+  VALIDMAX: 4290000000
+
+cem_nominal_only:
+  <<: *default
+  CATDESC: CEM Nominal status bit. '1' -- nominal, '0' -- not nominal
+  FIELDNAM: CEM Nominal Status
+  FORMAT: I1
+  VALIDMAX: 1
+
+spin_period_validity:
+  <<: *default
+  CATDESC: Spin period valid bit. '1' -- valid, '0' -- invalid
+  FIELDNAM: Spin Period Validity
+  FORMAT: I1
+  VALIDMAX: 1
+
+spin_phase_validity:
+  <<: *default
+  CATDESC: Spin phase valid bit. '1' -- valid, '0' -- invalid
+  FIELDNAM: Spin Phase Validity
+  FORMAT: I1
+  VALIDMAX: 1
+
+spin_period_source:
+  <<: *default
+  CATDESC: >
+    Spin period source bit. '1' -- sun sensor (safing), '0' -- star tracker
+    (nominal)
+  FIELDNAM: Spin Period Source
+  FORMAT: I1
+  VALIDMAX: 1
+
+settle_duration:
+  <<: *default
+  CATDESC: HVPS settling duration
+  FIELDNAM: HVPS Setting Duration
+  FORMAT: I5
+  VALIDMAX: 65535
+
+acq_duration:
+  <<: *default
+  CATDESC: Acquisition duration
+  FIELDNAM: Acquisition Duration
+  FORMAT: I10
+  VALIDMAX: 4290000000
+
+spin_phase:
+  <<: *default
+  CATDESC: Spin phase
+  FIELDNAM: Spin Phase
+  FORMAT: I5
+  VALIDMAX: 65535
+
+spin_period:
+  <<: *default
+  CATDESC: Spin period
+  FIELDNAM: Spin Period
+  FORMAT: I5
+  VALIDMAX: 65535
+
+repoint_warning:
+  <<: *default
+  CATDESC: >
+    Thruster fired during this quarter cycle. '1' -- yes, warning received,
+    '0' -- no, warning not received
+  FIELDNAM: Repointing Warning
+  FORMAT: I1
+  VALIDMAX: 1
+
+high_count:
+  <<: *default
+  CATDESC: >
+    High CEM count observed for at least one CEM during this quarter cycle.
+    '1' -- yes, high count occurred, '0' -- no, no high count occurred
+  FIELDNAM: High Count
+  FORMAT: I1
+  VALIDMAX: 1
+
+stim_enabled:
+  <<: *default
+  CATDESC: Stim state. '1' -- enabled, '0' -- disabled
+  FIELDNAM: Stim State
+  FORMAT: I1
+  VALIDMAX: 1
+
+quarter_cycle:
+  <<: *default
+  CATDESC: Quarter cycle number
+  FIELDNAM: Quarter Cycle Number
+  FORMAT: I3
+  VALIDMAX: 255
+
+esa_table_num:
+  <<: *default
+  CATDESC: ESA table identifier
+  FIELDNAM: ESA table Identifier
+  FORMAT: I3
+  VALIDMAX: 255
+
+esa_acq_cfg:
+  <<: *default
+  CATDESC: ESA acquisition configuration
+  FIELDNAM: ESA Acquisition Configuration
+  FORMAT: I3
+  VALIDMAX: 255
+
+threshold_dac:
+  <<: *default
+  CATDESC: Threshold DAC value
+  FIELDNAM: Threshold DAC Value
+  FORMAT: I5
+  VALIDMAX: 65535
+
+stim_cfg_reg:
+  <<: *default
+  CATDESC: >
+    Stim pulse configuration register. Bits 0-3, period, 4-7, duration, 8-9
+    mode
+  FIELDNAM: Stim Pulse Configuration
+  FORMAT: I5
+  VALIDMAX: 65535
+
+cksum:
+  <<: *default
+  CATDESC: Checksum
+  FIELDNAM: Checksum
+  FORMAT: I5
+  VALIDMAX: 65535

imap_processing/cdf/config/imap_swe_l1b_variable_attrs.yaml

@@ -0,0 +1,273 @@
+# <=== Coordinates ===>
+energy:
+  CATDESC: Energy step id in lookup table
+  FIELDNAM: energy step
+  FILLVAL: -9223370000000000000
+  FORMAT: I2
+  LABLAXIS: Energy Step
+  SCALE_TYP: linear
+  UNITS: " "
+  VALIDMAX: 23
+  VALIDMIN: 0
+  VAR_TYPE: support_data
+
+angle:
+  CATDESC: Spin angle step. Angle resolution is 12 degree nominally
+  FIELDNAM: spin angle
+  FILLVAL: -9223370000000000000
+  FORMAT: I2
+  LABLAXIS: Angle
+  SCALE_TYP: linear
+  UNITS: "Degree"
+  VALIDMAX: 29
+  VALIDMIN: 0
+  VAR_TYPE: support_data
+
+cem:
+  CATDESC: Data rates of each CEM detectors
+  FIELDNAM: rates
+  FILLVAL: -9223370000000000000
+  FORMAT: E14.7
+  LABLAXIS: Rates
+  SCALE_TYP: linear
+  UNITS: " "
+  VALIDMAX: 0.000015514
+  VALIDMIN: 0.0
+  VAR_NOTES: " "
+  VAR_TYPE: support_data
+
+cycle:
+  CATDESC: Full cycle data takes 4 spins' data
+  FIELDNAM: quater cycle
+  FILLVAL: -9223370000000000000
+  FORMAT: I2
+  LABLAXIS: Cycle
+  SCALE_TYP: linear
+  UNITS: " "
+  VALIDMAX: 3
+  VALIDMIN: 0
+  VAR_TYPE: support_data
+
+# <=== Label Attributes ===>
+# LABL_PTR_i expects VAR_TYPE of metadata with char data type
+energy_label:
+  CATDESC: Energy step id in lookup table
+  FIELDNAM: Energy Step ID
+  FORMAT: A2
+  VAR_TYPE: metadata
+
+angle_label:
+  CATDESC: Spin angle step. Angle resolution is 12 degree nominally
+  FIELDNAM: 12 Degree Resolution
+  FORMAT: A2
+  VAR_TYPE: metadata
+
+cem_label:
+  CATDESC: Data rates of each CEM detectors
+  FIELDNAM: CEM Rates
+  FORMAT: A1
+  VAR_TYPE: metadata
+
+# <=== Data Variables ===>
+# Default Attrs for all data variables unless overridden
+
+default_attrs: &default
+  DEPEND_0: epoch
+  DISPLAY_TYPE: 'no_plot'
+  LABLAXIS: ' '
+  FILLVAL: -9223372036854775808
+  FORMAT: I19
+  UNITS: ' '
+  VALIDMIN: 0
+  VALIDMAX: 9223372036854769664
+  VAR_TYPE: support_data
+  SCALETYP: linear
+
+science_data:
+  <<: *default
+  CATDESC: Electron count rates organized by voltage step and spin sector and CEM
+  DEPEND_1: energy
+  DEPEND_2: angle
+  DEPEND_3: cem
+  LABL_PTR_1: energy_label
+  LABL_PTR_2: angle_label
+  LABL_PTR_3: cem_label
+  DISPLAY_TYPE: spectrogram
+  FIELDNAM: Counts rate by volt step and spin sector and CEM
+  FORMAT: E14.7
+  FILLVAL: -1.0000000E+31
+  LABLAXIS: Count Rates
+  UNITS: counts/sec
+  VALIDMAX: 0.000015514
+  VALIDMIN: 0
+  VAR_TYPE: data
+  VAR_NOTES: >
+    Metadata field acq_duration is 17 uint. Max value of uint17 is 131071.
+    Dividing max counts by acq_duration gave validmax
+
+shcoarse:
+  <<: *default
+  DEPEND_1: cycle
+  CATDESC: Mission elapsed time
+  FIELDNAM: SHCOARSE
+
+acq_start_coarse:
+  <<: *default
+  DEPEND_1: cycle
+  CATDESC: Acquisition start time coarse in seconds
+  FIELDNAM: Acquisition Time Coarse
+
+acq_start_fine:
+  <<: *default
+  DEPEND_1: cycle
+  CATDESC: Acquisition start time fine in microseconds
+  FIELDNAM: Acquisition Time Fine
+  FORMAT: I10
+  VALIDMAX: 4290000000
+
+cem_nominal_only:
+  <<: *default
+  DEPEND_1: cycle
+  CATDESC: CEM Nominal status bit. '1' -- nominal, '0' -- not nominal
+  FIELDNAM: CEM Nominal Status
+  FORMAT: I1
+  VALIDMAX: 1
+
+spin_period_validity:
+  <<: *default
+  DEPEND_1: cycle
+  CATDESC: Spin period valid bit. '1' -- valid, '0' -- invalid
+  FIELDNAM: Spin Period Validity
+  FORMAT: I1
+  VALIDMAX: 1
+
+spin_phase_validity:
+  <<: *default
+  DEPEND_1: cycle
+  CATDESC: Spin phase valid bit. '1' -- valid, '0' -- invalid
+  FIELDNAM: Spin Phase Validity
+  FORMAT: I1
+  VALIDMAX: 1
+
+spin_period_source:
+  <<: *default
+  DEPEND_1: cycle
+  CATDESC: >
+    Spin period source bit. '1' -- sun sensor (safing), '0' -- star tracker
+    (nominal)
+  FIELDNAM: Spin Period Source
+  FORMAT: I1
+  VALIDMAX: 1
+
+settle_duration:
+  <<: *default
+  DEPEND_1: cycle
+  CATDESC: HVPS settling duration
+  FIELDNAM: HVPS Setting Duration
+  FORMAT: I5
+  VALIDMAX: 65535
+
+acq_duration:
+  <<: *default
+  DEPEND_1: cycle
+  CATDESC: Acquisition duration
+  FIELDNAM: Acquisition Duration
+  FORMAT: I10
+  VALIDMAX: 4290000000
+
+spin_phase:
+  <<: *default
+  DEPEND_1: cycle
+  CATDESC: Spin phase
+  FIELDNAM: Spin Phase
+  FORMAT: E14.7
+  VALIDMAX: 65535
+  FILLVAL: -1.0000000E+31
+
+spin_period:
+  <<: *default
+  DEPEND_1: cycle
+  CATDESC: Spin period
+  FIELDNAM: Spin Period
+  FORMAT: E14.7
+  VALIDMAX: 65535
+  FILLVAL: -1.0000000E+31
+
+repoint_warning:
+  <<: *default
+  DEPEND_1: cycle
+  CATDESC: >
+    Thruster fired during this quarter cycle. '1' -- yes, warning received,
+    '0' -- no, warning not received
+  FIELDNAM: Repointing Warning
+  FORMAT: I1
+  VALIDMAX: 1
+
+high_count:
+  <<: *default
+  DEPEND_1: cycle
+  CATDESC: >
+    High CEM count observed for at least one CEM during this quarter cycle.
+    '1' -- yes, high count occurred, '0' -- no, no high count occurred
+  FIELDNAM: High Count
+  FORMAT: I1
+  VALIDMAX: 1
+
+stim_enabled:
+  <<: *default
+  DEPEND_1: cycle
+  CATDESC: Stim state. '1' -- enabled, '0' -- disabled
+  FIELDNAM: Stim State
+  FORMAT: I1
+  VALIDMAX: 1
+
+quarter_cycle:
+  <<: *default
+  DEPEND_1: cycle
+  CATDESC: Quarter cycle number
+  FIELDNAM: Quarter Cycle Number
+  FORMAT: I3
+  VALIDMAX: 255
+
+esa_table_num:
+  <<: *default
+  DEPEND_1: cycle
+  CATDESC: ESA table identifier
+  FIELDNAM: ESA table Identifier
+  FORMAT: I3
+  VALIDMAX: 255
+
+esa_acq_cfg:
+  <<: *default
+  DEPEND_1: cycle
+  CATDESC: ESA acquisition configuration
+  FIELDNAM: ESA Acquisition Configuration
+  FORMAT: I3
+  VALIDMAX: 255
+
+threshold_dac:
+  <<: *default
+  DEPEND_1: cycle
+  CATDESC: Threshold DAC value
+  FIELDNAM: Threshold DAC Value
+  FORMAT: E14.7
+  VALIDMAX: 65535
+  FILLVAL: -1.0000000E+31
+
+stim_cfg_reg:
+  <<: *default
+  DEPEND_1: cycle
+  CATDESC: >
+    Stim pulse configuration register. Bits 0-3, period, 4-7, duration, 8-9
+    mode
+  FIELDNAM: Stim Pulse Configuration
+  FORMAT: I5
+  VALIDMAX: 65535
+
+cksum:
+  <<: *default
+  DEPEND_1: cycle
+  CATDESC: Checksum
+  FIELDNAM: Checksum
+  FORMAT: I5
+  VALIDMAX: 65535

imap_processing/cdf/config/imap_ultra_global_cdf_attrs.yaml

@@ -0,0 +1,100 @@
+instrument_base: &instrument_base
+  Descriptor: Ultra>IMAP Ultra-Energy (IMAP-Ultra) Energetic Neutral Atom Imager
+  TEXT: >
+    Ultra captures images of very energetic neutral atoms, particularly hydrogen (H) atoms,
+    produced in the solar system at the heliosheath, the region where the solar wind slows,
+    compresses, and becomes much hotter as it meets the interstellar medium (ISM).
+    The instrument also measures the distribution of solar wind electrons and protons, and
+    the magnetic field. See https://imap.princeton.edu/instruments/ultra for more details.
+  Instrument_type: "Particles (space)"
+
+# TODO: revisit this to be more specific
+imap_ultra_l1a_sci:
+    <<: *instrument_base
+    Data_level: 1A
+    Data_type: L1A_SCI>Level-1A Science data
+    Logical_source: imap_ultra_l1a_sci
+    Logical_source_description: IMAP-Ultra Instrument Level-1A Science Data.
+
+imap_ultra_l1b_45sensor-de:
+    <<: *instrument_base
+    Data_level: 1B
+    Data_type: L1B_45Sensor-DE>Level-1B Direct Events for Ultra45
+    Logical_source: imap_ultra_l1b_45sensor-de
+    Logical_source_description: IMAP-Ultra Instrument Level-1B Direct Event Data.
+
+imap_ultra_l1b_90sensor-de:
+    <<: *instrument_base
+    Data_level: 1B
+    Data_type: L1B_90Sensor-DE>Level-1B Direct Events for Ultra90
+    Logical_source: imap_ultra_l1b_90sensor-de
+    Logical_source_description: IMAP-Ultra Instrument Level-1B Direct Event Data.
+
+imap_ultra_l1b_45sensor-extendedspin:
+    <<: *instrument_base
+    Data_level: 1B
+    Data_type: L1B_45Sensor-ExtendedSpin>Level-1B Extended Spin for Ultra45
+    Logical_source: imap_ultra_l1b_45sensor-extendedspin
+    Logical_source_description: IMAP-Ultra Instrument Level-1B Extended Spin Data.
+
+imap_ultra_l1b_90sensor-extendedspin:
+    <<: *instrument_base
+    Data_type: L1B_90Sensor-ExtendedSpin>Level-1B Extended Spin for Ultra90
+    Logical_source: imap_ultra_l1b_90sensor-extendedspin
+    Logical_source_description: IMAP-Ultra Instrument Level-1B Extended Spin Data.
+
+imap_ultra_l1b_45sensor-cullingmask:
+    <<: *instrument_base
+    Data_level: 1B
+    Data_type: L1B_45Sensor-CullingMask>Level-1B Culling Mask for Ultra45
+    Logical_source: imap_ultra_l1b_45sensor-cullingmask
+    Logical_source_description: IMAP-Ultra Instrument Level-1B Culling Mask Data.
+
+imap_ultra_l1b_90sensor-cullingmask:
+    <<: *instrument_base
+    Data_level: 1B
+    Data_type: L1B_90Sensor-CullingMask>Level-1B Culling Mask for Ultra90
+    Logical_source: imap_ultra_l1b_90sensor-cullingmask
+    Logical_source_description: IMAP-Ultra Instrument Level-1B Culling Mask Data.
+
+imap_ultra_l1b_45sensor-badtimes:
+    <<: *instrument_base
+    Data_level: 1B
+    Data_type: L1B_45Sensor-Badtimes>Level-1B Badtimes for Ultra45
+    Logical_source: imap_ultra_l1b_45sensor-badtimes
+    Logical_source_description: IMAP-Ultra Instrument Level-1B Badtimes Data.
+
+imap_ultra_l1b_90sensor-badtimes:
+    <<: *instrument_base
+    Data_level: 1B
+    Data_type: L1B_90Sensor-Badtimes>Level-1B Badtimes for Ultra90
+    Logical_source: imap_ultra_l1b_90sensor-badtimes
+    Logical_source_description: IMAP-Ultra Instrument Level-1B Badtimes Data.
+
+imap_ultra_l1c_45sensor-pset:
+    <<: *instrument_base
+    Data_level: 1C
+    Data_type: L1C_45Sensor-PSET>Level-1C Pointing Set Grid for Ultra45
+    Logical_source: imap_ultra_l1c_45sensor-pset
+    Logical_source_description: IMAP-Ultra Instrument Level-1C Pointing Set Grid Exposure Data.
+
+imap_ultra_l1c_90sensor-pset:
+    <<: *instrument_base
+    Data_level: 1C
+    Data_type: L1C_90Sensor-PSET>Level-1C Pointing Set Grid for Ultra90
+    Logical_source: imap_ultra_l1c_90sensor-pset
+    Logical_source_description: IMAP-Ultra Instrument Level-1C Pointing Set Grid Exposure Data.
+
+imap_ultra_l1c_45sensor-histogram:
+    <<: *instrument_base
+    Data_level: 1C
+    Data_type: L1C_45Sensor-Histogram>Level-1C Histogram for Ultra45
+    Logical_source: imap_ultra_l1c_45sensor-histogram
+    Logical_source_description: IMAP-Ultra Instrument Level-1C Pointing Set Grid Histogram Data.
+
+imap_ultra_l1c_90sensor-histogram:
+    <<: *instrument_base
+    Data_level: 1C
+    Data_type: L1C_45Sensor-Histogram>Level-1C Histogram for Ultra90
+    Logical_source: imap_ultra_l1c_90sensor-histogram
+    Logical_source_description: IMAP-Ultra Instrument Level-1C Pointing Set Grid Histogram Data.

imap_processing/cdf/config/imap_ultra_l1a_variable_attrs.yaml

@@ -0,0 +1,52 @@
+#  <=== Coordinates ===>
+# TODO: revisit this whole file
+ultra_metadata_attrs:
+  CATDESC: metadata # TODO: revisit this
+  FIELDNAM: metadata # TODO: revisit this
+  FILLVAL: -9223370000000000000
+  FORMAT: I19
+  LABLAXIS: Metadata
+  SCALE_TYP: linear
+  UNITS: " "
+  VALIDMIN: -9223372036854775808
+  VALIDMAX: 9223372036854775807
+  VAR_TYPE: support_data
+  DISPLAY_TYPE: time_series
+
+ultra_support_attrs:
+  CATDESC: Metadata for Ultra data
+  FIELDNAM: metadata
+  FILLVAL: -9223370000000000000
+  FORMAT: I19
+  LABLAXIS: "none"
+  SCALE_TYP: linear
+  UNITS: " "
+  VALIDMIN: -9223372036854775808
+  VALIDMAX: 9223372036854775807
+  VAR_TYPE: support_data
+  DISPLAY_TYPE: time_series
+
+string_base_attrs:
+  CATDESC: string metadata
+  FIELDNAM: string_metadata
+  FORMAT: A80
+  VAR_TYPE: metadata
+  DISPLAY_TYPE: no_plot
+  DEPEND_0: epoch
+
+packet_data_attrs:
+  CATDESC: packet data
+  FIELDNAM: packet_data
+  FILLVAL: -9223370000000000000
+  FORMAT: I19
+  LABLAXIS: "none"
+  SCALE_TYP: linear
+  VALIDMIN: -9223372036854775808
+  VALIDMAX: 9223372036854775807
+  VAR_TYPE: support_data
+  DISPLAY_TYPE: time_series
+  DEPEND_0: epoch
+  DEPEND_1: sid
+  DEPEND_2: row
+  DEPEND_3: column
+  UNITS: pixels