Merge branch 'main' into glows-lat-lon

Author: Menlo Innovations - CAVA Project

imap_l3_processing/cdf/cdf_utils.py

@@ -4,6 +4,7 @@
 from spacepy import pycdf
 from spacepy.pycdf import CDF
 
+from imap_processing.ena_maps.utils import naming
 from imap_l3_processing.cdf.imap_attribute_manager import ImapAttributeManager
 from imap_l3_processing.swapi.l3a.models import DataProduct
 
@@ -20,12 +21,24 @@ def write_cdf(file_path: str, data: DataProduct, attribute_manager: ImapAttribut
         for k, v in global_attrs.items():
             cdf.attrs[k] = v
 
+        map_descriptor = None
+        if data.input_metadata.instrument in ("lo", "hi", "ultra", "glows",):
+            try:
+                map_descriptor = naming.MapDescriptor.from_string(data.input_metadata.descriptor)
+            except ValueError:
+                # Assume this is not actually a map
+                pass
+
         for data_product in data.to_data_product_variables():
             var_name = data_product.name
             variable_attributes = attribute_manager.get_variable_attributes(var_name)
             data_type = getattr(pycdf.const, variable_attributes["DATA_TYPE"])
             data_array = np.asanyarray(data_product.value)
 
+            if (map_descriptor is not None
+                and var_name == map_descriptor.principal_data_var):
+                variable_attributes["CATDESC"] = map_descriptor.to_catdesc()
+
             record_varying = variable_attributes["RECORD_VARYING"].lower() == "rv"
             if record_varying:
                 dims = data_array.shape[1:]

imap_l3_processing/cdf/config/imap_codice_l3a_hi-direct-events_variable_attrs.yaml

@@ -41,11 +41,11 @@ epoch:
   NAME: epoch
   CATDESC: Time, number of nanoseconds since J2000 with leap seconds included
   VAR_TYPE: support_data
-  DISPLAY_TYPE: no_plot
   DATA_TYPE: CDF_TIME_TT2000
   FIELDNAM: Epoch
   RECORD_VARYING: RV
-  LABLAXIS: epoch
+  FORMAT: ' '
+  LABLAXIS: Epoch
   UNITS: ns
   VALIDMIN: 2010-01-01T00:00:00.000000000
   VALIDMAX: 2099-12-31T00:00:00.000000000
@@ -61,22 +61,19 @@ epoch:
 
 epoch_delta:
   NAME: epoch_delta
-  VAR_TYPE: support_data
-  DISPLAY_TYPE: no_plot
-  RECORD_VARYING: RV
-  DEPEND_0: epoch
-  CATDESC: epoch_DELTA
-  FIELDNAM: epoch_delta
+  CATDESC: Epoch delta
+  FIELDNAM: Epoch Delta
   DATA_TYPE: CDF_INT8
-  FORMAT: I19
+  FORMAT: I15
   UNITS: ns
   VALIDMIN: 0
-  VALIDMAX: 86000000000000
+  VALIDMAX: 999999999999999
   FILLVAL: -9223372036854775808
   SCALETYP: linear
-  SCALEMIN: 0
-  SCALEMAX: 86000000000000
-  SI_CONVERSION: 1e-9>seconds
+  LABLAXIS: Epoch delta
+  DEPEND_0: epoch
+  RECORD_VARYING: RV
+  VAR_TYPE: support_data
 
 data_quality:
   <<: *per_priority_data
@@ -125,6 +122,7 @@ ssd_energy:
   FIELDNAM: SSD Energy
   LABLAXIS: SSD energy
   UNITS: MeV
+  SCALETYP: log
   SCALEMIN: 1.0e-2
   SCALEMAX: 1.0e+2
 
@@ -199,6 +197,9 @@ energy_per_nuc:
   FIELDNAM: Energy per nuc
   LABLAXIS: Energy per nuc
   UNITS: MeV/nuc
+  SCALEMIN: 1.0e-2
+  SCALEMAX: 1.0e+4
+  SCALETYP: log
 
 estimated_mass:
   <<: *per_event_data

imap_l3_processing/cdf/config/imap_codice_l3a_lo-direct-events_variable_attrs.yaml

@@ -32,11 +32,11 @@ epoch:
   NAME: epoch
   CATDESC: Time, number of nanoseconds since J2000 with leap seconds included
   VAR_TYPE: support_data
-  DISPLAY_TYPE: no_plot
   DATA_TYPE: CDF_TIME_TT2000
   FIELDNAM: Epoch
   RECORD_VARYING: RV
-  LABLAXIS: epoch
+  FORMAT: ' '
+  LABLAXIS: Epoch
   UNITS: ns
   VALIDMIN: 2010-01-01T00:00:00.000000000
   VALIDMAX: 2099-12-31T00:00:00.000000000
@@ -54,20 +54,17 @@ epoch_delta:
   NAME: epoch_delta
   CATDESC: Epoch delta
   FIELDNAM: Epoch Delta
-  VAR_TYPE: support_data
-  DISPLAY_TYPE: no_plot
-  RECORD_VARYING: RV
-  DEPEND_0: epoch
   DATA_TYPE: CDF_INT8
-  FORMAT: I19
+  FORMAT: I15
   UNITS: ns
   VALIDMIN: 0
-  VALIDMAX: 86000000000000
+  VALIDMAX: 999999999999999
   FILLVAL: -9223372036854775808
   SCALETYP: linear
-  SCALEMIN: 0
-  SCALEMAX: 86000000000000
-  SI_CONVERSION: 1e-9>seconds
+  LABLAXIS: Epoch delta
+  DEPEND_0: epoch
+  RECORD_VARYING: RV
+  VAR_TYPE: support_data
 
 event_index:
   <<: *support_data
@@ -380,4 +377,93 @@ position:
   VALIDMAX: 24
   FILLVAL: 255
   SCALETYP: linear
-  FORMAT: I3
+  FORMAT: I3
+
+half_spin_per_esa_step:
+  NAME: half_spin_per_esa_step
+  CATDESC: Half spin number for each step of energy
+  DEPEND_0: epoch
+  DEPEND_1: esa_step
+  FIELDNAM: Half Spin Number
+  DATA_TYPE: CDF_UINT1
+  FILLVAL: 255
+  FORMAT: I3
+  LABLAXIS: Half Spin Number
+  SCALETYP: linear
+  UNITS: half spin number
+  VALIDMIN: 0
+  VALIDMAX: 63
+  VAR_TYPE: support_data
+  VARIABLE_PURPOSE: ""
+
+rgfo_spin_sector:
+  NAME: rgfo_spin_sector
+  CATDESC: Spin Sector When Reduced Gain Factor Operation (RGFO) was activated
+  DEPEND_0: epoch
+  DISPLAY_TYPE: time_series
+  FIELDNAM: RGFO Spin Sector
+  DATA_TYPE: CDF_UINT1
+  FILLVAL: 255
+  FORMAT: I3
+  LABLAXIS: RGFO Spin Sector
+  SCALETYP: linear
+  UNITS:  spin sector
+  VALIDMIN: 0
+  VALIDMAX: 255
+  VAR_NOTES: Indicates the spin sector when Reduced Gain Factor Operation (RGFO) was activated. In RGFO, the Entrance ESA voltage is reduced in order to limit the number of ions that reach the detectors.
+  VAR_TYPE: data
+  VARIABLE_PURPOSE: ""
+
+rgfo_esa_step:
+  NAME: rgfo_esa_step
+  CATDESC: Energy Step When Reduced Gain Factor Operation (RGFO) was activated
+  DEPEND_0: epoch
+  DISPLAY_TYPE: time_series
+  FIELDNAM: RGFO Energy Step
+  DATA_TYPE: CDF_UINT1
+  FILLVAL: 255
+  FORMAT: I3
+  LABLAXIS: RGFO Energy Step
+  SCALETYP: linear
+  UNITS: energy step
+  VALIDMIN: 0
+  VALIDMAX: 255
+  VAR_NOTES: Indicates the energy step when Reduced Gain Factor Operation (RGFO) was activated. In RGFO, the Entrance ESA voltage is reduced in order to limit the number of ions that reach the detectors.
+  VAR_TYPE: data
+  VARIABLE_PURPOSE: ""
+
+nso_spin_sector:
+  NAME: nso_spin_sector
+  CATDESC: Spin Sector When No Scan Operation (NSO) was activated
+  DEPEND_0: epoch
+  DISPLAY_TYPE: time_series
+  FIELDNAM: NSO Spin Sector
+  DATA_TYPE: CDF_UINT1
+  FILLVAL: 255
+  FORMAT: I3
+  LABLAXIS: NSO Spin Sector
+  SCALETYP: linear
+  UNITS: spin sector
+  VALIDMIN: 0
+  VALIDMAX: 255
+  VAR_NOTES: Indicates the spin sector when No Scan Operation (NSO) was activated. In NSO, the ESA voltage is set to the first step in the scan and remains fixed until the next cycle boundary.
+  VAR_TYPE: data
+  VARIABLE_PURPOSE: ""
+
+nso_esa_step:
+  NAME: nso_esa_step
+  CATDESC: Energy Step When No Scan Operation (NSO) was activated
+  DEPEND_0: epoch
+  DISPLAY_TYPE: time_series
+  FIELDNAM: NSO Energy Step
+  DATA_TYPE: CDF_UINT1
+  FILLVAL: 255
+  FORMAT: I3
+  LABLAXIS: NSO Energy Step
+  SCALETYP: linear
+  UNITS: energy step
+  VALIDMIN: 0
+  VALIDMAX: 255
+  VAR_NOTES: Indicates the energy step when No Scan Operation (NSO) was activated. In NSO, the ESA voltage is set to the first step in the scan and remains fixed until the next cycle boundary.
+  VAR_TYPE: data
+  VARIABLE_PURPOSE: ""

imap_l3_processing/cdf/config/imap_codice_l3a_lo-heplus-3d-distribution_variable_attrs.yaml

@@ -30,11 +30,11 @@ epoch:
   NAME: epoch
   CATDESC: Time, number of nanoseconds since J2000 with leap seconds included
   VAR_TYPE: support_data
-  DISPLAY_TYPE: no_plot
   DATA_TYPE: CDF_TIME_TT2000
   FIELDNAM: Epoch
   RECORD_VARYING: RV
-  LABLAXIS: epoch
+  FORMAT: ' '
+  LABLAXIS: Epoch
   UNITS: ns
   VALIDMIN: 2010-01-01T00:00:00.000000000
   VALIDMAX: 2099-12-31T00:00:00.000000000
@@ -49,23 +49,20 @@ epoch:
   SI_CONVERSION: 1e-9>seconds
 
 epoch_delta:
-  <<: *support_data
-  DEPEND_0: epoch
   NAME: epoch_delta
   CATDESC: Epoch delta
   FIELDNAM: Epoch Delta
   DATA_TYPE: CDF_INT8
-  FORMAT: I19
+  FORMAT: I15
   UNITS: ns
   VALIDMIN: 0
-  VALIDMAX: 86000000000000
+  VALIDMAX: 999999999999999
   FILLVAL: -9223372036854775808
   SCALETYP: linear
-  SCALEMIN: 0
-  SCALEMAX: 86000000000000
-  SI_CONVERSION: 1e-9>seconds
-
+  LABLAXIS: Epoch delta
+  DEPEND_0: epoch
   RECORD_VARYING: RV
+  VAR_TYPE: support_data
 
 elevation:
   <<: *support_data

imap_l3_processing/cdf/config/imap_codice_l3a_lo-heplus2-3d-distribution_variable_attrs.yaml

@@ -30,11 +30,11 @@ epoch:
   NAME: epoch
   CATDESC: Time, number of nanoseconds since J2000 with leap seconds included
   VAR_TYPE: support_data
-  DISPLAY_TYPE: no_plot
   DATA_TYPE: CDF_TIME_TT2000
   FIELDNAM: Epoch
   RECORD_VARYING: RV
-  LABLAXIS: epoch
+  FORMAT: ' '
+  LABLAXIS: Epoch
   UNITS: ns
   VALIDMIN: 2010-01-01T00:00:00.000000000
   VALIDMAX: 2099-12-31T00:00:00.000000000
@@ -49,23 +49,20 @@ epoch:
   SI_CONVERSION: 1e-9>seconds
 
 epoch_delta:
-  <<: *support_data
-  DEPEND_0: epoch
   NAME: epoch_delta
   CATDESC: Epoch delta
   FIELDNAM: Epoch Delta
   DATA_TYPE: CDF_INT8
-  FORMAT: I19
+  FORMAT: I15
   UNITS: ns
   VALIDMIN: 0
-  VALIDMAX: 86000000000000
+  VALIDMAX: 999999999999999
   FILLVAL: -9223372036854775808
   SCALETYP: linear
-  SCALEMIN: 0
-  SCALEMAX: 86000000000000
-  SI_CONVERSION: 1e-9>seconds
-
+  LABLAXIS: Epoch delta
+  DEPEND_0: epoch
   RECORD_VARYING: RV
+  VAR_TYPE: support_data
 
 elevation:
   <<: *support_data

imap_l3_processing/cdf/config/imap_codice_l3a_lo-hplus-3d-distribution_variable_attrs.yaml

@@ -30,11 +30,11 @@ epoch:
   NAME: epoch
   CATDESC: Time, number of nanoseconds since J2000 with leap seconds included
   VAR_TYPE: support_data
-  DISPLAY_TYPE: no_plot
   DATA_TYPE: CDF_TIME_TT2000
   FIELDNAM: Epoch
   RECORD_VARYING: RV
-  LABLAXIS: epoch
+  FORMAT: ' '
+  LABLAXIS: Epoch
   UNITS: ns
   VALIDMIN: 2010-01-01T00:00:00.000000000
   VALIDMAX: 2099-12-31T00:00:00.000000000
@@ -49,23 +49,20 @@ epoch:
   SI_CONVERSION: 1e-9>seconds
 
 epoch_delta:
-  <<: *support_data
-  DEPEND_0: epoch
   NAME: epoch_delta
   CATDESC: Epoch delta
   FIELDNAM: Epoch Delta
   DATA_TYPE: CDF_INT8
-  FORMAT: I19
+  FORMAT: I15
   UNITS: ns
   VALIDMIN: 0
-  VALIDMAX: 86000000000000
+  VALIDMAX: 999999999999999
   FILLVAL: -9223372036854775808
   SCALETYP: linear
-  SCALEMIN: 0
-  SCALEMAX: 86000000000000
-  SI_CONVERSION: 1e-9>seconds
-
+  LABLAXIS: Epoch delta
+  DEPEND_0: epoch
   RECORD_VARYING: RV
+  VAR_TYPE: support_data
 
 elevation:
   <<: *support_data