imap-processing 0.19.4__py3-none-any.whl → 1.0.0__py3-none-any.whl

imap_processing/cdf/config/imap_enamaps_l2-common_variable_attrs.yaml

@@ -54,15 +54,6 @@ energy_label:
   FORMAT: A16
   DEPEND_1: energy
 
-epoch_delta:
-  <<: *default_int64
-  CATDESC: Number of nanoseconds covered by data included in this map product.
-  FIELDNAM: epoch_delta
-  UNITS: ns
-  VAR_TYPE: support_data
-  DISPLAY_TYPE: no_plot
-  TIME_SCALE: Terrestrial Time
-
 energy_delta_minus:
   <<: *default_float32
   VAR_TYPE: support_data
@@ -87,29 +78,37 @@ energy_delta_plus:
   LABL_PTR_1: energy_label
   DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:Energy,Qualifier:Uncertainty
 
+epoch_delta:
+  <<: *default_int64
+  CATDESC: Number of nanoseconds covered by data included in this map product.
+  FIELDNAM: epoch_delta
+  UNITS: ns
+  VAR_TYPE: support_data
+  DISPLAY_TYPE: no_plot
+  TIME_SCALE: Terrestrial Time
+  DICT_KEY: SPASE>Support>SupportQuantity:Temporal
+
 # These two coordinates will be treated differently in the
 # HEALPix and rectangular tilings. They will be substantially overridden
 # in the tiling-specific YAML files.
 longitude:
   <<: *default_float32
-  CATDESC: Pixel center longitude in range [0, 360].
-  FIELDNAM: Longitude
-  LABLAXIS: Longitude
+  CATDESC: "Pixel center longitude in {frame} reference frame in the range [0, 360]."
+  FIELDNAM: "{frame} Longitude"
+  LABLAXIS: "{frame} Longitude"
   UNITS: degrees
   VAR_TYPE: support_data
-  DISPLAY_TYPE: no_plot
   VALIDMIN: 0
   VALIDMAX: 360
   DICT_KEY: SPASE>Support>SupportQuantity:Orientation,Qualifier:DirectionAngle.AzimuthAngle,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
 
 latitude:
   <<: *default_float32
-  CATDESC: Pixel center latitude in range [-90, 90].
-  FIELDNAM: Latitude
-  LABLAXIS: Latitude
+  CATDESC: "Pixel center latitude in {frame} reference frame in the range [-90, 90]."
+  FIELDNAM: "{frame} Latitude"
+  LABLAXIS: "{frame} Latitude"
   UNITS: degrees
   VAR_TYPE: support_data
-  DISPLAY_TYPE: no_plot
   VALIDMIN: -90
   VALIDMAX: 90
   DICT_KEY: SPASE>Support>SupportQuantity:Orientation,Qualifier:DirectionAngle.ElevationAngle,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
@@ -122,23 +121,23 @@ ena_intensity:
   CATDESC: Mono-energetic ENA intensity.
   FIELDNAM: Intensity
   UNITS: counts/(s * cm^2 * Sr * KeV)
-  DELTA_MINUS_VAR: ena_intensity_stat_unc
-  DELTA_PLUS_VAR: ena_intensity_stat_unc
+  DELTA_MINUS_VAR: ena_intensity_stat_uncert
+  DELTA_PLUS_VAR: ena_intensity_stat_uncert
   DEPEND_0: epoch
   VAR_TYPE: data
   LABLAXIS: Intensity
-  DISPLAY_TYPE: image
+  DISPLAY_TYPE: map_image
   DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:NumberFlux,Qualifier:Incident,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
 
-ena_intensity_stat_unc:
+ena_intensity_stat_uncert:
   <<: *default_float32
   CATDESC: ENA intensity statistical uncertainty.
   FIELDNAM: Intensity stat unc
   UNITS: counts/(s * cm^2 * Sr * KeV)
   DEPEND_0: epoch
-  VAR_TYPE: data
+  VAR_TYPE: support_data
   LABLAXIS: Statistical Unc
-  DISPLAY_TYPE: image
+  DISPLAY_TYPE: map_image
   DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:NumberFlux,Qualifier:Uncertainty,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
 
 ena_intensity_sys_err:
@@ -147,9 +146,9 @@ ena_intensity_sys_err:
   FIELDNAM: Intensity non-stat error
   UNITS: counts/(s * cm^2 * Sr * KeV)
   DEPEND_0: epoch
-  VAR_TYPE: data
+  VAR_TYPE: support_data
   LABLAXIS: Non-Statistical Err
-  DISPLAY_TYPE: image
+  DISPLAY_TYPE: map_image
   DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:NumberFlux,Qualifier:Uncertainty,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
 
 ena_rate:
@@ -160,7 +159,7 @@ ena_rate:
   DEPEND_0: epoch
   VAR_TYPE: data
   LABLAXIS: Rate
-  DISPLAY_TYPE: image
+  DISPLAY_TYPE: map_image
   DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:NumberFlux,Qualifier:Incident,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
 
 bg_rate:
@@ -171,7 +170,7 @@ bg_rate:
   DEPEND_0: epoch
   VAR_TYPE: data
   LABLAXIS: Rate
-  DISPLAY_TYPE: image
+  DISPLAY_TYPE: map_image
   DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:NumberFlux,Qualifier:Incident,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
 
 ena_count:
@@ -182,7 +181,7 @@ ena_count:
   DEPEND_0: epoch
   VAR_TYPE: data
   LABLAXIS: Count
-  DISPLAY_TYPE: image
+  DISPLAY_TYPE: map_image
   DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:NumberFlux,Qualifier:Incident,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
 
 sensitivity:
@@ -192,7 +191,7 @@ sensitivity:
   UNITS: cm^2
   VAR_TYPE: support_data
   LABLAXIS: sensitivity
-  DISPLAY_TYPE: image
+  DISPLAY_TYPE: no_plot
   DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:GeometricFactor,Qualifier:Directional,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
 
 exposure_factor: &exposure_factor
@@ -204,7 +203,7 @@ exposure_factor: &exposure_factor
   VAR_TYPE: data
   LABLAXIS: Exposure
   DISPLAY_TYPE: no_plot
-  DICT_KEY: SPASE>TemporalDescription:Exposure,Qualifier:Directional,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
+  DICT_KEY: SPASE>Support>SupportQuantity:Temporal
 
 geometric_function:
   <<: *default_float32
@@ -253,9 +252,9 @@ obs_date: &obs_date
   FIELDNAM: J2000 Nanoseconds
   UNITS: ns
   DEPEND_0: epoch
-  VAR_TYPE: data
+  VAR_TYPE: support_data
   LABLAXIS: epoch
-  DISPLAY_TYPE: image
+  DISPLAY_TYPE: no_plot
   DICT_KEY: SPASE>TemporalDescription:TimeSpan,Qualifier:Directional,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
 
 obs_date_range:
@@ -265,10 +264,11 @@ obs_date_range:
   FIELDNAM: Observation date range
   UNITS: ns
   DEPEND_0: epoch
-  VAR_TYPE: data
+  VAR_TYPE: support_data
   LABLAXIS: epoch
-  DISPLAY_TYPE: image
+  DISPLAY_TYPE: no_plot
   TIME_SCALE: Terrestrial Time
+  DICT_KEY: SPASE>Support>SupportQuantity:Temporal
 
 # These copied metadata vars will allow for variables
 # to be either energy-dependent or independent.
@@ -284,12 +284,11 @@ obs_date_range_energy_independent:
 
 solid_angle:
   <<: *default_float32
-  VAR_TYPE: support_data
   CATDESC: Solid angle subtended by each pixel.
   FIELDNAM: Solid Angle
   DEPEND_0: epoch
+  VAR_TYPE: support_data
   UNITS: sr
-  VAR_TYPE: data
   LABLAXIS: Solid Angle
-  DISPLAY_TYPE: image
+  DISPLAY_TYPE: no_plot
   DICT_KEY: SPASE>Support>SupportQuantity:Other

imap_processing/cdf/config/imap_enamaps_l2-healpix_variable_attrs.yaml

@@ -52,9 +52,8 @@ ena_intensity:
   DEPEND_2: pixel_index
   LABL_PTR_1: energy_label
   LABL_PTR_2: pixel_index_label
-  DISPLAY_TYPE: image
 
-ena_intensity_stat_unc:
+ena_intensity_stat_uncert:
   DEPEND_1: energy
   DEPEND_2: pixel_index
   LABL_PTR_1: energy_label

imap_processing/cdf/config/imap_enamaps_l2-rectangular_variable_attrs.yaml

@@ -19,9 +19,10 @@ longitude_label:
   DEPEND_1: longitude
 
 longitude_delta:
-  VAR_TYPE: metadata
+  VAR_TYPE: support_data
   dtype: float32
   CATDESC: Half-width of longitude pixel
+  DEPEND_1: longitude
   FORMAT: F12.6
   UNITS: degrees
   FIELDNAM: longitude delta
@@ -35,9 +36,10 @@ latitude_label:
   DEPEND_1: latitude
 
 latitude_delta:
-  VAR_TYPE: metadata
+  VAR_TYPE: support_data
   dtype: float32
   CATDESC: Half-width of latitude pixel
+  DEPEND_1: latitude
   FORMAT: F12.6
   UNITS: degrees
   FIELDNAM: latitude delta
@@ -65,7 +67,7 @@ ena_intensity:
   LABL_PTR_2: longitude_label
   LABL_PTR_3: latitude_label
 
-ena_intensity_stat_unc:
+ena_intensity_stat_uncert:
   DEPEND_1: energy
   DEPEND_2: longitude
   DEPEND_3: latitude

imap_processing/codice/codice_l1a.py

@@ -89,7 +89,7 @@ class CoDICEL1aPipeline:
         self.plan_step = plan_step
         self.view_id = view_id
 
-    def apply_despinning(self) -> None:
+    def apply_despinning(self) -> None:  # noqa: PLR0912 (too many branches)
         """
         Apply the despinning algorithm to lo- angular and priority products.
 
@@ -108,10 +108,10 @@ class CoDICEL1aPipeline:
         # The dimensions are dependent on the specific data product
         if "angular" in self.config["dataset_name"]:
             despun_dims: tuple[int, ...] = (
+                num_counters,
                 num_energies,
                 num_positions,
                 num_spins,
-                num_counters,
             )
         elif "priority" in self.config["dataset_name"]:
             despun_dims = (num_energies, num_spins, num_counters)
@@ -130,23 +130,33 @@ class CoDICEL1aPipeline:
             for energy_index in range(num_energies):
                 pixel_orientation = constants.PIXEL_ORIENTATIONS[energy_index]
                 for spin_sector_index in range(num_spin_sectors):
-                    for azimuth_index in range(num_spins):
-                        if pixel_orientation == "A" and azimuth_index < 12:
+                    for azimuth_index in range(num_positions):
+                        if "-sw-" in self.config["dataset_name"]:
+                            # do something
+                            position_index = constants.SW_INDEX_TO_POSITION[
+                                azimuth_index
+                            ]
+                        elif "-nsw-" in self.config["dataset_name"]:
+                            position_index = constants.NSW_INDEX_TO_POSITION[
+                                azimuth_index
+                            ]
+
+                        if pixel_orientation == "A" and position_index < 12:
                             despun_spin_sector = spin_sector_index
-                        elif pixel_orientation == "A" and azimuth_index >= 12:
+                        elif pixel_orientation == "A" and position_index >= 12:
                             despun_spin_sector = spin_sector_index + 12
-                        elif pixel_orientation == "B" and azimuth_index < 12:
+                        elif pixel_orientation == "B" and position_index < 12:
                             despun_spin_sector = spin_sector_index + 12
-                        elif pixel_orientation == "B" and azimuth_index >= 12:
+                        elif pixel_orientation == "B" and position_index >= 12:
                             despun_spin_sector = spin_sector_index
 
                         if "angular" in self.config["dataset_name"]:
                             spin_data = epoch_data[
-                                energy_index, :, spin_sector_index, :
-                            ]  # (5, 4)
-                            despun_data[i][energy_index, :, despun_spin_sector, :] = (
-                                spin_data
-                            )
+                                :, energy_index, azimuth_index, spin_sector_index
+                            ]
+                            despun_data[i][
+                                :, energy_index, azimuth_index, despun_spin_sector
+                            ] = spin_data
                         elif "priority" in self.config["dataset_name"]:
                             spin_data = epoch_data[energy_index, spin_sector_index, :]
                             despun_data[i][energy_index, despun_spin_sector, :] = (
@@ -327,7 +337,7 @@ class CoDICEL1aPipeline:
         # each counter's data can be placed in a separate CDF data variable.
         # For Lo SW species, all_data has shape (9, 16, 128, 1) -> (epochs,
         # num_counters, num_energy_steps, num_spin_sectors)
-        if self._is_lo_species_dataset():
+        if self._is_different_dimension():
             # For Lo species datasets, counters are the second dimension (index 1)
             num_counters = all_data.shape[1]
         else:
@@ -338,8 +348,10 @@ class CoDICEL1aPipeline:
             range(num_counters), self.config["variable_names"], strict=False
         ):
             # Extract the counter data
-            if self._is_lo_species_dataset():
+            if self._is_different_dimension():
                 counter_data = all_data[:, counter, :, :]
+            elif "sectored" in self.config["dataset_name"]:
+                counter_data = all_data[:, counter, :, :, :]
             else:
                 counter_data = all_data[..., counter]
 
@@ -720,18 +732,25 @@ class CoDICEL1aPipeline:
 
         # Reshape the data based on how it is written to the data array of
         # the packet data. The number of counters is the last dimension / axis.
-        if self._is_lo_species_dataset():
+        if self._is_different_dimension():
             # For Lo species datasets, counters are the first dimension
             reshape_dims = (
                 self.config["num_counters"],
                 *self.config["dims"].values(),
             )
+        elif "sectored" in self.config["dataset_name"]:
+            # For sectored datasets, counters are the second dimension
+            reshape_dims = (
+                self.config["num_counters"],
+                *self.config["dims"].values(),
+            )
         else:
             # For all other datasets, counters are the last dimension
             reshape_dims = (
                 *self.config["dims"].values(),
                 self.config["num_counters"],
             )
+
         for packet_data in self.raw_data:
             reshaped_packet_data = np.array(packet_data, dtype=np.uint32).reshape(
                 reshape_dims
@@ -745,7 +764,7 @@ class CoDICEL1aPipeline:
         # No longer need to keep the raw data around
         del self.raw_data
 
-    def _is_lo_species_dataset(self) -> bool:
+    def _is_different_dimension(self) -> bool:
         """
         Check if the current dataset is a Lo species dataset.
 
@@ -761,6 +780,8 @@ class CoDICEL1aPipeline:
         return self.config["dataset_name"] in [
             "imap_codice_l1a_lo-sw-species",
             "imap_codice_l1a_lo-nsw-species",
+            "imap_codice_l1a_lo-sw-angular",
+            "imap_codice_l1a_lo-nsw-angular",
         ]
 
     def set_data_product_config(self, apid: int, dataset: xr.Dataset) -> None:
@@ -1653,23 +1674,23 @@ def process_codice_l1a(file_path: Path) -> list[xr.Dataset]:
         # Housekeeping data
         if apid == CODICEAPID.COD_NHK:
             processed_dataset = create_hskp_dataset(dataset)
-            logger.info(f"\nFinal data product:\n{processed_dataset}\n")
+            logger.info(f"\nProcessed {CODICEAPID(apid).name} packet\n")
 
         # Event data
         elif apid in [CODICEAPID.COD_LO_PHA, CODICEAPID.COD_HI_PHA]:
             processed_dataset = create_direct_event_dataset(apid, dataset)
-            logger.info(f"\nFinal data product:\n{processed_dataset}\n")
+            logger.info(f"\nProcessed {CODICEAPID(apid).name} packet\n")
 
         # I-ALiRT data
         elif apid in [CODICEAPID.COD_LO_IAL, CODICEAPID.COD_HI_IAL]:
             processed_dataset = create_ialirt_dataset(apid, dataset)
-            logger.info(f"\nFinal data product:\n{processed_dataset}\n")
+            logger.info(f"\nProcessed {CODICEAPID(apid).name} packet\n")
 
         # hi-omni data
         elif apid == CODICEAPID.COD_HI_OMNI_SPECIES_COUNTS:
             science_values = [packet.data for packet in dataset.data]
             processed_dataset = create_binned_dataset(apid, dataset, science_values)
-            logger.info(f"\nFinal data product:\n{processed_dataset}\n")
+            logger.info(f"\nProcessed {CODICEAPID(apid).name} packet\n")
 
         # Everything else
         elif apid in constants.APIDS_FOR_SCIENCE_PROCESSING:
@@ -1687,7 +1708,7 @@ def process_codice_l1a(file_path: Path) -> list[xr.Dataset]:
             pipeline.define_coordinates()
             processed_dataset = pipeline.define_data_variables()
 
-            logger.info(f"\nFinal data product:\n{processed_dataset}\n")
+            logger.info(f"\nProcessed {CODICEAPID(apid).name} packet\n")
 
         # For APIDs that don't require processing
         else: