diff --git a/imap_processing/hit/l0/data_classes/science_packet.py b/imap_processing/hit/l0/data_classes/science_packet.py new file mode 100644 index 000000000..621b0cbc9 --- /dev/null +++ b/imap_processing/hit/l0/data_classes/science_packet.py @@ -0,0 +1,256 @@ +"""L0 HIT Science Packet data class.""" + +from dataclasses import InitVar, dataclass + +import numpy as np + +from imap_processing.hit.l0.utils.hit_base import HITBase + +# TODO: add methods to the SciencePacket data class to decom attributes with binary data +# TODO: add __post_init__ method to SciencePacket data class to handle InitVar +# attributes + + +@dataclass +class SciencePacket(HITBase): + """L0 HIT Science Package data. + + This data class handles the decommutation of the HIT Science Packet + data. + + Attributes + ---------- + SHCOARSE: int + Spacecraft time + HDR_UNIT_NUM: int + Unit ID (e.g. EM) + HDR_FRAME_VERSION: int + Frame version number + HDR_STATUS_BITS: int + Status bits + HDR_MINUTE_CNT: int + Minute counter (minute mod 10 -> subcom for sectored rates) + LIVE_TIME: int + Livetime count (270=100%) + NUM_TRIG: int + Number of triggers + NUM_REJECT: int + Number of rejected events + NUM_ACC_W_PHA: int + Number of accepted events with PHA data + NUM_ACC_NO_PHA: int + Number of events without PHA data + NUM_HAZ_TRIG: int + Number of triggers with hazard flag + NUM_HAZ_REJECT: int + Number of rejected events with hazard flag + NUM_HAZ_ACC_W_PHA: int + Number of accepted hazard events with PHA data + NUM_HAZ_ACC_NO_PHA: int + Number of hazard events without PHA data + SNGRATES_HG: np.ndarray (int, (64,1)) + Counts since last science frame for PHA (hi gain) formatted as an array + SNGRATES_LG: np.ndarray (int, (64,1)) + Counts since last science frame for PHA (low gain) formatted as an array + NREAD: int + Events read from event fifo + NHAZARD: int + Events tagged with hazard flag + NADSTIM: int + adc-stim events + NODD: int + Odd events + NODDFIX: int + Odd events that were fixed in sw + NMULTI: int + Events with multiple hits in a single detector (may be crosstalk) + NMULTIFIX: int + Multi events that were fixed in sw + NBADTRAJ: int + Bad trajectory + NL2: int + Events sorted into L12 event category + NL3: int + Events sorted into L123 event category + NL4: int + Events sorted into L1423 event category + NPEN: int + Events sorted into PEN (penetrating) event category + NFORMAT: int + Nothing currently goes in this slot + NASIDE: int + A-side events + NBSIDE: int + B-side events + NERROR: int + Events that caused a processing error - should never happen + NBADTAGS: int + Events with inconsistent tags vs pulse heights + COINRATES: np.ndarray (int, (26,1)) + Coincidence rates for all detectors formatted into an array + BUFRATES: np.ndarray (int, (31,1)) + Priority Buffer: ADC cal events formatted into an array + L2FGRATES: np.ndarray (int, (132,1)) + R2 foreground rates formatted into an array + L2BGRATES: np.ndarray (int, (12,1)) + R2 background rates formatted into an array + L3FGRATES: np.ndarray (int, (167,1)) + R3 foreground rates formatted into an array + L3BGRATES: np.ndarray (int, (12,1)) + R3 background rates formatted into an array + PENFGRATES: np.ndarray (int, (15,1)) + R4 foreground rates formatted into an array + PENBGRATES: np.ndarray (int, (15,1)) + R4 foreground rates formatted into an array + IALIRTRATES: np.ndarray (int, (20,1)) + I-ALiRT rates formatted into an array + SECTORATES: np.ndarray (int, (120,1)) + R4 background rates formatted into an array + L4FGRATES: np.ndarray (int, (48,1)) + L4 ions foreground rates formatted into an array + L4BGRATES: np.ndarray (int, (24,1)) + L4 ions background rates formatted into an array + PHA_RECORDS: np.ndarray (int, (917,1)) + Event PHA records, array of 4-byte fields, formatted into an array + SNGRATES_RAW: InitVar[str] + Raw binary for PHA high gain and low gain for all detectors + COINRATES_RAW: InitVar[str] + Raw binary for coincidence rates for all detectors + BUFRATES_RAW: InitVar[str] + Raw binary for ADC calibration events + L2FGRATES_RAW: InitVar[str] + Raw binary for R2 foreground rates + L2BGRATES_RAW: InitVar[str] + Raw binary for R2 background rates + L3FGRATES_RAW: InitVar[str] + Raw binary for R3 foreground rates + L3BGRATES_RAW: InitVar[str] + Raw binary for R3 background rates + PENFGRATES_RAW: InitVar[str] + Raw binary for R4 foreground rates + PENBGRATES_RAW: InitVar[str] + Raw binary for R4 background rates + IALIRTRATES_RAW: InitVar[str] + Raw binary for I-ALiRT rates + SECTORATES_RAW: InitVar[str] + Raw binary for sector rates + L4FGRATES_RAW: InitVar[str] + Raw binary for L4 Ions foreground rates + L4BGRATES_RAW: InitVar[str] + Raw binary for L4 Ions background rates + PHA_RECORDS_RAW: InitVar[str] + Raw binary for event PHA records + """ + + SHCOARSE: int + HDR_UNIT_NUM: int + HDR_FRAME_VERSION: int + HDR_STATUS_BITS: int + HDR_MINUTE_CNT: int + LIVE_TIME: int + NUM_TRIG: int + NUM_REJECT: int + NUM_ACC_W_PHA: int + NUM_ACC_NO_PHA: int + NUM_HAZ_TRIG: int + NUM_HAZ_REJECT: int + NUM_HAZ_ACC_W_PHA: int + NUM_HAZ_ACC_NO_PHA: int + SNGRATES_HG: np.ndarray + SNGRATES_LG: np.ndarray + NREAD: int + NHAZARD: int + NADSTIM: int + NODD: int + NODDFIX: int + NMULTI: int + NMULTIFIX: int + NBADTRAJ: int + NL2: int + NL3: int + NL4: int + NPEN: int + NFORMAT: int + NASIDE: int + NBSIDE: int + NERROR: int + NBADTAGS: int + COINRATES: np.ndarray + BUFRATES: np.ndarray + L2FGRATES: np.ndarray + L2BGRATES: np.ndarray + L3FGRATES: np.ndarray + L3BGRATES: np.ndarray + PENFGRATES: np.ndarray + PENBGRATES: np.ndarray + IALIRTRATES: np.ndarray + SECTORATES: np.ndarray + L4FGRATES: np.ndarray + L4BGRATES: np.ndarray + PHA_RECORDS: np.ndarray + SNGRATES_RAW: InitVar[str] + COINRATES_RAW: InitVar[str] + BUFRATES_RAW: InitVar[str] + L2FGRATES_RAW: InitVar[str] + L2BGRATES_RAW: InitVar[str] + L3FGRATES_RAW: InitVar[str] + L3BGRATES_RAW: InitVar[str] + PENFGRATES_RAW: InitVar[str] + PENBGRATES_RAW: InitVar[str] + IALIRTRATES_RAW: InitVar[str] + SECTORATES_RAW: InitVar[str] + L4FGRATES_RAW: InitVar[str] + L4BGRATES_RAW: InitVar[str] + PHA_RECORDS_RAW: InitVar[str] + + +@dataclass +class SectorRates: + """L0 PHA Record data. + + A data class for PHA Record data which will be stored + in the SciencePacket PHA_RECORDS attribute + + Attributes + ---------- + TBD - talk to Eric for descriptions + """ + + RATE_TYPE: int + DATA: int + + +@dataclass +class PHARecord: + """L0 Sector Rates data. + + A data class for Sector Rate data which will be stored + in the SciencePacket SECTORATES attribute + + Attributes + ---------- + TBD - talk to Eric for descriptions + """ + + particle_id: int + priority_buffer_num: int + stim_tag: int + haz_tag: int + time_tag: int + a_b_side: int + has_unread_adc: bool + extended_header_flag: int + culling_flag: int + detector_flags: int + de_index: int + ep_index: int + stim_block: int + dac_value: int + pha_number: int + stim_step: int + stim_gain: int + astim: int + adc_value: int + detector_address: int + gain_flag: int + last_pha_in_event: int diff --git a/imap_processing/hit/packet_definitions/P_HIT_SCIENCE.xml b/imap_processing/hit/packet_definitions/P_HIT_SCIENCE.xml new file mode 100644 index 000000000..9611b91da --- /dev/null +++ b/imap_processing/hit/packet_definitions/P_HIT_SCIENCE.xml @@ -0,0 +1,371 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 192 + + + + + + + + 240 + + + + + + + + 320 + + + + + + + + 384 + + + + + + + + 416 + + + + + + + + 512 + + + + + + + + 528 + + + + + + + + 768 + + + + + + + + 1856 + + + + + + + + 1920 + + + + + + + + 2112 + + + + + + + + 2672 + + + + + + + + 29344 + + + + + + + CCSDS Packet Version Number (always 0) + + + CCSDS Packet Type Indicator (0=telemetry) + + + CCSDS Packet Secondary Header Flag (always 1) + + + CCSDS Packet Application Process ID + + + CCSDS Packet Grouping Flags (3=not part of group) + + + CCSDS Packet Sequence Count (increments with each new packet) + + + CCSDS Packet Length (number of bytes after Packet length minus 1) + + + CCSDS Packet Sec Header + + + Science Frame Header + + + Science Frame Header + + + Science Frame Header + + + Science Frame Header + + + Science Frame Header + + + Livetime counter, Front End Electronics. Expect 270 counts at 100% live time + + + Number of triggers + + + Number of rejected events + + + Number of accepted events with PHA data + + + Number of events without PHA data + + + Number of triggers with hazard flag + + + Number of rejected events with hazard flag + + + Number of accepted hazard events with PHA data + + + Number of hazard events without PHA data + + + Counts since last science frame for PHA high gain and low gain for all detectors + + + events read from event fifo + + + events rejected for Hazard condition + + + ADC-calibration STIM events + + + odd events + + + fixed odd events + + + events with multiple hits in relevant layers + + + fixed multi events + + + events rejected for inconsistent/bad trajectory + + + events sorted into L12 event category + + + events sorted into L123 event category + + + events sorted into L1423 event category + + + events sorted into PEN (penetrating) event category + + + events handled b the telemetry event formatter + + + events the software assumed were A-side events + + + events the software assumed were B-side events + + + events that caused a processing error - should never happen + + + events with bad tags from onboard event processing + + + Coincidence rates for all detectors + + + ADC calibration events + + + Range 2 (L1L2) foreground rates + + + Range 2 (L1L2) background rates + + + Range 3 (L2L3) foreground rates + + + Range 3 (L2L3) background rates + + + Range 4 (L3AL3B) foreground rates + + + Range 4 (PEN) background rates and livetime STIM events + + + I-ALiRT rates + + + sector(j,k); j -> 22.5 deg declination bins from sunward spin axis; k -> 24 deg azimuthal/spin bins from spin phase 0; species ID = (HDR_MIN_COUNT mod 10) + + + L4 Ions (L1L4L2, L1L4L2L3, L1L4L3L3) foreground rate + + + L4 Ions (L1L4L2, L1L4L2L3, L1L4L3L3) background rate + + + Event PHA records, array of 4-byte fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/poetry.lock b/poetry.lock index 9593421e3..9483fdfff 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1084,6 +1084,7 @@ files = [ {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515"}, + {file = "PyYAML-6.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290"}, {file = "PyYAML-6.0.1-cp310-cp310-win32.whl", hash = "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924"}, {file = "PyYAML-6.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d"}, {file = "PyYAML-6.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007"}, @@ -1091,8 +1092,16 @@ files = [ {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673"}, + {file = "PyYAML-6.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b"}, {file = "PyYAML-6.0.1-cp311-cp311-win32.whl", hash = "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741"}, {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, + {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, + {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, + {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"}, + {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, + {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, + {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, + {file = "PyYAML-6.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df"}, {file = "PyYAML-6.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c"}, @@ -1109,6 +1118,7 @@ files = [ {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735"}, + {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"}, {file = "PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206"}, {file = "PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62"}, {file = "PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8"}, @@ -1116,6 +1126,7 @@ files = [ {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c"}, + {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"}, {file = "PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c"}, {file = "PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486"}, {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"}, diff --git a/pyproject.toml b/pyproject.toml index 162cd6ab3..ab5dab931 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -84,3 +84,6 @@ convention = "numpy" [tool.poetry.scripts] imap_cli = 'imap_processing.cli:main' + +[tool.codespell] +ignore-words-list = "livetime" diff --git a/tools/xtce_generation/xtce_generator_hit.py b/tools/xtce_generation/xtce_generator_hit.py index d119d5f3a..f85ff28c9 100644 --- a/tools/xtce_generation/xtce_generator_hit.py +++ b/tools/xtce_generation/xtce_generator_hit.py @@ -12,7 +12,7 @@ def main(): packet_definition_path = ( f"{imap_module_directory}/{instrument_name}/packet_definitions" ) - path_to_excel_file = f"{current_directory}/TLM_HIT_modified.xls" + path_to_excel_file = f"{current_directory}/TLM_HIT_modified.xlsx" # Lo packets packets = {