imap-processing 0.15.0__py3-none-any.whl → 0.16.0__py3-none-any.whl

imap_processing/ultra/utils/ultra_l1_utils.py

@@ -57,14 +57,16 @@ def create_dataset(  # noqa: PLR0912
             data_dict["epoch"],
             name="epoch",
             dims=["epoch"],
-            attrs=cdf_manager.get_variable_attributes("epoch"),
+            attrs=cdf_manager.get_variable_attributes("epoch", check_schema=False),
         )
         if "sensor-de" in name:
             component = xr.DataArray(
                 ["vx", "vy", "vz"],
                 name="component",
                 dims=["component"],
-                attrs=cdf_manager.get_variable_attributes("component"),
+                attrs=cdf_manager.get_variable_attributes(
+                    "component", check_schema=False
+                ),
             )
             coords = {"epoch": epoch_time, "component": component}
         else:

{imap_processing-0.15.0.dist-info → imap_processing-0.16.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: imap-processing
-Version: 0.15.0
+Version: 0.16.0
 Summary: IMAP Science Operations Center Processing
 License: MIT
 Keywords: IMAP,SDC,SOC,Science Operations

{imap_processing-0.15.0.dist-info → imap_processing-0.16.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 imap_processing/__init__.py,sha256=b9xHlf8_0OtN_OyhPlrC6ayahYR0QTt_e713NjxZObw,1305
-imap_processing/_version.py,sha256=irZ9t9UpzoARk751rz8rjjmcOizvIGEr5-xJe0qW6KE,127
+imap_processing/_version.py,sha256=eLPvHzTLNE19Gzow2bKK6dlgu7T2y85RkAQPjNmibUA,127
 imap_processing/ancillary/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 imap_processing/ancillary/ancillary_dataset_combiner.py,sha256=Pxg1wQLjPKzEkgE3a4Tart5TfeuH9rqyCKTd5GbgiL0,9602
 imap_processing/ccsds/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -26,7 +26,7 @@ imap_processing/cdf/config/imap_hit_l1a_variable_attrs.yaml,sha256=5X8V6Hzg7UGP6
 imap_processing/cdf/config/imap_hit_l1b_variable_attrs.yaml,sha256=gxeC7-SUKkWiy1OE6MgfKxeV-0bdXuauodOIfFtQ3JQ,11287
 imap_processing/cdf/config/imap_hit_l2_variable_attrs.yaml,sha256=f8ZLlF9EIes8BcFrpKTO8Mb_VVnP2d9HoLtQVOgz23Q,61402
 imap_processing/cdf/config/imap_ialirt_global_cdf_attrs.yaml,sha256=AGQ9J0zEdWRZ_AR6_AYYHkRb57mYIe2jVflhYv8SEsQ,961
-imap_processing/cdf/config/imap_ialirt_l1_variable_attrs.yaml,sha256=Hl3VE_JRPPDWu9_KDE_zUu0CVGTSYOvIR31gFoyD0D0,9891
+imap_processing/cdf/config/imap_ialirt_l1_variable_attrs.yaml,sha256=IWJwYEeIIWiL1EN8EufKc4O8BThHNDwL2CcfQWRcSPA,8362
 imap_processing/cdf/config/imap_idex_global_cdf_attrs.yaml,sha256=b0dbQ_IJtgTHmwdD754ZHr2-kwo8KIoG3FUZdK5vMEA,2920
 imap_processing/cdf/config/imap_idex_l1a_variable_attrs.yaml,sha256=KaRu-HPqAdAJ2vrX7m54pKUJsJtPaCfofi2OBs906cs,22493
 imap_processing/cdf/config/imap_idex_l1b_variable_attrs.yaml,sha256=Cx-s8hGmUtM_7pon1EbJTP3Im4uFfNeN6gZlGW5DudE,11153
@@ -57,13 +57,13 @@ imap_processing/cdf/config/imap_ultra_l1c_variable_attrs.yaml,sha256=D4uKUqZ8G5h
 imap_processing/cdf/config/imap_variable_schema.yaml,sha256=oKfSQKJ7vYh7SC9dwFeE5PzVQNXYCpcp3AZSclKUVeg,728
 imap_processing/cdf/imap_cdf_manager.py,sha256=K2W_5SzRTxJij2D-ZoKA4UdUxcVC1H90soEloJehsUk,2086
 imap_processing/cdf/utils.py,sha256=Go43WgJbp-BOH_5cLNAru76cCb6jW0ZzwwBCEmeV19E,7789
-imap_processing/cli.py,sha256=CzuVj86GDcBYBMsTt3_dXowiNN8eu9JK9H-vQtSP8Ls,53026
+imap_processing/cli.py,sha256=6kvGorFaUWQeWt43INKbFCH6J7JUwZHSCMQdDTQs8-k,52921
 imap_processing/codice/__init__.py,sha256=Ga6Ioj68HnQ4moi7SxJdOyYmGHcRvKOh4uZUEPJZHl4,20
 imap_processing/codice/codice_l0.py,sha256=_StmC58uRLBuUKSpVaqv6Bo49CeexkcOqnt_askKtHk,1701
-imap_processing/codice/codice_l1a.py,sha256=fCCwAdqGU3RWflHTYl8QYq3J9UvpPaR8IWSQ4V-7L9w,56366
+imap_processing/codice/codice_l1a.py,sha256=3sOzARFDNpL2JhNH2PugPMuMFkOUNMcI0I3T6jt8QhQ,57489
 imap_processing/codice/codice_l1b.py,sha256=_x--ZXHxxSknEC546hHQGqhRTanYtJTfKDsB8d9Pz_Q,5408
-imap_processing/codice/codice_l2.py,sha256=2UsNIWpsd6DRHlaFYF4AykaaCqPcoRln9dLhzyYMQcw,2947
-imap_processing/codice/constants.py,sha256=QOo0YVbZuTlWopRgbx4SPLhiSqXXeohMBa6bLACZrE0,45328
+imap_processing/codice/codice_l2.py,sha256=6bWXaEZxE-LuLv9vlvTIDlCxRWhkYMva0Re7X7-MS_4,2603
+imap_processing/codice/constants.py,sha256=nND2C9KVVkQ1_ZmmL3T9edqIF_gdqQ8h4NyEDVr7_HY,45621
 imap_processing/codice/data/esa_sweep_values.csv,sha256=RuRTBG_TftVKGDEslxDo5SVwLIWq2uh3WrlVsXABpfg,5336
 imap_processing/codice/data/lo_stepping_values.csv,sha256=Z-hdv2nxTzl-RXBWTa7Y_NRXR1HyW1mJrYMmX6vDnHo,5318
 imap_processing/codice/decompress.py,sha256=-EA7vlGIKx6d7gltfDLr8XmU-D6Q9_7FZRtzIUgW54M,5232
@@ -96,19 +96,13 @@ imap_processing/glows/packet_definitions/P_GLX_TMSCHIST.xml,sha256=Q7X5gF9jM4TA5
 imap_processing/glows/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 imap_processing/glows/utils/constants.py,sha256=REjvd0NgnST_rsfFQNGDo0F3_KKDZz20Dyt-19T2txM,2837
 imap_processing/hi/__init__.py,sha256=Ga6Ioj68HnQ4moi7SxJdOyYmGHcRvKOh4uZUEPJZHl4,20
-imap_processing/hi/l1a/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-imap_processing/hi/l1a/hi_l1a.py,sha256=Nj0V9XJZXchdMwsZEyztS2IY_Y0ENMHEPqWUum2VZOQ,3247
-imap_processing/hi/l1a/histogram.py,sha256=ptwPrVDSVjVWJKww3W1XGUNh0Hw9A56_aRZpSANCAwI,4791
-imap_processing/hi/l1a/science_direct_event.py,sha256=dd0-Nf1kTd35GMqVUbidLSLP6b8JVlTzBrJ4yyCNUWA,7150
-imap_processing/hi/l1b/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-imap_processing/hi/l1b/hi_l1b.py,sha256=IvHoTqtAf4u8zemWQ41frARR_gwbQboskp-7hk7AltY,14777
-imap_processing/hi/l1c/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-imap_processing/hi/l1c/hi_l1c.py,sha256=iHOmVZkKEhxwwne1T5tFMxJZjD2n5wI0-WueumTwA50,28459
-imap_processing/hi/l2/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-imap_processing/hi/l2/hi_l2.py,sha256=9Cd1FqdKk3ya6_u9f7gal-9pIxrLgEQT9EBREJ_DhOA,9288
+imap_processing/hi/hi_l1a.py,sha256=m-KGuWw6NzRNuJJp8RVQI1zy636GS7HkXjJNSedPlJ0,14731
+imap_processing/hi/hi_l1b.py,sha256=PegKVakMz_M73eenywiNmna_LlHPLCqRzAKkoEA5uR8,14759
+imap_processing/hi/hi_l1c.py,sha256=lT_XFSRME1ol7Bo2y38RCHghEEXeW21oQ2Rcj2fmjDo,28529
+imap_processing/hi/hi_l2.py,sha256=veO2FdinuiRcONQ5JucnRj8lvs6wwLVrA_oveqsFzFE,9360
 imap_processing/hi/packet_definitions/TLM_HI_COMBINED_SCI.xml,sha256=Cwu_sE-b6lpXtuikQKuU5uQ_pMFTG9HoZeH9c-QDQgU,251743
 imap_processing/hi/packet_definitions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-imap_processing/hi/utils.py,sha256=J_LpWqnhZnukhNk5EVyGaU6ZNZjcCosQ-RUSUTFjXFc,8098
+imap_processing/hi/utils.py,sha256=mZZtOK4S2Mu0uBfPY72x74gtt70anu4sA62PKUjwERk,8097
 imap_processing/hit/__init__.py,sha256=Ga6Ioj68HnQ4moi7SxJdOyYmGHcRvKOh4uZUEPJZHl4,20
 imap_processing/hit/hit_utils.py,sha256=-O8xt90w6sMPQ2t4CYmqrwkBw3rF1h1dMn58Q3Ioz3g,13371
 imap_processing/hit/l0/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -117,20 +111,20 @@ imap_processing/hit/l0/decom_hit.py,sha256=ur0M3AVhuptWRvUVUvugxfAMf6yKI0Xee_7RN
 imap_processing/hit/l1a/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 imap_processing/hit/l1a/hit_l1a.py,sha256=BWxm73t6CeNXBt23NArnkXufeRH_OkhVOReLXEpiD3M,11241
 imap_processing/hit/l1b/constants.py,sha256=ZL5h2GgC5j_s11YgMxtY4EHpmkfo6IXnniCv-iXdG84,9692
-imap_processing/hit/l1b/hit_l1b.py,sha256=7CwzKpWD8HgsdQN0T72Dj9tP-jOE5_4kMViJ5yzFpYg,17495
+imap_processing/hit/l1b/hit_l1b.py,sha256=nXy8SUXJujFcWOrOBufmdrxq9xzdmB9dyZQOYz3-xiM,18489
 imap_processing/hit/l2/constants.py,sha256=jvs7Uic3Bl1wyRC01s1-F5LAsTzTwi089TpN19fvlFg,18813
 imap_processing/hit/l2/hit_l2.py,sha256=E_3hyn_XzmnUbAFqTSHeM_QQtCYqMnOzLm6Km_crmOk,27102
 imap_processing/hit/packet_definitions/hit_packet_definitions.xml,sha256=CyYmMnuObmk2y1nlrd7xOZnwZ_qZ3X__AhhKmRyNOvg,136147
 imap_processing/ialirt/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+imap_processing/ialirt/constants.py,sha256=mwVPgSVNuPpTO4zx3LeUW7L5a6aJG2ZrezObPvR9s1c,1241
 imap_processing/ialirt/l0/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 imap_processing/ialirt/l0/ialirt_spice.py,sha256=WNuMlxA5UDGiBd8ap2k_dHxFmi2UCFgnQ4_wEZUhVU0,5649
 imap_processing/ialirt/l0/mag_l0_ialirt_data.py,sha256=vgIerXkk4ZoOxxVaNEgvM1ESWVkGusSZ-3k73-Cl_tI,5276
-imap_processing/ialirt/l0/parse_mag.py,sha256=x51q2w_GPToSfKSnYzsscJkvsC2B8VSdL0jUuSo3FmQ,12780
-imap_processing/ialirt/l0/process_codicehi.py,sha256=cYkm_mKa502g4IeetTH-fVwxjFEZ2tRYFJ9WjrTEp40,4778
-imap_processing/ialirt/l0/process_codicelo.py,sha256=pF-1vBmIv2JhKzblSHgJMTXK23psJqCdFgWpL-ppl_Y,1037
-imap_processing/ialirt/l0/process_hit.py,sha256=Hws13pxQWRh7hYV2kl4bvg9R0sAtUo3DfnGAuaN5xSk,5680
-imap_processing/ialirt/l0/process_swapi.py,sha256=CLS-NVTddI1dGXEXdjSor2RNGnmdxMTe1_-WlU1PmyI,2113
-imap_processing/ialirt/l0/process_swe.py,sha256=5GGQ_f6uQlaEZB4vxIxvWCUUdN28coZHStxgqleyQWg,18150
+imap_processing/ialirt/l0/parse_mag.py,sha256=v5Efczml4s-TFdREhjg3A6PzEFTYAx4dbJyeACmkbPc,12787
+imap_processing/ialirt/l0/process_codice.py,sha256=_LvZJ-dt7Qbw41glYS4BdIJZhhChBIk8DvueyNphW4g,3062
+imap_processing/ialirt/l0/process_hit.py,sha256=HJ_h8nd5Xs0NC-mWNS7Ce3D86H1408lT6ZCdXlNQv48,5408
+imap_processing/ialirt/l0/process_swapi.py,sha256=EBr-wQB4IDrdYON80g8f9neNkUXTAAUMv3wlB1MXfr4,7490
+imap_processing/ialirt/l0/process_swe.py,sha256=QXp6rmlxw8K5M0bapKwAArCd_99qHFS8sxOnhHLVkhU,17953
 imap_processing/ialirt/packet_definitions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 imap_processing/ialirt/packet_definitions/ialirt.xml,sha256=-hlT16Mr2Q6uCUfJ3jdpw0mPdeGCcZiWiorbkiEanwA,40784
 imap_processing/ialirt/packet_definitions/ialirt_codicehi.xml,sha256=PwzGTJj4dROXJBqbT32UZ6swaPbjvXdXXn7E_Lxch2A,11367
@@ -140,8 +134,8 @@ imap_processing/ialirt/packet_definitions/ialirt_mag.xml,sha256=Kt3t3S1gk7kqv006
 imap_processing/ialirt/packet_definitions/ialirt_swapi.xml,sha256=tGC4V-IV7WO6U3HtC2rDWA-500oOubcXgidMNyeGOE4,8400
 imap_processing/ialirt/packet_definitions/ialirt_swe.xml,sha256=FJNhfWjBjK1Ze3BCW86hvNJIiWoIK5dujt2Dw76pjF0,13442
 imap_processing/ialirt/process_ephemeris.py,sha256=RN6rzEY4KBc0V-ZKrsKffu8MEo7k0q3zJATBqaat9OY,8073
-imap_processing/ialirt/utils/constants.py,sha256=tdsY51p0qTOtTVrEdqPbHgBbXJMYQ80dpnVIK6MddQw,1852
-imap_processing/ialirt/utils/create_xarray.py,sha256=e4yLK725-BAkBjVAZWQPW9TLUNB_ZiqoByH4fezzaXg,2938
+imap_processing/ialirt/utils/constants.py,sha256=rF9KlnVig5Xk82lwo4OGbFPgf60lYNKHRP3FrlDQ4ls,2324
+imap_processing/ialirt/utils/create_xarray.py,sha256=mNMiFk06YTl7dUxqguNtX_qytISWfp9VqVaVm6vF-NI,4743
 imap_processing/ialirt/utils/grouping.py,sha256=Hk5u_TC0r72fN6s2CUEsD6opGig31EiwnRepAH9oOEE,3795
 imap_processing/ialirt/utils/time.py,sha256=fXBDKxNp2IXYJ1laSPPAIw_GTKvjFIgPwh54fnNQMEI,636
 imap_processing/idex/__init__.py,sha256=jO9AUm6ORgQhIHszOzLb3Vb2RVyz_SDUV64peGcr20A,52
@@ -262,10 +256,10 @@ imap_processing/ultra/packet_definitions/README.md,sha256=Iam1bd6UVkRLayApXlHG_y
 imap_processing/ultra/packet_definitions/ULTRA_SCI_COMBINED.xml,sha256=q1Bmz5vJTdqjBcKPExBZ_LCismlQFHOFyTUI1dJsjiY,939289
 imap_processing/ultra/packet_definitions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 imap_processing/ultra/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-imap_processing/ultra/utils/ultra_l1_utils.py,sha256=QbDKjBo2m78AZMCorDdPpCL-ayQa7Fkm2PEbwmThCGU,5243
+imap_processing/ultra/utils/ultra_l1_utils.py,sha256=W1wABph96AJVkFNGrmq_0Vf6i__fIFxIVTvjCPbysY0,5321
 imap_processing/utils.py,sha256=zdcBXBQKL2NnElJcEbd-2QPeEDz0H3Yy0hVjRy9xcCE,14062
-imap_processing-0.15.0.dist-info/LICENSE,sha256=F2rxhvc6auEI0Dk9IGjglQSQQk60EvTe8M1dORMZPOg,1098
-imap_processing-0.15.0.dist-info/METADATA,sha256=o3cpLf1n619mCGzVt3RgsHIBuLiQo7z4eIjStubAg5U,9102
-imap_processing-0.15.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-imap_processing-0.15.0.dist-info/entry_points.txt,sha256=5r8ijLImHSNJxr-SGDC8kJy81BtXjmeUOmNfWSfLuRs,104
-imap_processing-0.15.0.dist-info/RECORD,,
+imap_processing-0.16.0.dist-info/LICENSE,sha256=F2rxhvc6auEI0Dk9IGjglQSQQk60EvTe8M1dORMZPOg,1098
+imap_processing-0.16.0.dist-info/METADATA,sha256=ejLO2sQJAM297xzu16ALDVLTqqDA3CXQuqJg2kh8tiM,9102
+imap_processing-0.16.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+imap_processing-0.16.0.dist-info/entry_points.txt,sha256=5r8ijLImHSNJxr-SGDC8kJy81BtXjmeUOmNfWSfLuRs,104
+imap_processing-0.16.0.dist-info/RECORD,,

imap_processing/hi/l1a/hi_l1a.py

@@ -1,98 +0,0 @@
-"""IMAP-HI L1A processing module."""
-
-import logging
-from pathlib import Path
-from typing import Union
-
-import xarray as xr
-
-from imap_processing import imap_module_directory
-from imap_processing.cdf.imap_cdf_manager import ImapCdfAttributes
-from imap_processing.hi.l1a.histogram import create_dataset as hist_create_dataset
-from imap_processing.hi.l1a.science_direct_event import science_direct_event
-from imap_processing.hi.utils import HIAPID
-from imap_processing.utils import packet_file_to_datasets
-
-logger = logging.getLogger(__name__)
-
-
-def hi_l1a(packet_file_path: Union[str, Path]) -> list[xr.Dataset]:
-    """
-    Will process IMAP raw data to l1a.
-
-    Parameters
-    ----------
-    packet_file_path : str
-        Data packet file path.
-
-    Returns
-    -------
-    processed_data : list[xarray.Dataset]
-        List of processed xarray dataset.
-    """
-    datasets_by_apid = hi_packet_file_to_datasets(packet_file_path)
-
-    # Process science to l1a.
-    processed_data = []
-    for apid in datasets_by_apid:
-        try:
-            apid_enum = HIAPID(apid)
-        except ValueError as err:
-            raise RuntimeError(f"Encountered unexpected APID [{apid}]") from err
-
-        logger.info(f"Processing IMAP-Hi data for {apid_enum.name} packets")
-
-        if apid_enum in [HIAPID.H45_SCI_CNT, HIAPID.H90_SCI_CNT]:
-            data = hist_create_dataset(datasets_by_apid[apid])
-            gattr_key = "imap_hi_l1a_hist_attrs"
-        elif apid_enum in [HIAPID.H45_SCI_DE, HIAPID.H90_SCI_DE]:
-            data = science_direct_event(datasets_by_apid[apid])
-            gattr_key = "imap_hi_l1a_de_attrs"
-        elif apid_enum in [HIAPID.H45_APP_NHK, HIAPID.H90_APP_NHK]:
-            data = datasets_by_apid[apid]
-            gattr_key = "imap_hi_l1a_hk_attrs"
-        elif apid_enum in [HIAPID.H45_DIAG_FEE, HIAPID.H90_DIAG_FEE]:
-            data = datasets_by_apid[apid]
-            gattr_key = "imap_hi_l1a_diagfee_attrs"
-
-        # Update dataset global attributes
-        attr_mgr = ImapCdfAttributes()
-        attr_mgr.add_instrument_global_attrs("hi")
-        data.attrs.update(attr_mgr.get_global_attributes(gattr_key))
-
-        # set the sensor string in Logical_source
-        sensor_str = apid_enum.sensor
-        data.attrs["Logical_source"] = data.attrs["Logical_source"].format(
-            sensor=sensor_str
-        )
-        processed_data.append(data)
-    return processed_data
-
-
-def hi_packet_file_to_datasets(
-    packet_file_path: Union[str, Path], use_derived_value: bool = False
-) -> dict[int, xr.Dataset]:
-    """
-    Extract hi datasets from packet file.
-
-    Parameters
-    ----------
-    packet_file_path : str
-        L0 packet file path.
-    use_derived_value : bool
-        Whether to use the derived value from the XTCE definition. Default is False.
-
-    Returns
-    -------
-    datasets : dict[int, xarray.Dataset]
-        Dictionary of xarray datasets keyed by APID.
-    """
-    packet_def_file = (
-        imap_module_directory / "hi/packet_definitions/TLM_HI_COMBINED_SCI.xml"
-    )
-    datasets_by_apid = packet_file_to_datasets(
-        packet_file=packet_file_path,
-        xtce_packet_definition=packet_def_file,
-        use_derived_value=use_derived_value,
-    )
-    return datasets_by_apid

imap_processing/hi/l1a/histogram.py

@@ -1,152 +0,0 @@
-"""Unpack IMAP-Hi histogram data."""
-
-import numpy as np
-import xarray as xr
-from numpy._typing import NDArray
-
-from imap_processing.cdf.imap_cdf_manager import ImapCdfAttributes
-
-# define the names of the 24 counter arrays
-# contained in the histogram packet
-QUALIFIED_COUNTERS = (
-    "ab_qualified",
-    "c1c2_qualified",
-    "ac1_qualified",
-    "bc1_qualified",
-    "abc1_qualified",
-    "ac1c2_qualified",
-    "bc1c2_qualified",
-    "abc1c2_qualified",
-)
-LONG_COUNTERS = (
-    "a_first_only",
-    "b_first_only",
-    "c_first_only",
-    "ab_long",
-    "c1c2_long",
-    "ac1_long",
-    "bc1_long",
-    "abc1_long",
-    "ac1c2_long",
-    "bc1c2_long",
-    "abc1c2_long",
-)
-TOTAL_COUNTERS = ("a_total", "b_total", "c_total", "fee_de_recd", "fee_de_sent")
-
-
-def create_dataset(input_ds: xr.Dataset) -> xr.Dataset:
-    """
-    Create dataset for a number of Hi Histogram packets.
-
-    Parameters
-    ----------
-    input_ds : xarray.Dataset
-        Dataset of packets generated using the
-        `imap_processing.utils.packet_file_to_datasets` function.
-
-    Returns
-    -------
-    dataset : xarray.Dataset
-        Dataset with all metadata field data in xr.DataArray.
-    """
-    attr_mgr = ImapCdfAttributes()
-    attr_mgr.add_instrument_global_attrs(instrument="hi")
-    attr_mgr.add_instrument_variable_attrs(instrument="hi", level=None)
-
-    # Rename shcoarse variable (do this first since it copies the input_ds)
-    dataset = input_ds.rename_vars({"shcoarse": "ccsds_met"})
-
-    dataset.epoch.attrs.update(
-        attr_mgr.get_variable_attributes("epoch"),
-    )
-    # Add the hist_angle coordinate
-    # Histogram data is binned in 90, 4-degree bins
-    attrs = attr_mgr.get_variable_attributes("hi_hist_angle")
-    dataset.coords.update(
-        {
-            "angle": xr.DataArray(
-                np.arange(2, 360, 4),
-                name="angle",
-                dims=["angle"],
-                attrs=attrs,
-            )
-        }
-    )
-    # Update existing variable attributes
-    for var_name in [
-        "version",
-        "type",
-        "sec_hdr_flg",
-        "pkt_apid",
-        "seq_flgs",
-        "src_seq_ctr",
-        "pkt_len",
-        "ccsds_met",
-        "esa_step",
-        "num_of_spins",
-        "cksum",
-    ]:
-        attrs = attr_mgr.get_variable_attributes(f"hi_hist_{var_name}")
-        dataset.data_vars[var_name].attrs.update(attrs)
-
-    new_vars = dict()
-    # Populate 90-element histogram counters
-    default_counter_attrs = attr_mgr.get_variable_attributes("hi_hist_counters")
-    for counter_name in (*QUALIFIED_COUNTERS, *LONG_COUNTERS, *TOTAL_COUNTERS):
-        # Inject counter name into generic counter attributes
-        counter_attrs = default_counter_attrs.copy()
-        for key, val in counter_attrs.items():
-            if isinstance(val, str) and "{counter_name}" in val:
-                counter_attrs[key] = val.format(counter_name=counter_name)
-        # Instantiate the counter DataArray
-        new_vars[counter_name] = xr.DataArray(
-            data=unpack_hist_counter(input_ds[counter_name].data.sum()),
-            dims=["epoch", "angle"],
-            attrs=counter_attrs,
-        )
-
-    # Generate label variable for angle coordinate
-    new_vars["angle_label"] = xr.DataArray(
-        dataset.coords["angle"].values.astype(str),
-        name="angle_label",
-        dims=["angle"],
-        attrs=attr_mgr.get_variable_attributes(
-            "hi_hist_angle_label", check_schema=False
-        ),
-    )
-
-    dataset.update(new_vars)
-
-    return dataset
-
-
-def unpack_hist_counter(counter_bytes: bytes) -> NDArray[np.uint16]:
-    """
-    Unpack Hi SCI_CNT counter data for a single counter.
-
-    Parameters
-    ----------
-    counter_bytes : bytes
-        Sum individual bytes for all epochs of a Hi SCI_CNT counter.
-
-    Returns
-    -------
-    output_array : numpy.ndarray[numpy.uint16]
-        The unpacked 12-bit unsigned integers for the input bytes. The
-        output array has a shape of (n, 90) where n is the number of SCI_CNT
-        packets in the input dataset.
-    """
-    # Interpret bytes for all epochs of current counter as uint8 array
-    counter_uint8 = np.frombuffer(counter_bytes, dtype=np.uint8)
-    # Split into triplets of upper-byte, split-byte and lower-byte arrays
-    upper_uint8, split_unit8, lower_uint8 = np.reshape(
-        counter_uint8, (3, -1), order="F"
-    ).astype(np.uint16)
-    # Compute even indexed uint12 values from upper-byte and first 4-bits of
-    # split-byte
-    even_uint12 = (upper_uint8 << 4) + (split_unit8 >> 4)
-    # Compute odd indexed uint12 values from lower 4-bits of split-byte and
-    # lower-byte
-    odd_uint12 = ((split_unit8 & (2**4 - 1)) << 8) + lower_uint8
-    output_array = np.column_stack((even_uint12, odd_uint12)).reshape(-1, 90)
-    return output_array

imap_processing/hi/l1a/science_direct_event.py

@@ -1,214 +0,0 @@
-"""IMAP-Hi direct event processing."""
-
-import logging
-from collections import defaultdict
-
-import numpy as np
-import numpy._typing as npt
-import xarray as xr
-
-from imap_processing.cdf.imap_cdf_manager import ImapCdfAttributes
-from imap_processing.spice.time import met_to_ttj2000ns
-
-# TODO: read DE_CLOCK_TICK_US from
-# instrument status summary later. This value
-# is rarely change but want to be able to change
-# it if needed. It stores information about how
-# fast the time was ticking. It is in microseconds.
-DE_CLOCK_TICK_US = 1999
-DE_CLOCK_TICK_S = DE_CLOCK_TICK_US / 1e6
-HALF_CLOCK_TICK_S = DE_CLOCK_TICK_S / 2
-
-MILLISECOND_TO_S = 1e-3
-
-logger = logging.getLogger(__name__)
-
-
-def parse_direct_events(de_data: bytes) -> dict[str, npt.ArrayLike]:
-    """
-    Parse event data from a binary blob.
-
-    IMAP-Hi direct event data information is stored in
-    48-bits as follows:
-
-    |        Read 48-bits into 16, 2, 10, 10, 10, bits. Each of these breaks
-    |        down as:
-    |
-    |            de_tag - 16 bits
-    |            start_bitmask_data - 2 bits (tA=1, tB=2, tC1=3)
-    |            tof_1 - 10 bit counter
-    |            tof_2 - 10 bit counter
-    |            tof_3 - 10 bit counter
-
-    There are at most total of 664 of 48-bits in each data packet.
-    This data packet is of variable length. If there is one event, then
-    DE_TOF will contain 48-bits. If there are 664 events, then
-    DE_TOF will contain 664 x 48-bits. If there is no event, then
-    DE_TOF will contain 0-bits.
-
-    There should be two data packets per ESA. Each packet contains meta-event
-    data that is identical between the two packets for a common ESA.
-    If there is no event record for certain ESA step, then both packets will
-    contain 0-bits in DE_TOF.
-
-    Parameters
-    ----------
-    de_data : bytes
-        Binary blob from de_tag field of SCI_DE packet. Must be an integer
-        multiple of 48-bits of data.
-
-    Returns
-    -------
-    Dict[str, list]
-        Parsed event data.
-    """
-    # The de_data is a binary blob with Nx6 bytes of data where N = number of
-    # direct events encoded into the binary blob. Interpreting the data as
-    # big-endian uint16 data and reshaping into a (3, -1) ndarray results
-    # in an array with shape (3, N). Indexing the first axis of that array
-    # (e.g. data_uint16[i]) gives the ith 2-bytes of data for each of the N
-    # direct events.
-    # Considering the 6-bytes of data for each DE as 3 2-byte words,
-    # each word contains the following:
-    # word_0: full 16-bits is the de_tag
-    # word_1: 2-bits of Trigger ID, 10-bits tof_1, upper 4-bits of tof_2
-    # word_2: lower 6-bits of tof_2, 10-bits of tof_3
-    data_uint16 = np.reshape(
-        np.frombuffer(de_data, dtype=">u2"), (3, -1), order="F"
-    ).astype(np.uint16)
-
-    de_dict = dict()
-    de_dict["de_tag"] = data_uint16[0]
-    de_dict["trigger_id"] = (data_uint16[1] >> 14).astype(np.uint8)
-    de_dict["tof_1"] = (data_uint16[1] & int(b"00111111_11110000", 2)) >> 4
-    de_dict["tof_2"] = ((data_uint16[1] & int(b"00000000_00001111", 2)) << 6) + (
-        data_uint16[2] >> 10
-    )
-    de_dict["tof_3"] = data_uint16[2] & int(b"00000011_11111111", 2)
-
-    return de_dict
-
-
-def create_dataset(de_data_dict: dict[str, npt.ArrayLike]) -> xr.Dataset:
-    """
-    Create xarray dataset.
-
-    Parameters
-    ----------
-    de_data_dict : Dict[list]
-        Dictionary of packet telemetry and direct event data lists.
-
-    Returns
-    -------
-    dataset : xarray.Dataset
-        Xarray dataset.
-    """
-    # Load the CDF attributes
-    attr_mgr = ImapCdfAttributes()
-    attr_mgr.add_instrument_global_attrs("hi")
-    attr_mgr.add_instrument_variable_attrs(instrument="hi", level=None)
-
-    # check_schema=False keeps DEPEND_0 = '' from being auto added
-    epoch_attrs = attr_mgr.get_variable_attributes("epoch", check_schema=False)
-    epoch_attrs["CATDESC"] = (
-        "CCSDS creation time, number of nanoseconds since J2000 with leap "
-        "seconds included"
-    )
-    epoch = xr.DataArray(
-        met_to_ttj2000ns(de_data_dict["ccsds_met"]),
-        name="epoch",
-        dims=["epoch"],
-        attrs=epoch_attrs,
-    )
-
-    event_met_attrs = attr_mgr.get_variable_attributes(
-        "hi_de_event_met", check_schema=False
-    )
-    # For L1A DE, event_met is its own dimension, so we remove the DEPEND_0 attribute
-    _ = event_met_attrs.pop("DEPEND_0")
-
-    # Compute the meta-event MET in seconds
-    meta_event_met = (
-        np.array(de_data_dict["meta_seconds"]).astype(np.float64)
-        + np.array(de_data_dict["meta_subseconds"]) * MILLISECOND_TO_S
-    )
-    # Compute the MET of each event in seconds
-    # event MET = meta_event_met + de_clock
-    # See Hi Algorithm Document section 2.2.5
-    event_met_array = np.array(
-        meta_event_met[de_data_dict["ccsds_index"]]
-        + np.array(de_data_dict["de_tag"]) * DE_CLOCK_TICK_S,
-        dtype=event_met_attrs.pop("dtype"),
-    )
-    event_met = xr.DataArray(
-        event_met_array,
-        name="event_met",
-        dims=["event_met"],
-        attrs=event_met_attrs,
-    )
-
-    dataset = xr.Dataset(
-        coords={"epoch": epoch, "event_met": event_met},
-    )
-
-    for var_name, data in de_data_dict.items():
-        attrs = attr_mgr.get_variable_attributes(
-            f"hi_de_{var_name}", check_schema=False
-        ).copy()
-        dtype = attrs.pop("dtype")
-        dataset[var_name] = xr.DataArray(
-            np.array(data, dtype=np.dtype(dtype)),
-            dims=attrs["DEPEND_0"],
-            attrs=attrs,
-        )
-
-    return dataset
-
-
-def science_direct_event(packets_data: xr.Dataset) -> xr.Dataset:
-    """
-    Unpack IMAP-Hi direct event data.
-
-    Processing step:
-
-    |    1. Break binary stream data into unit of 48-bits
-    |    2. Parse direct event data
-    |    5. Save the data into xarray dataset.
-
-    Parameters
-    ----------
-    packets_data : xarray.Dataset
-        Packets extracted into a dataset.
-
-    Returns
-    -------
-    dataset : xarray.Dataset
-        Xarray dataset.
-    """
-    de_data_dict: dict[str, list] = defaultdict(list)
-
-    # Add packet data to the dictionary, renaming some fields
-    # This is done first so that these variables are first in the CDF
-    for from_key, to_key in {
-        "shcoarse": "ccsds_met",
-        "src_seq_ctr": "src_seq_ctr",
-        "pkt_len": "pkt_len",
-        "last_spin_num": "last_spin_num",
-        "spin_invalids": "spin_invalids",
-        "esa_step_num": "esa_step",
-        "meta_seconds": "meta_seconds",
-        "meta_subseconds": "meta_subseconds",
-    }.items():
-        de_data_dict[to_key] = packets_data[from_key].data
-
-    # For each packet, parse the DE data and add it to the Pointing
-    # list of DE data usint `extend()`
-    for i, data in enumerate(packets_data["de_tof"].data):
-        parsed_de_data = parse_direct_events(data)
-        for key, new_data in parsed_de_data.items():
-            de_data_dict[key].extend(new_data)
-        # Record the ccsds packet index for each DE
-        de_data_dict["ccsds_index"].extend([i] * len(parsed_de_data["de_tag"]))
-
-    # create dataset
-    return create_dataset(de_data_dict)