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

imap_processing/cdf/config/imap_idex_l1b_variable_attrs.yaml

@@ -31,21 +31,38 @@ l1b_data_base: &l1b_data_base
 
 l1b_tof_base: &l1b_tof_base
   <<: *l1b_data_base
-  DEPEND_1: time_high_sr
-  LABL_PTR_1: time_high_sr_label
+  DEPEND_1: time_high_sample_rate
+  LABL_PTR_1: time_high_sample_rate_label
 
 l1b_target_base: &l1b_target_base
   <<: *l1b_data_base
-  DEPEND_1: time_low_sr
-  LABL_PTR_1: time_low_sr_label
+  DEPEND_1: time_low_sample_rate
+  LABL_PTR_1: time_low_sample_rate_label
 
 trigger_base: &trigger_base
   <<: *l1b_data_base
   DISPLAY_TYPE: no_plot
-  CATDESC: ""
   UNITS: " "
 
+spice_base: &spice_base
+  <<: *l1b_data_base
+  VAR_TYPE: data
+  VALIDMIN: -180
+  VALIDMAX: 360
+  DISPLAY_TYPE: time_series
+  UNITS: Degrees
+
 # <=== Instrument Setting Attributes ===>
+trigger_mode:
+  <<: *string_base
+  FIELDNAM: Trigger Mode
+  CATDESC: Channel and mode that triggered the event
+
+trigger_level:
+  <<: *string_base
+  FIELDNAM: Trigger Level
+  CATDESC: Threshold signal level that triggered the event
+
 tof_high:
   <<: *l1b_tof_base
   CATDESC: Time of flight waveform on the high-gain channel
@@ -324,3 +341,75 @@ current_neg2p5v_bus:
   CATDESC: Negative current reading on -2.5V bus on LVPS Board (ADC 1 channel 7)
   LABLAXIS: Current
   UNITS: A
+
+# <=== Spice Data Attributes ===>
+# TODO: Get actual validmin and vaildmax for ephemeris attrs
+ephemeris_position_x:
+  <<: *spice_base
+  FIELDNAM: Position X
+  CATDESC: Cartesian coordinate X positions for the IMAP spacecraft in the ECLIPJ2000 frame.
+  LABLAXIS: Position X
+  UNITS: km
+
+ephemeris_position_y:
+  <<: *spice_base
+  FIELDNAM: Position Y
+  CATDESC: Cartesian coordinate Y positions for the IMAP spacecraft in the ECLIPJ2000 frame.
+  LABLAXIS: Position Y
+  UNITS: km
+
+ephemeris_position_z:
+  <<: *spice_base
+  FIELDNAM: Position Z
+  CATDESC: Cartesian coordinate Z positions for the IMAP spacecraft in the ECLIPJ2000 frame.
+  LABLAXIS: Position Z
+  UNITS: km
+
+ephemeris_velocity_x:
+  <<: *spice_base
+  FIELDNAM: Velocity X
+  CATDESC: Velocity X positions for the IMAP spacecraft in the ECLIPJ2000 frame.
+  LABLAXIS: Velocity X
+  UNITS: km/s
+
+ephemeris_velocity_y:
+  <<: *spice_base
+  FIELDNAM: Velocity Y
+  CATDESC: Velocity Y positions for the IMAP spacecraft in the ECLIPJ2000 frame.
+  LABLAXIS: Velocity Y
+  UNITS: km/s
+
+ephemeris_velocity_z:
+  <<: *spice_base
+  FIELDNAM: Velocity Z
+  CATDESC: Velocity Z positions for the IMAP spacecraft in the ECLIPJ2000 frame.
+  LABLAXIS: Velocity Z
+  UNITS: km/s
+
+right_ascension:
+  <<: *spice_base
+  VALIDMIN: 0
+  FIELDNAM: Right Ascension
+  CATDESC: Right ascension of the IMAP spacecraft position as observed from Earth in the ECLIPJ2000 reference frame.
+  LABLAXIS: Right Ascension
+
+declination:
+  <<: *spice_base
+  FIELDNAM: Declination
+  CATDESC: Declination of the IMAP spacecraft position as observed from Earth in the ECLIPJ2000 reference frame.
+  LABLAXIS: Declination
+
+spin_phase:
+  <<: *spice_base
+  VALIDMIN: 0
+  FIELDNAM: Spin Phase
+  CATDESC: IMAP Spin Phase
+  LABLAXIS: Spin Phase
+
+solar_longitude:
+  <<: *spice_base
+  VALIDMAX: 180
+  FIELDNAM: Solar Longitude
+  CATDESC: Solar Longitude of the IMAP spacecraft
+  LABLAXIS: Solar Longitude
+

imap_processing/cdf/config/imap_lo_l1a_variable_attrs.yaml

@@ -73,8 +73,10 @@ hist_az_6_default: &hist_az_6_default
 
 spin_default_attrs: &spin_default
   <<: *default
-  VAR_TYPE: support_data
+  VAR_TYPE: data
+  DEPEND_0: epoch
   DEPEND_1: spin
+  LABL_PTR_1: spin_label
 
 
 # Re-used Coordinate
@@ -424,8 +426,13 @@ spin:
   FIELDNAM: Spin numbers
   DEPEND_1: spin
   VAR_TYPE: support_data
-  LABLAXIS: spin numbers
+  LABLAXIS: Spin numbers
 
+spin_label:
+  CATDESC: Spin numbers in pointing
+  FIELDNAM: Spin numbers
+  FORMAT: A3
+  VAR_TYPE: metadata
 
 ## Spin Fields
 num_completed:
@@ -434,64 +441,85 @@ num_completed:
   VAR_TYPE: support_data
   CATDESC: Number of spins completed
   FIELDNAM: Number of spins completed
-  LABLAXIS: number of spins completed
+  LABLAXIS: Number of spins completed
 
-acq_end:
+acq_start_sec:
   <<: *default_uint32
   DEPEND_0: epoch
   VAR_TYPE: support_data
-  CATDESC: Acquisition End
-  FIELDNAM: Acquisition End
-  UNITS: ns
-  LABLAXIS: acquisition end
+  CATDESC: Acquisition start
+  FIELDNAM: Acquisition start seconds
+  UNITS: s
+  LABLAXIS: Acquisition start seconds
 
-spin_seconds:
+acq_start_subsec:
+  <<: *default_uint32
+  DEPEND_0: epoch
+  VAR_TYPE: support_data
+  CATDESC: Acquisition start
+  FIELDNAM: Acquisition start sub-seconds
+  UNITS: ms
+  LABLAXIS: Acquisition start sub-seconds
+
+acq_end_sec:
+  <<: *default_uint32
+  DEPEND_0: epoch
+  VAR_TYPE: support_data
+  CATDESC: Acquisition end
+  FIELDNAM: Acquisition end seconds
+  UNITS: s
+  LABLAXIS: Acquisition end seconds
+
+acq_end_subsec:
+    <<: *default_uint32
+    DEPEND_0: epoch
+    VAR_TYPE: support_data
+    CATDESC: Acquisition end
+    FIELDNAM: Acquisition end sub-seconds
+    UNITS: ms
+    LABLAXIS: Acquisition end sub-seconds
+
+start_sec_spin:
   <<: *spin_default
   <<: *default_uint32
-  CATDESC: Spin Start Seconds Time
-  FIELDNAM: Spin Start Seconds Time
-  UNITS: ns
-  LABLAXIS: spin start seconds time
+  CATDESC: Spin start seconds time
+  FIELDNAM: Spin start seconds time
+  UNITS: s
 
-spin_subseconds:
+start_subsec_spin:
   <<: *spin_default
   <<: *default_uint32
-  CATDESC: Spin Start Sub-Seconds Time
-  FIELDNAM: Spin Start Sub-Seconds Time
-  LABLAXIS: spin start sub-seconds time
+  CATDESC: Spin start sub-seconds time
+  FIELDNAM: Spin start sub-seconds time
+  UNITS: ms
 
-esa_p_dac:
+esa_pos_dac_spin:
   <<: *spin_default
   <<: *default_uint32
-  CATDESC: Positive ESA Set Point
-  FIELDNAM: Positive ESA Set Point
-  LABLAXIS: Positive ESA Set Point
+  CATDESC: Positive ESA set point
+  FIELDNAM: Positive ESA set point
 
-esa_n_dac:
+esa_neg_dac_spin:
   <<: *spin_default
   <<: *default_uint32
-  CATDESC: Negative ESA Set Point
-  FIELDNAM: Negative ESA Set Point
-  LABLAXIS: Negative ESA Set Point
+  CATDESC: Negative ESA set point
+  FIELDNAM: Negative ESA set point
 
-val_period:
+valid_period_spin:
   <<: *spin_default
   <<: *default_uint32
-  CATDESC: Valid Spin Period
-  FIELDNAM: Valid Spin Period
-  LABLAXIS: valid spin period
+  CATDESC: Valid spin period
+  FIELDNAM: Valid spin period
 
-val_spin:
+valid_phase_spin:
   <<: *spin_default
   <<: *default_uint32
-  CATDESC: Valid Spin Phase
-  FIELDNAM: Valid Spin Phase
-  LABLAXIS: valid spin phase
+  CATDESC: Valid spin phase
+  FIELDNAM: Valid spin phase
 
-source:
+period_source_spin:
   <<: *spin_default
   <<: *default_uint32
-  CATDESC: Spin Period Source
-  FIELDNAM: Spin Period Source
-  LABLAXIS: spin period source
+  CATDESC: Spin period source
+  FIELDNAM: Spin period source
 # Spin Attributes - END

imap_processing/cdf/config/imap_swapi_variable_attrs.yaml

@@ -93,6 +93,21 @@ metadata_default: &metadata_default
   VAR_TYPE: support_data
   SCALETYP: linear
 
+# Minimum attrs setting for HK data
+hk_attrs: &hk_attrs
+  CATDESC: Housekeeping data
+  FIELDNAM: Housekeeping
+  LABLAXIS: Values
+  DEPEND_0: epoch
+  DISPLAY_TYPE: time_series
+  FILLVAL: 4294967295
+  FORMAT: I19
+  UNITS: " "
+  VALIDMIN: 0
+  VALIDMAX: 9223372036854769664
+  VAR_TYPE: support_data
+  SCALETYP: linear
+
 pcem_counts:
   <<: *counts_default
   CATDESC: Primary Channel Electron Multiplier (CEM)  Counts
@@ -138,7 +153,7 @@ pcem_rate:
 scem_rate:
   <<: *rate_default
   CATDESC: Secondary Channel Electron Multiplier (CEM) Rates
-  FIELDNnam: Secondary CEM Rates
+  FIELDNAM: Secondary CEM Rates
   LABLAXIS: scem_rate
 
 coin_rate:

imap_processing/cdf/config/imap_swe_global_cdf_attrs.yaml

@@ -22,3 +22,10 @@ imap_swe_l1b_sci:
   Data_type: L1B_SCI>Level-1B Science data
   Logical_source: imap_swe_l1b_sci
   Logical_source_description: SWE Instrument Level-1B Science Data
+
+imap_swe_l2_sci:
+  <<: *instrument_base
+  Data_level: 2
+  Data_type: L2_SCI>Level-2 Science data
+  Logical_source: imap_swe_l2_sci
+  Logical_source_description: SWE Instrument Level-2 Science Data

imap_processing/cdf/config/imap_swe_l1a_variable_attrs.yaml

@@ -1,6 +1,6 @@
 # <=== Coordinates ===>
 
-spin_angle:
+spin_sector:
   CATDESC: 180 measurements per quarter cycle. See VAR_NOTES for details
   FIELDNAM: Spin Angle
   FILLVAL: -9223370000000000000
@@ -14,8 +14,8 @@ spin_angle:
     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
+cem_id:
+  CATDESC: This is id of 7 CEMs
   FIELDNAM: Polar Angle
   FILLVAL: -9223370000000000000
   FORMAT: I1
@@ -32,14 +32,14 @@ polar_angle:
 # 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:
+spin_sector_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
+cem_id_label:
+  CATDESC: This is id of 7 CEMs
   FIELDNAM: CEM Counts
   FORMAT: A1
   VAR_TYPE: metadata
@@ -62,10 +62,10 @@ default_attrs: &default
 raw_counts:
   CATDESC: Raw Counts stored in 8bits length
   DEPEND_0: epoch
-  DEPEND_1: spin_angle
-  DEPEND_2: polar_angle
-  LABL_PTR_1: spin_angle_label
-  LABL_PTR_2: polar_angle_label
+  DEPEND_1: spin_sector
+  DEPEND_2: cem_id
+  LABL_PTR_1: spin_sector_label
+  LABL_PTR_2: cem_id_label
   DISPLAY_TYPE: spectrogram
   FIELDNAM: Raw Counts
   FORMAT: I3
@@ -78,10 +78,10 @@ raw_counts:
 science_data:
   CATDESC: Decompressed Counts
   DEPEND_0: epoch
-  DEPEND_1: spin_angle
-  DEPEND_2: polar_angle
-  LABL_PTR_1: spin_angle_label
-  LABL_PTR_2: polar_angle_label
+  DEPEND_1: spin_sector
+  DEPEND_2: cem_id
+  LABL_PTR_1: spin_sector_label
+  LABL_PTR_2: cem_id_label
   DISPLAY_TYPE: spectrogram
   FIELDNAM: Decompressed Counts
   FORMAT: I5

imap_processing/cdf/config/imap_swe_l1b_variable_attrs.yaml

@@ -1,5 +1,5 @@
 # <=== Coordinates ===>
-energy:
+esa_step:
   CATDESC: Energy step id in lookup table
   FIELDNAM: energy step
   FILLVAL: -9223370000000000000
@@ -11,9 +11,9 @@ energy:
   VALIDMIN: 0
   VAR_TYPE: support_data
 
-angle:
+spin_sector:
   CATDESC: Spin angle step. Angle resolution is 12 degree nominally
-  FIELDNAM: spin angle
+  FIELDNAM: spin angle step
   FILLVAL: -9223370000000000000
   FORMAT: I2
   LABLAXIS: Angle
@@ -23,7 +23,7 @@ angle:
   VALIDMIN: 0
   VAR_TYPE: support_data
 
-cem:
+cem_id:
   CATDESC: Data rates of each CEM detectors
   FIELDNAM: rates
   FILLVAL: -9223370000000000000
@@ -38,7 +38,7 @@ cem:
 
 cycle:
   CATDESC: Full cycle data takes 4 spins' data
-  FIELDNAM: quater cycle
+  FIELDNAM: quarter cycle
   FILLVAL: -9223370000000000000
   FORMAT: I2
   LABLAXIS: Cycle
@@ -50,19 +50,19 @@ cycle:
 
 # <=== Label Attributes ===>
 # LABL_PTR_i expects VAR_TYPE of metadata with char data type
-energy_label:
+esa_step_label:
   CATDESC: Energy step id in lookup table
   FIELDNAM: Energy Step ID
   FORMAT: A2
   VAR_TYPE: metadata
 
-angle_label:
+spin_sector_label:
   CATDESC: Spin angle step. Angle resolution is 12 degree nominally
   FIELDNAM: 12 Degree Resolution
   FORMAT: A2
   VAR_TYPE: metadata
 
-cem_label:
+cem_id_label:
   CATDESC: Data rates of each CEM detectors
   FIELDNAM: CEM Rates
   FORMAT: A1
@@ -86,12 +86,12 @@ default_attrs: &default
 science_data:
   CATDESC: Electron count rates organized by voltage step and spin sector and CEM
   DEPEND_0: epoch
-  DEPEND_1: energy
-  DEPEND_2: angle
-  DEPEND_3: cem
-  LABL_PTR_1: energy_label
-  LABL_PTR_2: angle_label
-  LABL_PTR_3: cem_label
+  DEPEND_1: esa_step
+  DEPEND_2: spin_sector
+  DEPEND_3: cem_id
+  LABL_PTR_1: esa_step_label
+  LABL_PTR_2: spin_sector_label
+  LABL_PTR_3: cem_id_label
   DISPLAY_TYPE: spectrogram
   FIELDNAM: Counts rate by volt step and spin sector and CEM
   FORMAT: E14.7
@@ -104,22 +104,23 @@ science_data:
     Metadata field acq_duration is 17 uint. Max value of uint17 is 131071.
     Dividing max counts by acq_duration gave validmax
 
-sci_step_acq_time_sec:
-  CATDESC: Acquisition time organized by voltage step and spin sector and CEM
+acquisition_time:
+  CATDESC: Acquisition time organized by voltage step and spin sector
   DEPEND_0: epoch
-  DEPEND_1: energy
-  DEPEND_2: angle
-  DEPEND_3: cem
-  LABL_PTR_1: energy_label
-  LABL_PTR_2: angle_label
-  LABL_PTR_3: cem_label
+  DEPEND_1: esa_step
+  DEPEND_2: spin_sector
+  LABL_PTR_1: esa_step_label
+  LABL_PTR_2: spin_sector_label
   DISPLAY_TYPE: spectrogram
-  FIELDNAM: Acquisition by volt step and spin sector and CEM
+  FIELDNAM: Acquisition time by volt step and spin sector
   FILLVAL: -1.0000000E+31
   UNITS: sec
   VAR_TYPE: support_data
   VAR_NOTES: >
-    This stores acquisition times of each count data.
+    This stores the acquisition times of each measurement. This time is
+    calculated by combining ACQ_START_COARSE, ACQ_START_FINE,
+    acquisition duration and settle duration. It is time of each energy
+    step and each science measurement.
 
 shcoarse:
   <<: *default