HIT L2 - add algorithm for sectored intensity (IMAP-Science-Operations-Center#1619)

* Add some constants needed for the L2 sectored intensities dataset

* Small updates to L2 and L1B global attributes

* Add function to process sectored rates and create a dataset with sectored intensities. Update functions that calculate intensities to apply vectorization for optimized operations. Fix bug where a call to calculate intensities for the standard intensity dataset was not being returned to a variable to save the results

* Update hit_l2 function to call sector intensity processing code

* Add constants for valid data variables to process depending on the product

* Add test for new function processing sectored rates into intensities dataset

* Add to test docstring

* Fix test to not pass in version number to hit_l2() since this was removed in another PR

* Add ancillary file for sectored data

* Add dtype to counts data to ensure dynamic threshold state is an integer all the way through L2

* Address PR comments to add a declination constant and rename seconds variable

* Address PR comment and remove setting var to string since it's definied as a string already

* Update some assertions to use np.testing assertions for better error messaging

* Address PR comments - refactor handling of ancillary data and intensity calculation to improve readability and performance replacing the named tuple with a dataset for storing intensity factors

* Add tests for new functions from refactoring the L2 processing code

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update comment for clarity

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: vmartinez-cu

imap_processing/cdf/config/imap_hit_global_cdf_attrs.yaml

@@ -38,7 +38,7 @@ imap_hit_l1b_hk:
 
 imap_hit_l1b_standard-rates:
     <<: *instrument_base
-    Data_type: L1B_rates>Level-1B Standard Rates
+    Data_type: L1B_standard-rates>Level-1B Standard Rates
     Logical_source: imap_hit_l1b_standard-rates
     Logical_source_description: IMAP Mission HIT Instrument Level-1B Standard Rates Data.
 
@@ -58,19 +58,19 @@ imap_hit_l1b_sectored-rates:
 
 imap_hit_l2_standard-intensity:
     <<: *instrument_base
-    Data_type: L2_rates>Level-2 Standard Intensity
+    Data_type: L2_standard-intensity>Level-2 Standard Intensity
     Logical_source: imap_hit_l2_standard-intensity
     Logical_source_description: IMAP Mission HIT Instrument Level-2 Standard Intensity Data.
 
 imap_hit_l2_summed-intensity:
     <<: *instrument_base
-    Data_type: L2_summed-rates>Level-2 Summed Intensity
+    Data_type: L2_summed-intensity>Level-2 Summed Intensity
     Logical_source: imap_hit_l2_summed-intensity
     Logical_source_description: IMAP Mission HIT Instrument Level-2 Summed Intensity Data.
 
-imap_hit_l2_sectored-intensity:
+imap_hit_l2_macropixel-intensity:
     <<: *instrument_base
-    Data_type: L2_sectored-rates>Level-2 Macro Pixel Intensity
+    Data_type: L2_macro-pixel-intensity>Level-2 Macro Pixel Intensity
     Logical_source: imap_hit_l2_macropixel-intensity
     Logical_source_description: IMAP Mission HIT Instrument Level-2 Macro Pixel Intensity Data.
 

imap_processing/hit/ancillary/imap_hit_l1b-to-l2-sector-dt0-factors_20250219_v002.csv

@@ -0,0 +1,81 @@
+Species, Sector, Lower Energy (MeV), Upper Energy (MeV), Delta E (MeV), Geometry Factor (cm2 sr), Efficiency, b
+H      ,0,1.8,4,2.2,0.41686,1,0
+H      ,1,1.8,4,2.2,0.49253,1,0
+H      ,2,1.8,4,2.2,0.45156,1,0
+H      ,3,1.8,4,2.2,0.35599,1,0
+H      ,4,1.8,4,2.2,0.33312,1,0
+H      ,5,1.8,4,2.2,0.47444,1,0
+H      ,6,1.8,4,2.2,0.49253,1,0
+H      ,7,1.8,4,2.2,0.41686,1,0
+H      ,0,4,6,2,0.42008,1,0
+H      ,1,4,6,2,0.49746,1,0
+H      ,2,4,6,2,0.45515,1,0
+H      ,3,4,6,2,0.35921,1,0
+H      ,4,4,6,2,0.33619,1,0
+H      ,5,4,6,2,0.47817,1,0
+H      ,6,4,6,2,0.49746,1,0
+H      ,7,4,6,2,0.42008,1,0
+H      ,0,6,10,4,0.39177,1,0
+H      ,1,6,10,4,0.47095,1,0
+H      ,2,6,10,4,0.42764,1,0
+H      ,3,6,10,4,0.33171,1,0
+H      ,4,6,10,4,0.31091,1,0
+H      ,5,6,10,4,0.44844,1,0
+H      ,6,6,10,4,0.47095,1,0
+H      ,7,6,10,4,0.39177,1,0
+He4    ,0,4,6,2,0.41995,1,0
+He4    ,1,4,6,2,0.49964,1,0
+He4    ,2,4,6,2,0.45649,1,0
+He4    ,3,4,6,2,0.3584,1,0
+He4    ,4,4,6,2,0.33563,1,0
+He4    ,5,4,6,2,0.47925,1,0
+He4    ,6,4,6,2,0.49964,1,0
+He4    ,7,4,6,2,0.41995,1,0
+He4    ,0,6,12,6,0.42404,1,0
+He4    ,1,6,12,6,0.5045,1,0
+He4    ,2,6,12,6,0.45897,1,0
+He4    ,3,6,12,6,0.36098,1,0
+He4    ,4,6,12,6,0.33793,1,0
+He4    ,5,6,12,6,0.48202,1,0
+He4    ,6,6,12,6,0.5045,1,0
+He4    ,7,6,12,6,0.42404,1,0
+CNO    ,0,4,6,2,0.41976,1,0
+CNO    ,1,4,6,2,0.49594,1,0
+CNO    ,2,4,6,2,0.45356,1,0
+CNO    ,3,4,6,2,0.35698,1,0
+CNO    ,4,4,6,2,0.33409,1,0
+CNO    ,5,4,6,2,0.47645,1,0
+CNO    ,6,4,6,2,0.49594,1,0
+CNO    ,7,4,6,2,0.41976,1,0
+CNO    ,0,6,12,6,0.42026,1,0
+CNO    ,1,6,12,6,0.49871,1,0
+CNO    ,2,6,12,6,0.45567,1,0
+CNO    ,3,6,12,6,0.35809,1,0
+CNO    ,4,6,12,6,0.3351,1,0
+CNO    ,5,6,12,6,0.47866,1,0
+CNO    ,6,6,12,6,0.49871,1,0
+CNO    ,7,6,12,6,0.42026,1,0
+NeMgSi ,0,4,6,2,0.37544,1,0
+NeMgSi ,1,4,6,2,0.43535,1,0
+NeMgSi ,2,4,6,2,0.40251,1,0
+NeMgSi ,3,4,6,2,0.32308,1,0
+NeMgSi ,4,4,6,2,0.30221,1,0
+NeMgSi ,5,4,6,2,0.42339,1,0
+NeMgSi ,6,4,6,2,0.43535,1,0
+NeMgSi ,7,4,6,2,0.37544,1,0
+NeMgSi ,0,6,12,6,0.42046,1,0
+NeMgSi ,1,6,12,6,0.49714,1,0
+NeMgSi ,2,6,12,6,0.45432,1,0
+NeMgSi ,3,6,12,6,0.35764,1,0
+NeMgSi ,4,6,12,6,0.33475,1,0
+NeMgSi ,5,6,12,6,0.47721,1,0
+NeMgSi ,6,6,12,6,0.49714,1,0
+NeMgSi ,7,6,12,6,0.42046,1,0
+Fe     ,0,4,12,8,0.2752,1,0
+Fe     ,1,4,12,8,0.31996,1,0
+Fe     ,2,4,12,8,0.29577,1,0
+Fe     ,3,4,12,8,0.23669,1,0
+Fe     ,4,4,12,8,0.2213,1,0
+Fe     ,5,4,12,8,0.31118,1,0
+Fe     ,6,4,12,8,0.31996,1,0
+Fe     ,7,4,12,8,0.2752,1,0

imap_processing/hit/l0/decom_hit.py

@@ -113,7 +113,9 @@ def parse_count_rates(sci_dataset: xr.Dataset) -> None:
         else:
             dims = ["epoch"]
 
-        sci_dataset[field] = xr.DataArray(parsed_data, dims=dims, name=field)
+        sci_dataset[field] = xr.DataArray(
+            np.array(parsed_data, dtype=np.int64), dims=dims, name=field
+        )
         # Add dimensions to coordinates
         for dim in dims:
             if dim not in sci_dataset.coords:

imap_processing/hit/l2/constants.py

@@ -8,6 +8,43 @@
 L2_SUMMED_ANCILLARY_PATH_PREFIX = (
     imap_module_directory / "hit/ancillary/imap_hit_l1b-to-l2-summed-dt"
 )
+L2_SECTORED_ANCILLARY_PATH_PREFIX = (
+    imap_module_directory / "hit/ancillary/imap_hit_l1b-to-l2-sector-dt"
+)
+
+# Constants for HIT L2 intensity calculation
+SECONDS_PER_MIN = 60  # seconds per minute
+SECONDS_PER_10_MIN = 600  # seconds per 10 minutes
+
+# Fill values for missing data
+FILLVAL_FLOAT32 = -1.00e31
+
+# Number of azimuth angles
+N_AZIMUTH = 15
+
+# Valid species for HIT L2 standard and summed intensity products
+VALID_SPECIES = [
+    "h",
+    "he3",
+    "he4",
+    "he",
+    "c",
+    "n",
+    "o",
+    "ne",
+    "na",
+    "mg",
+    "al",
+    "si",
+    "s",
+    "ar",
+    "ca",
+    "fe",
+    "ni",
+]
+
+# Valid species for HIT L2 sectored intensity product
+VALID_SECTORED_SPECIES = ["h", "he4", "cno", "nemgsi", "fe"]
 
 # Particle energy range mapping for HIT L2 standard intensity product.
 # The standard intensity calculation requires the L1B foreground rates to