imap-processing 0.7.0__py3-none-any.whl → 0.9.0__py3-none-any.whl

imap_processing/cdf/config/imap_idex_l1b_variable_attrs.yaml

@@ -0,0 +1,326 @@
+int_fillval: &int_fillval -9223372036854775808
+
+max_uint16: &max_uint16 65535
+
+data_min: &data_min 0
+data_max: &data_max 4095
+
+# <=== Base Attributes ===>
+string_base_attrs: &string_base
+  CATDESC: " "
+  FIELDNAM: " "
+  FORMAT: A3
+  LABLAXIS: "none"
+  VAR_TYPE: metadata
+  DISPLAY_TYPE: no_plot
+  DEPEND_0: epoch
+  UNITS: " "
+
+l1b_data_base: &l1b_data_base
+  VALIDMIN: *data_min
+  VALIDMAX: *data_max
+  DISPLAY_TYPE: spectrogram
+  DEPEND_0: epoch
+  FORMAT: I12
+  UNITS: pC
+  VAR_TYPE: data
+  CATDESC: ""
+  FIELDNAM: ""
+  FILLVAL: *max_uint16
+  LABLAXIS: ""
+
+l1b_tof_base: &l1b_tof_base
+  <<: *l1b_data_base
+  DEPEND_1: time_high_sr
+  LABL_PTR_1: time_high_sr_label
+
+l1b_target_base: &l1b_target_base
+  <<: *l1b_data_base
+  DEPEND_1: time_low_sr
+  LABL_PTR_1: time_low_sr_label
+
+trigger_base: &trigger_base
+  <<: *l1b_data_base
+  DISPLAY_TYPE: no_plot
+  CATDESC: ""
+  UNITS: " "
+
+# <=== Instrument Setting Attributes ===>
+tof_high:
+  <<: *l1b_tof_base
+  CATDESC: Time of flight waveform on the high-gain channel
+  FIELDNAM: High Gain Time of Flight
+  LABLAXIS: TOF High Ampl
+  VAR_NOTES: High gain channel of the time-of-flight signal.
+        Sampled at 260 Megasamples per second, with a 10-bit resolution.
+        Data is used to quantify dust composition.
+
+tof_mid:
+  <<: *l1b_tof_base
+  CATDESC: Time of flight waveform on the mid-gain channel
+  FIELDNAM: Mid Gain Time of Flight
+  LABLAXIS: TOF Mid Ampl
+  VAR_NOTES: Mid gain channel of the time-of-flight signal.
+        Sampled at 260 Megasamples per second, with a 10-bit resolution.
+        Data is used to quantify dust composition.
+
+tof_low:
+  <<: *l1b_tof_base
+  CATDESC: Time of flight waveform on the low-gain channel
+  FIELDNAM: Low Gain Time of Flight
+  LABLAXIS: TOF Low Ampl
+  VAR_NOTES: Low gain channel of the time-of-flight signal.
+        Sampled at 260 Megasamples per second, with a 10-bit resolution.
+        Data is used to quantify dust composition.
+
+
+target_low:
+  <<: *l1b_target_base
+  CATDESC: Target low charge sensitive amplifier waveform
+  FIELDNAM: Low Target Signal
+  LABLAXIS: Low Target Ampl
+  VAR_NOTES: Low gain channel of IDEX's target signal.
+        Sampled at 3.75 Msps with 12-bit resolution.
+        Data is used to quantify dust charge.
+
+target_high:
+  <<: *l1b_target_base
+  CATDESC: Ion grid charge sensitive amplifier waveform
+  FIELDNAM: High Target Signal
+  LABLAXIS: High Target Ampl
+  VAR_NOTES: High gain channel of IDEX's target signal.
+        Sampled at 3.75 Msps with 12-bit resolution.
+        Data is used to quantify dust charge.
+
+ion_grid:
+  <<: *l1b_target_base
+  CATDESC: Ion grid charge sensitive amplifier waveform data
+  FIELDNAM: Ion Grid Signal
+  LABLAXIS: Ion Grid Ampl
+  VAR_NOTES: This is the ion grid signal from IDEX.
+        Sampled at 3.75 Msps with 12-bit resolution.
+        Data is used to quantify dust charge.
+
+detector_voltage:
+  <<: *trigger_base
+  FIELDNAM: Detector Voltage
+  CATDESC: Voltage reading of Detector on HVPS Board (ADC Channel 0)
+  LABLAXIS: Voltage
+  UNITS: V
+
+sensor_voltage:
+  <<: *trigger_base
+  FIELDNAM: Sensor Voltage
+  CATDESC: Voltage reading of Detector on HVPS Board (ADC Channel 0)
+  LABLAXIS: Voltage
+  UNITS: V
+
+target_voltage:
+  <<: *trigger_base
+  FIELDNAM: Target Voltage
+  CATDESC: Voltage reading of Target on HVPS Board  (ADC Channel 2)
+  LABLAXIS: Voltage
+  UNITS: V
+
+reflectron_voltage:
+  <<: *trigger_base
+  FIELDNAM: Reflectron Voltage
+  CATDESC: Voltage reading of Reflectron on HVPS Board  (ADC Channel 3)
+  LABLAXIS: Voltage
+  UNITS: V
+
+rejection_voltage:
+  <<: *trigger_base
+  FIELDNAM: Rejection Voltage
+  CATDESC: Voltage reading of Rejection on HVPS Board (ADC Channel 4)
+  LABLAXIS: Voltage
+  UNITS: V
+
+current_hvps_sensor:
+  <<: *trigger_base
+  FIELDNAM: Detector Current
+  CATDESC: Reading of Detector current on HVPS Board (ADC Channel 5)
+  LABLAXIS: Current
+  UNITS: mA
+
+current_1v_pol:
+  <<: *trigger_base
+  FIELDNAM: 1V POL Current
+  CATDESC: High side current reading on 1.0V bus on Processor Board (ADC channel 0)
+  LABLAXIS: Current
+  UNITS: mA
+
+current_1p9v_pol:
+  <<: *trigger_base
+  FIELDNAM: 1.9V POL Current
+  CATDESC: High side current reading on 1.9V bus on Processor Board (ADC channel 1)
+  LABLAXIS: Current
+  UNITS: mA
+
+temperature_1:
+  <<: *trigger_base
+  FIELDNAM: ProcBd Temp1
+  CATDESC: Temperature reading near high speed ADCs on Processor Board (ADC channel 2)
+  LABLAXIS: Temperature
+  UNITS: C
+
+temperature_2:
+  <<: *trigger_base
+  FIELDNAM: ProcBd Temp2
+  CATDESC: Temperature reading near center of Processor Board (ADC channel 3)
+  LABLAXIS: Temperature
+  UNITS: C
+
+voltage_1v_bus:
+  <<: *trigger_base
+  FIELDNAM: 1V Voltage
+  CATDESC: Voltage reading of 1.0V bus on Processor Board (ADC channel 4)
+  LABLAXIS: Voltage
+  UNITS: V
+
+fpga_temperature:
+  <<: *trigger_base
+  FIELDNAM: FPGA Temp
+  CATDESC: Temperature reading on FPGA on Processor Board (ADC channel 5)
+  LABLAXIS: Temperature
+  UNITS: C
+
+voltage_1p9v_bus:
+  <<: *trigger_base
+  FIELDNAM: 1.9V Voltage
+  CATDESC: Voltage reading of 1.9V bus on Processor Board (ADC channel 6)
+  LABLAXIS: Voltage
+  UNITS: V
+
+voltage_3p3v_bus:
+  <<: *trigger_base
+  FIELDNAM: 3.3V Voltage
+  CATDESC: Voltage reading of 3.3V bus on Processor Board (ADC channel 7)
+  LABLAXIS: Voltage
+  UNITS: V
+
+positive_current_hvps:
+  <<: *trigger_base
+  FIELDNAM: Sensor IP
+  CATDESC: Reading of HVPS Sensor positive current (ADC Channel 6)
+  LABLAXIS: Current
+  UNITS: mA
+
+negative_current_hvps:
+  <<: *trigger_base
+  FIELDNAM: Sensor IN
+  CATDESC: Reading of HVPS Sensor negative current (ADC Channel 7)
+  LABLAXIS: Current
+  UNITS: mA
+
+voltage_3p3_ref:
+  <<: *trigger_base
+  FIELDNAM: P3.3VREF_HK
+  CATDESC: Positive voltage reading on +3.3V bus Housekeeping reference on LVPS Board (ADC 0 channel 0)
+  LABLAXIS: Voltage
+  UNITS: V
+
+voltage_3p3_op_ref:
+  <<: *trigger_base
+  FIELDNAM: P3.3VREF_OP
+  CATDESC: Positive voltage reading on +3.3V bus Operations reference on LVPS Board (ADC 0 channel 1)
+  LABLAXIS: Voltage
+  UNITS: V
+
+voltage_neg6v_bus:
+  <<: *trigger_base
+  FIELDNAM: N6V
+  CATDESC: Negative voltage reading on -6V bus on LVPS Board (ADC 0 channel 2)
+  LABLAXIS: Voltage
+  UNITS: V
+
+voltage_pos6v_bus:
+  <<: *trigger_base
+  FIELDNAM: P6V
+  CATDESC: Positive voltage reading on +6V bus on LVPS Board (ADC 0 channel 3)
+  LABLAXIS: Voltage
+  UNITS: V
+
+voltage_pos16v_bus:
+  <<: *trigger_base
+  FIELDNAM: P16V
+  CATDESC: Positive voltage reading on +16V bus on LVPS Board (ADC 0 channel 4)
+  LABLAXIS: Voltage
+  UNITS: V
+
+voltage_pos3p3v_bus:
+  <<: *trigger_base
+  FIELDNAM: P3.3V
+  CATDESC: Positive voltage reading on +3.3V bus on LVPS Board (ADC 0 channel 5)
+  LABLAXIS: Voltage
+  UNITS: V
+
+voltage_neg5v_bus:
+  <<: *trigger_base
+  FIELDNAM: N5V
+  CATDESC: Negative voltage reading on -5V bus on LVPS Board (ADC 0 channel 6)
+  LABLAXIS: Voltage
+  UNITS: V
+
+voltage_pos5v_bus:
+  <<: *trigger_base
+  FIELDNAM: P5V
+  CATDESC: Positive voltage reading on +5V bus on LVPS Board (ADC 0 channel 7)
+  LABLAXIS: Voltage
+  UNITS: V
+
+current_3p3_bus:
+  <<: *trigger_base
+  FIELDNAM: P3.3_IMON
+  CATDESC: Positive current reading on +3.3V bus on LVPS Board (ADC 1 channel 0)
+  LABLAXIS: Current
+  UNITS: A
+
+current_16v_bus:
+  <<: *trigger_base
+  FIELDNAM: P16V_IMON
+  CATDESC: Positive current reading on +16V bus on LVPS Board (ADC 1 channel 1)
+  LABLAXIS: Current
+  UNITS: A
+
+current_6v_bus:
+  <<: *trigger_base
+  FIELDNAM: P6V_IMON
+  CATDESC: Positive current reading on +6V bus on LVPS Board (ADC 1 channel 2)
+  LABLAXIS: Current
+  UNITS: A
+
+current_neg6v_bus:
+  <<: *trigger_base
+  FIELDNAM: N6V_IMON
+  CATDESC: Negative current reading on -6V bus on LVPS Board (ADC 1 channel 3)
+  LABLAXIS: Current
+  UNITS: A
+
+current_5v_bus:
+  <<: *trigger_base
+  FIELDNAM: P5V_IMON
+  CATDESC: Positive current reading on +5V bus on LVPS Board (ADC 1 channel 4)
+  LABLAXIS: Current
+  UNITS: A
+
+current_neg5v_bus:
+  <<: *trigger_base
+  FIELDNAM: N5V_IMON
+  CATDESC: Negative current reading on -5V bus on LVPS Board (ADC 1 channel 5)
+  LABLAXIS: Current
+  UNITS: A
+
+current_2p5v_bus:
+  <<: *trigger_base
+  FIELDNAM: P2.5V_IMON
+  CATDESC: Positive current reading on +2.5V bus on LVPS Board (ADC 1 channel 6)
+  LABLAXIS: Current
+  UNITS: A
+
+current_neg2p5v_bus:
+  <<: *trigger_base
+  FIELDNAM: N2.5V_IMON
+  CATDESC: Negative current reading on -2.5V bus on LVPS Board (ADC 1 channel 7)
+  LABLAXIS: Current
+  UNITS: A

imap_processing/cdf/config/imap_lo_l1a_variable_attrs.yaml

@@ -51,6 +51,7 @@ de_default_attrs: &de_default
   <<: *default
   VAR_TYPE: support_data
   DEPEND_1: direct_events
+  LABL_PTR_1: direct_events_label
 
 hist_az_60_default: &hist_az_60_default
   <<: *default_uint32
@@ -58,6 +59,8 @@ hist_az_60_default: &hist_az_60_default
   DEPEND_0: epoch
   DEPEND_1: azimuth_60
   DEPEND_2: esa_step
+  LABL_PTR_1: azimuth_60_label
+  LABL_PTR_2: esa_step_label
 
 hist_az_6_default: &hist_az_6_default
   <<: *default_uint32
@@ -65,6 +68,8 @@ hist_az_6_default: &hist_az_6_default
   DEPEND_0: epoch
   DEPEND_1: azimuth_6
   DEPEND_2: esa_step
+  LABL_PTR_1: azimuth_6_label
+  LABL_PTR_2: esa_step_label
 
 spin_default_attrs: &spin_default
   <<: *default
@@ -88,7 +93,7 @@ esa_step_label:
    FORMAT: A1
    VAR_TYPE: metadata
 
-esa_step:
+esa_step_coord:
   <<: *coord_default
   <<: *default_uint8
   VALIDMIN: 1
@@ -111,6 +116,12 @@ shcoarse:
 
 # Direct Events Attributes
 ## Coordinates
+direct_events_label:
+   CATDESC: Direct Events
+   FIELDNAM: DE
+   FORMAT: A15
+   VAR_TYPE: metadata
+
 direct_events:
   <<: *de_default
   <<: *default_uint32
@@ -129,6 +140,16 @@ de_time:
   UNITS: microseconds
   LABLAXIS: DE time
 
+esa_step:
+  <<: *de_default
+  <<: *default_uint8
+  VALIDMIN: 1
+  VALIDMAX: 7
+  FORMAT: I1
+  CATDESC: Energy Step
+  FIELDNAM: Energy Step
+  LABLAXIS: ESA
+
 mode:
   <<: *de_default
   <<: *default_uint8
@@ -204,11 +225,22 @@ coincidence_type:
 de_count:
   <<: *default
   <<: *default_uint16
+  VAR_TYPE: data
   VALIDMAX: 32767
   DEPEND_0: epoch
   CATDESC: Direct Event Counts
   FIELDNAM: Direct Event Count
   LABLAXIS: Direct Event Count
+
+passes:
+  <<: *default
+  <<: *default_uint16
+  VAR_TYPE: data
+  VALIDMAX: 32767
+  DEPEND_0: epoch
+  CATDESC: Passes through raw data
+  FIELDNAM: Direct Event Passes
+  LABLAXIS: Direct Event Passes
 # Direct Events Attributes - END
 
 # Histogram Attributes
@@ -250,133 +282,111 @@ start_a:
   <<: *hist_az_60_default
   CATDESC: Anode A Singles count
   FIELDNAM: Anode A Singles Count
-  LABLAXIS: anode A singles counts
 
 start_c:
   <<: *hist_az_60_default
   CATDESC: Anode C Singles count
   FIELDNAM: Anode C Singles count
-  LABLAXIS: anode c singles count
 
 stop_b0:
   <<: *hist_az_60_default
   CATDESC: Ion B0 Singles count
   FIELDNAM: Ion B0 Singles count
-  LABLAXIS: ion B0 singles count
 
 stop_b3:
   <<: *hist_az_60_default
   CATDESC: Ion B3 Singles count
   FIELDNAM: Ion B3 Singles count
-  LABLAXIS: ion B3 singles count
 
 tof0_count:
   <<: *hist_az_60_default
   CATDESC: Time of Flight 0 count
   FIELDNAM: Time of Flight 0 count
-  LABLAXIS: ToF 0 count
 
 tof1_count:
   <<: *hist_az_60_default
   CATDESC: Time of Flight 1 count
   FIELDNAM: Time of Flight 1 count
-  LABLAXIS: ToF 1 count
 
 tof2_count:
   <<: *hist_az_60_default
   CATDESC: Time of Flight 2 count
   FIELDNAM: Time of Flight 2 count
-  LABLAXIS: ToF 2 count
 
 tof3_count:
   <<: *hist_az_60_default
   CATDESC: Time of Flight 3 count
   FIELDNAM: Time of Flight 3 count
-  LABLAXIS: ToF 3 count
 
 tof0_tof1:
   <<: *hist_az_6_default
   catdesc: Triple Coincidence 0/1 count
   FIELDNAM: Triple Coincidence 0/1 count
-  LABLAXIS: triple coincidence 0/1 count
 
 tof0_tof2:
   <<: *hist_az_6_default
   CATDESC: Triple Coincidence 0/2 count
   FIELDNAM: Triple Coincidence 0/2 count
-  LABLAXIS: triple coincidence 0/2 count
 
 tof1_tof2:
   <<: *hist_az_6_default
   catdesc: Triple Coincidence 1/2 count
   FIELDNAM: Triple Coincidence 1/2 count
-  LABLAXIS: triple 1/2 coincidence count
 
 silver:
   <<: *hist_az_6_default
   CATDESC: Triple Coincidence silver count
   FIELDNAM: Triple Coincidence silver count
-  LABLAXIS: triple coincidence silver count
 
 disc_tof0:
   <<: *hist_az_60_default
   CATDESC: Discarded Time of Flight 0 count
   FIELDNAM: Discarded Time of Flight 0 count
-  LABLAXIS: discarded ToF 0 count
 
 disc_tof1:
   <<: *hist_az_60_default
   CATDESC: Discarded Time of Flight 1 count
   FIELDNAM: Discarded Time of Flight 1 count
-  LABLAXIS: discarded ToF 1 count
 
 disc_tof2:
   <<: *hist_az_60_default
   CATDESC: Discarded Time of Flight 2 count
   FIELDNAM: Discarded Time of Flight 2 count
-  LABLAXIS: discarded ToF 2 count
 
 disc_tof3:
   <<: *hist_az_60_default
   CATDESC: Discarded Time of Flight 3 count
   FIELDNAM: Discarded Time of Flight 3 count
-  LABLAXIS: discarded ToF 3 count
 
 pos0:
   <<: *hist_az_60_default
   CATDESC: Position 0 count
   FIELDNAM: Position 0 count
-  LABLAXIS: position 0 count
 
 pos1:
   <<: *hist_az_60_default
   CATDESC: Position 1 count
   FIELDNAM: Position 1 count
-  LABLAXIS: position 1 count
 
 pos2:
   <<: *hist_az_60_default
   CATDESC: Position 2 count
   FIELDNAM: Position 2 count
-  LABLAXIS: position 2 count
 
 pos3:
   <<: *hist_az_60_default
   CATDESC: Position 3 count
   FIELDNAM: Position 3 count
-  LABLAXIS: position 3 count
 
 hydrogen:
   <<: *hist_az_6_default
   CATDESC: Hydrogen count
   FIELDNAM: Hydrogen count
-  LABLAXIS: hydrogen count
 
 oxygen:
   <<: *hist_az_6_default
   CATDESC: Oxygen count
   FIELDNAM: Oxygen count
-  LABLAXIS: oxygen count
 # Histogram Attributes - END
 
 # Star Sensor Attributes

imap_processing/cdf/config/imap_mag_l1_variable_attrs.yaml

@@ -1,20 +1,5 @@
 # <=== 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
-direction_label:
-  CATDESC: magnetic field vector data
-  FIELDNAM: Magnetic Field Vector
-  FORMAT: A3
-  VAR_TYPE: metadata
-
-compression_label:
-  CATDESC: Compression and width
-  FIELDNAM: Compression and width
-  FORMAT: A2
-  VAR_TYPE: metadata
-
 default_attrs: &default
   # Assumed values for all variable attrs unless overwritten
   DEPEND_0: epoch
@@ -29,40 +14,50 @@ default_attrs: &default
 default_coords: &default_coords
   # Assumed values for all coordinate attrs unless overwritten
   FORMAT: F2.4  # Float with 4 digits
-  VAR_TYPE: data
+  VAR_TYPE: support_data
   DISPLAY_TYPE: time_series
   FILLVAL: -9223372036854775808
   VALIDMIN: -9223372036854775808
   VALIDMAX: 9223372036854775807
   UNITS: counts
 
+mag_support_attrs: &support_default
+    <<: *default
+    VAR_TYPE: support_data
+
+mag_metadata_attrs: &metadata_default
+    <<: *default
+    VAR_TYPE: metadata
+
+direction_label:
+  CATDESC: magnetic field vector data
+  FIELDNAM: Magnetic Field Vector
+  FORMAT: A3
+  VAR_TYPE: metadata
+
+compression_label:
+  CATDESC: Compression and width
+  FIELDNAM: Compression and width
+  FORMAT: A2
+  VAR_TYPE: metadata
+
 raw_vector_attrs:
-  <<: *default_coords
+  <<: *default
   CATDESC: Raw unprocessed magnetic field vector data in bytes
-  DEPEND_0: epoch
   DEPEND_1: direction
   LABL_PTR_1: direction_label
   FIELDNAM: Magnetic Field Vector
   FORMAT: I3
 
 vector_attrs:
-    <<: *default_coords
+    <<: *default
     CATDESC: Magnetic field vector with x y z and sensor range varying by time
-    DEPEND_0: epoch
     DEPEND_1: direction
     FIELDNAM: Magnetic Field Vector
     LABL_PTR_1: direction_label
     FILLVAL: 9223372036854775807
     FORMAT: I3
 
-mag_support_attrs: &support_default
-    <<: *default
-    VAR_TYPE: support_data
-
-mag_metadata_attrs: &metadata_default
-    <<: *default
-    VAR_TYPE: metadata
-
 mag_flag_attrs:
     <<: *default
     VALIDMIN: 0
@@ -100,6 +95,7 @@ compression_flags_attrs:
   <<: *support_default
   CATDESC: Compression information per time stamp, includes a flag and the compression width
   FIELDNAM: Compression information per time stamp
+  DEPEND_0: epoch
   DEPEND_1: compression
   FORMAT: I2
   VALIDMAX: 21

imap_processing/cdf/config/imap_ultra_l1a_variable_attrs.yaml

@@ -25,6 +25,7 @@ ultra_support_attrs:
   VALIDMAX: 9223372036854775807
   VAR_TYPE: support_data
   DISPLAY_TYPE: time_series
+  DEPEND_0: epoch
 
 string_base_attrs:
   CATDESC: string metadata