imap-processing 1.0.1__py3-none-any.whl → 1.0.3__py3-none-any.whl

imap_processing/_version.py

@@ -1,3 +1,3 @@
 # These version placeholders will be replaced later during substitution.
-__version__ = "1.0.1"
-__version_tuple__ = (1, 0, 1)
+__version__ = "1.0.3"
+__version_tuple__ = (1, 0, 3)

imap_processing/cdf/config/imap_codice_global_cdf_attrs.yaml

@@ -241,6 +241,24 @@ imap_codice_l2_lo-sw-species:
   Logical_source: imap_codice_l2_lo-sw-species
   Logical_source_description: IMAP Mission CoDICE Lo Level-2 Sunward Species Intensity Data.
 
+imap_codice_l2_lo-nsw-species:
+  <<: *instrument_base
+  Data_type: L2_lo-nsw-species>Level-2 Lo Non-Sunward Species Intensities Data
+  Logical_source: imap_codice_l2_lo-nsw-species
+  Logical_source_description: IMAP Mission CoDICE Lo Level-2 Non-Sunward Species Intensity Data.
+
+imap_codice_l2_lo-sw-angular:
+  <<: *instrument_base
+  Data_type: L2_lo-sw-species>Level-2 Lo Sunward Angular Intensities Data
+  Logical_source: imap_codice_l2_lo-sw-angular
+  Logical_source_description: IMAP Mission CoDICE Lo Level-2 Sunward Angular Intensity Data.
+
+imap_codice_l2_lo-nsw-angular:
+  <<: *instrument_base
+  Data_type: L2_lo-nsw-species>Level-2 Lo Non-Sunward Angular Intensities Data
+  Logical_source: imap_codice_l2_lo-nsw-angular
+  Logical_source_description: IMAP Mission CoDICE Lo Level-2 Non-Sunward Angular Intensity Data.
+
 imap_codice_l2_hi-omni:
   <<: *instrument_base
   Data_type: L2_hi-omni>Level-2 Hi Omnidirectional Species Intensities Data

imap_processing/cdf/config/imap_codice_l1a_variable_attrs.yaml

@@ -63,8 +63,8 @@ hi_priorities_attrs: &hi_priorities_default
 epoch_delta_minus:
     CATDESC: Time from acquisition start to acquisition center
     FIELDNAM: epoch_delta_minus
-    FILLVAL: *int_fillval
-    FORMAT: I18
+    FILLVAL: *real_fillval
+    FORMAT: F30.9
     LABLAXIS: epoch_delta_minus
     SCALETYP: linear
     UNITS: ns
@@ -75,13 +75,13 @@ epoch_delta_minus:
 epoch_delta_plus:
     CATDESC: Time from acquisition center to acquisition end
     FIELDNAM: epoch_delta_plus
-    FILLVAL: *int_fillval
-    FORMAT: I18
+    FILLVAL: *real_fillval
+    FORMAT: F30.9
     LABLAXIS: epoch_delta_plus
     SCALETYP: linear
     UNITS: ns
-    VALIDMIN: *min_int
-    VALIDMAX: *max_int
+    VALIDMIN: *min_epoch
+    VALIDMAX: *max_epoch
     VAR_TYPE: support_data
 
 esa_step:
@@ -168,6 +168,18 @@ ssd_index:
     VALIDMAX: 12
     VAR_TYPE: support_data
 
+k_factor_attrs:
+    CATDESC: K Factor constant that is used to convert voltages to energies
+    DEPEND_1: k_factor
+    FIELDNAM: K Factor
+    FORMAT: F6.2
+    LABLAXIS: K Factor
+    SCALETYP: linear
+    UNITS: " "
+    VALIDMIN: 1.0
+    VALIDMAX: 100.0
+    VAR_TYPE: support_data
+
 # <=== Labels ===>
 esa_step_label:
     CATDESC: ESA Step
@@ -284,22 +296,23 @@ direct_events_attrs: &direct_events
     VALIDMIN: 0
     VALIDMAX: 10000
 
-energy_table:
-    CATDESC: ElectroStatic Analyzer Energy Values
+voltage_table:
+    CATDESC: ElectroStatic Analyzer Voltage Values
     DEPEND_1: esa_step
-    FIELDNAM: Energy Table
+    FIELDNAM: Voltage Table
     FORMAT: F12.6
-    LABLAXIS: eV
+    LABLAXIS: V
     SCALETYP: log
-    UNITS: eV
+    UNITS: V
     VALIDMIN: 1.0
     VALIDMAX: 14100.0
     VAR_TYPE: support_data
 
 k_factor:
     CATDESC: K Factor constant that is used to convert voltages to energies
+    DEPEND_1: k_factor
     FIELDNAM: K Factor
-    FORMAT: F5.2
+    FORMAT: F6.2
     LABLAXIS: K Factor
     SCALETYP: linear
     UNITS: " "
@@ -1142,61 +1155,42 @@ lo-counters-singles-apd_singles:
     LABL_PTR_2: spin_sector_pairs_label
     LABL_PTR_3: esa_step_label
 
-# lo-sw-angular
-lo-sw-angular-hplus:
-    <<: *counters
-    CATDESC: Sunward H+ Species
-    FIELDNAM: SW - H+
-    DEPEND_1: esa_step
-    DEPEND_2: inst_az
-    DEPEND_3: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: inst_az_label
-    LABL_PTR_3: spin_sector_label
-
-lo-sw-angular-heplusplus:
-    <<: *counters
-    CATDESC: Sunward He++ Species
-    FIELDNAM: SW - He++
-    DEPEND_1: esa_step
-    DEPEND_2: inst_az
-    DEPEND_3: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: inst_az_label
-    LABL_PTR_3: spin_sector_label
-
-lo-sw-angular-oplus6:
-    <<: *counters
-    CATDESC: Sunward O+6 Species
-    FIELDNAM: SW - O+6
-    DEPEND_1: esa_step
-    DEPEND_2: inst_az
-    DEPEND_3: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: inst_az_label
-    LABL_PTR_3: spin_sector_label
-
-lo-sw-angular-fe_loq:
-    <<: *counters
-    CATDESC: Sunward Fe lowQ Species
-    FIELDNAM: SW - Fe lowQ
+# lo-angular attribute templates (combined versions of the previous entries)
+lo-angular-attrs:
+    CATDESC: "{species} Sunward {direction} species"
+    DEPEND_0: epoch
     DEPEND_1: esa_step
-    DEPEND_2: inst_az
-    DEPEND_3: spin_sector
+    DEPEND_2: spin_sector
+    DEPEND_3: inst_az
+    DISPLAY_TYPE: time_series
+    FIELDNAM: "SW - {species}"
+    FILLVAL: *int_fillval
+    FORMAT: I7
     LABL_PTR_1: esa_step_label
-    LABL_PTR_2: inst_az_label
-    LABL_PTR_3: spin_sector_label
+    LABL_PTR_2: spin_sector_label
+    LABL_PTR_3: inst_az_label
+    UNITS: counts
+    VALIDMIN: 0
+    VALIDMAX: *max_uint32
+    VAR_TYPE: data
 
-lo-nsw-angular-heplusplus:
-    <<: *counters
-    CATDESC: Non-sunward He++ Species
-    FIELDNAM: NSW - He++
+lo-angular-unc-attrs:
+    CATDESC: "{species} Non-sunward {direction} species uncertainty"
+    DEPEND_0: epoch
     DEPEND_1: esa_step
-    DEPEND_2: inst_az
-    DEPEND_3: spin_sector
+    DEPEND_2: spin_sector
+    DEPEND_3: inst_az
+    DISPLAY_TYPE: time_series
+    FIELDNAM: "NSW - {species}"
+    FILLVAL: *int_fillval
+    FORMAT: I7
     LABL_PTR_1: esa_step_label
-    LABL_PTR_2: inst_az_label
-    LABL_PTR_3: spin_sector_label
+    LABL_PTR_2: spin_sector_label
+    LABL_PTR_3: inst_az_label
+    UNITS: counts
+    VALIDMIN: 0
+    VALIDMAX: *max_uint32
+    VAR_TYPE: data
 
 # lo-sw-priority
 lo-sw-priority-p0_tcrs:
@@ -1263,221 +1257,70 @@ lo-nsw-priority-p6_hplus_heplusplus:
     LABL_PTR_1: spin_sector_label
     LABL_PTR_2: esa_step_label
 
-# lo-sw-species
-lo-sw-species-hplus:
-    <<: *counters
-    CATDESC: H+ Sunward Species
-    FIELDNAM: SW - H+
-    DEPEND_1: esa_step
-    DEPEND_2: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: spin_sector_label
-
-lo-sw-species-heplusplus:
-    <<: *counters
-    CATDESC: He++ Sunward Species
-    FIELDNAM: SW - He++
-    DEPEND_1: esa_step
-    DEPEND_2: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: spin_sector_label
-
-lo-sw-species-cplus4:
-    <<: *counters
-    CATDESC: C+4 Sunward Species
-    FIELDNAM: SW - C+4
-    DEPEND_1: esa_step
-    DEPEND_2: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: spin_sector_label
-
-lo-sw-species-cplus5:
-    <<: *counters
-    CATDESC: C+5 Sunward Species
-    FIELDNAM: SW - C+5
-    DEPEND_1: esa_step
-    DEPEND_2: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: spin_sector_label
-
-lo-sw-species-cplus6:
-    <<: *counters
-    CATDESC: C+6 Sunward Species
-    FIELDNAM: SW - C+6
-    DEPEND_1: esa_step
-    DEPEND_2: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: spin_sector_label
-
-lo-sw-species-oplus5:
-    <<: *counters
-    CATDESC: O+5 Sunward Species
-    FIELDNAM: SW - O+5
-    DEPEND_1: esa_step
-    DEPEND_2: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: spin_sector_label
-
-lo-sw-species-oplus6:
-    <<: *counters
-    CATDESC: O+6 Sunward Species
-    FIELDNAM: SW - O+6
-    DEPEND_1: esa_step
-    DEPEND_2: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: spin_sector_label
-
-lo-sw-species-oplus7:
-    <<: *counters
-    CATDESC: O+7 Sunward Species
-    FIELDNAM: SW - O+7
-    DEPEND_1: esa_step
-    DEPEND_2: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: spin_sector_label
-
-lo-sw-species-oplus8:
-    <<: *counters
-    CATDESC: O+8 Sunward Species
-    FIELDNAM: SW - O+8
-    DEPEND_1: esa_step
-    DEPEND_2: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: spin_sector_label
-
-lo-sw-species-ne:
-    <<: *counters
-    CATDESC: Ne Sunward Species
-    FIELDNAM: SW - Ne
-    DEPEND_1: esa_step
-    DEPEND_2: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: spin_sector_label
-lo-sw-species-mg:
-    <<: *counters
-    CATDESC: Mg Sunward Species
-    FIELDNAM: SW - Mg
-    DEPEND_1: esa_step
-    DEPEND_2: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: spin_sector_label
-
-lo-sw-species-si:
-    <<: *counters
-    CATDESC: Si Sunward Species
-    FIELDNAM: SW - Si
-    DEPEND_1: esa_step
-    DEPEND_2: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: spin_sector_label
-lo-sw-species-fe_loq:
-    <<: *counters
-    CATDESC: Fe lowQ Sunward Species
-    FIELDNAM: SW - Fe lowQ
-    DEPEND_1: esa_step
-    DEPEND_2: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: spin_sector_label
-
-lo-sw-species-fe_hiq:
-    <<: *counters
-    CATDESC: Fe highQ Sunward Species
-    FIELDNAM: SW - Fe highQ
-    DEPEND_1: esa_step
-    DEPEND_2: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: spin_sector_label
-
-lo-sw-species-heplus:
-    <<: *counters
-    CATDESC: He+ Pickup Ion Sunward Species
-    FIELDNAM: SW - He+ (PUI)
-    DEPEND_1: esa_step
-    DEPEND_2: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: spin_sector_label
-
-lo-sw-species-cnoplus:
-    <<: *counters
-    CATDESC: CNO+ Pickup Ion Sunward Species
-    FIELDNAM: SW - CNO+ (PUI)
-    DEPEND_1: esa_step
-    DEPEND_2: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: spin_sector_label
-
-# lo-nsw-species
-lo-nsw-species-hplus:
-    <<: *counters
-    CATDESC: H+ Non-sunward Species
-    FIELDNAM: NSW - H+
-    DEPEND_1: esa_step
-    DEPEND_2: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: spin_sector_label
-
-lo-nsw-species-heplusplus:
-    <<: *counters
-    CATDESC: He++ Non-sunward Species
-    FIELDNAM: NSW - He++
-    DEPEND_1: esa_step
-    DEPEND_2: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: spin_sector_label
-
-lo-nsw-species-c:
-    <<: *counters
-    CATDESC: C Non-sunward Species
-    FIELDNAM: NSW - C
-    DEPEND_1: esa_step
-    DEPEND_2: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: spin_sector_label
-
-lo-nsw-species-o:
-    <<: *counters
-    CATDESC: O Non-sunward Species
-    FIELDNAM: NSW - O
-    DEPEND_1: esa_step
-    DEPEND_2: spin_sector
-    LABL_PTR_1: esa_step_label
-    LABL_PTR_2: spin_sector_label
-
-lo-nsw-species-ne_si_mg:
-    <<: *counters
-    CATDESC: Ne-Si-Mg Non-sunward Species
-    FIELDNAM: NSW - Ne_Si_Mg
+# lo species attrs
+lo-species-attrs:
+    CATDESC: "{species} {direction} Species"
+    DEPEND_0: epoch
     DEPEND_1: esa_step
     DEPEND_2: spin_sector
+    DISPLAY_TYPE: time_series
+    FIELDNAM: "{direction} - {species}"
+    FILLVAL: *int_fillval
+    FORMAT: I7
     LABL_PTR_1: esa_step_label
     LABL_PTR_2: spin_sector_label
+    UNITS: counts
+    VALIDMIN: 0
+    VALIDMAX: *max_uint32
+    VAR_TYPE: data
 
-lo-nsw-species-fe:
-    <<: *counters
-    CATDESC: Fe Non-sunward Species
-    FIELDNAM: NSW - Fe
+lo-pui-species-attrs:
+    CATDESC: "{species} Pickup Ion {direction} Species"
+    DEPEND_0: epoch
     DEPEND_1: esa_step
     DEPEND_2: spin_sector
+    DISPLAY_TYPE: time_series
+    FIELDNAM: "{direction} - {species}"
+    FILLVAL: *int_fillval
+    FORMAT: I7
     LABL_PTR_1: esa_step_label
     LABL_PTR_2: spin_sector_label
+    UNITS: counts
+    VALIDMIN: 0
+    VALIDMAX: *max_uint32
+    VAR_TYPE: data
 
-lo-nsw-species-heplus:
-    <<: *counters
-    CATDESC: He+ Non-sunward Species
-    FIELDNAM: NSW - He+
+lo-species-unc-attrs:
+    CATDESC: "{species} {direction} Species uncertainty"
+    DEPEND_0: epoch
     DEPEND_1: esa_step
     DEPEND_2: spin_sector
+    DISPLAY_TYPE: time_series
+    FIELDNAM: "{direction} - {species}"
+    FILLVAL: *real_fillval
+    FORMAT: F20.9
     LABL_PTR_1: esa_step_label
     LABL_PTR_2: spin_sector_label
+    UNITS: counts
+    VALIDMIN: 0
+    VALIDMAX: *max_uint32
+    VAR_TYPE: data
 
-lo-nsw-species-cnoplus:
-    <<: *counters
-    CATDESC: CNO+ Non-sunward Species
-    FIELDNAM: NSW - CNO+
+lo-pui-species-unc-attrs:
+    CATDESC: "{species} Pickup Ion {direction} Species uncertainty"
+    DEPEND_0: epoch
     DEPEND_1: esa_step
     DEPEND_2: spin_sector
+    DISPLAY_TYPE: time_series
+    FIELDNAM: "{direction} - {species}"
+    FILLVAL: *real_fillval
+    FORMAT: F20.9
     LABL_PTR_1: esa_step_label
     LABL_PTR_2: spin_sector_label
+    UNITS: counts
+    VALIDMIN: 0
+    VALIDMAX: *max_uint32
+    VAR_TYPE: data
 
 # lo-ialirt
 lo-ialirt-heplusplus:

imap_processing/cdf/config/imap_enamaps_l2-common_variable_attrs.yaml

@@ -216,7 +216,7 @@ geometric_function:
   <<: *default_float32
   CATDESC: Averaged aperture area as seen by the backstop.
   FIELDNAM: Geometric Function
-  UNITS: cm^2 sr
+  UNITS: cm^2
   VAR_TYPE: support_data
   LABLAXIS: Geometric Function
   DISPLAY_TYPE: no_plot

imap_processing/cdf/config/imap_hi_variable_attrs.yaml

@@ -432,8 +432,18 @@ hi_de_nominal_bin:
 
 # Define override values for epoch as defined in imap_constant_attrs.yaml
 hi_pset_epoch:
-  CATDESC: Midpoint time of pointing, number of nanoseconds since J2000 with leap seconds included
-  BIN_LOCATION: 0.5
+  CATDESC: Start time of pointing, number of nanoseconds since J2000 with leap seconds included
+  DELTA_PLUS_VAR: epoch_delta
+  BIN_LOCATION: 0
+
+epoch_delta:
+  <<: *default_int64
+  CATDESC: Number of nanoseconds in spacecraft pointing covered by this pointing set product
+  FIELDNAM: epoch delta
+  UNITS: ns
+  VAR_TYPE: support_data
+  DISPLAY_TYPE: no_plot
+  TIME_SCALE: Terrestrial Time
 
 hi_pset_esa_energy_step:
   <<: *default_esa_energy_step

imap_processing/cdf/config/imap_idex_global_cdf_attrs.yaml

@@ -58,16 +58,9 @@ imap_idex_l2b_sci:
   Logical_source: imap_idex_l2b_sci-1mo
   Logical_source_description: IMAP Mission IDEX Instrument Level-2B Monthly Data
 
-imap_idex_l2c_sci-healpix:
-  <<: *instrument_base
-  Data_level: 2C
-  Data_type: L2C_HEALPIX-MAP-1MO>Level-2C HEALPIX Map Monthly Data
-  Logical_source: imap_idex_l2c_healpix-map-1mo
-  Logical_source_description: IMAP Mission IDEX Instrument Level-2C Monthly Data Healpix
-
 imap_idex_l2c_sci-rectangular:
   <<: *instrument_base
   Data_level: 2C
   Data_type: L2C_RECTANGULAR-MAP-1MO>Level-2C Rectangular Map Monthly Data
   Logical_source: imap_idex_l2c_rectangular-map-1mo
-  Logical_source_description: IMAP Mission IDEX Instrument Level-2C Monthly Data Rectangular
+  Logical_source_description: IMAP Mission IDEX Instrument Level-2C Rectangular Map Monthly Data

imap_processing/cdf/config/imap_idex_l1b_variable_attrs.yaml

@@ -3,6 +3,8 @@ double_fillval: &double_fillval -1.0E31
 
 data_min: &data_min 0
 data_max: &data_max 4095
+spice_data_min: &spice_data_min -2.0e7
+spice_data_max: &spice_data_max 2.0e7
 
 # <=== Base Attributes ===>
 string_base_attrs: &string_base
@@ -47,7 +49,8 @@ spice_base: &spice_base
   <<: *l1b_data_base
   VAR_TYPE: data
   DISPLAY_TYPE: time_series
-  UNITS: Degrees
+  VALIDMIN: *spice_data_min
+  VALIDMAX: *spice_data_max
 
 # <=== Instrument Setting Attributes ===>
 trigger_mode:
@@ -342,7 +345,6 @@ current_neg2p5v_bus:
   UNITS: A
 
 # <=== Spice Data Attributes ===>
-# TODO: Get actual validmin and vaildmax for ephemeris attrs
 ephemeris_position_x:
   <<: *spice_base
   FIELDNAM: Position X
@@ -362,7 +364,7 @@ ephemeris_position_y:
 ephemeris_position_z:
   <<: *spice_base
   FIELDNAM: Position Z
-  CATDESC: Cartesian coordinate Z positions for the IMAP spacecraft in the ECLIPJ2000 frame.
+  CATDESC: Cartesian coord Z positions for the IMAP spacecraft in the ECLIPJ2000 frame.
   LABLAXIS: Position Z
   UNITS: km
   DICT_KEY: SPASE>Support>SupportQuantity:Positional
@@ -395,33 +397,42 @@ ephemeris_velocity_z:
 longitude:
   <<: *spice_base
   VALIDMIN: 0
+  VALIDMAX: 360
   FIELDNAM: Longitude
   CATDESC: Longitude of the dust event as observed from Earth in the ECLIPJ2000 frame.
   LABLAXIS: Longitude
+  UNITS: Degrees
   DICT_KEY: SPASE>Support>SupportQuantity:Longitude
 
 latitude:
   <<: *spice_base
+  VALIDMIN: -90
+  VALIDMAX: 90
   FIELDNAM: Latitude
   CATDESC: Latitude of the dust event as observed from Earth in the ECLIPJ2000 frame.
   LABLAXIS: Latitude
+  UNITS: Degrees
   DICT_KEY: SPASE>Support>SupportQuantity:Latitude
 
 spin_phase:
   <<: *spice_base
   VALIDMIN: 0
+  VALIDMAX: 360
   FIELDNAM: Spin Phase
   CATDESC: IMAP Spin Phase
   LABLAXIS: Spin Phase
-  FORMAT: F12.6
-  FILLVAL: *double_fillval
+  FORMAT: I3
+  FILLVAL: *int_fillval
+  UNITS: Degrees
   DICT_KEY: SPASE>Support>SupportQuantity:SpinPhase
 
 solar_longitude:
   <<: *spice_base
+  VALIDMIN: -180
   VALIDMAX: 180
   FIELDNAM: Solar Longitude
   CATDESC: Solar Longitude of the IMAP spacecraft
   LABLAXIS: Solar Longitude
+  UNITS: Degrees
   DICT_KEY: SPASE>Support>SupportQuantity:Longitude