imap-processing 0.8.0__py3-none-any.whl → 0.9.0__py3-none-any.whl

imap_processing/_version.py

@@ -1,3 +1,3 @@
 # These version placeholders will be replaced later during substitution.
-__version__ = "0.8.0"
-__version_tuple__ = (0, 8, 0)
+__version__ = "0.9.0"
+__version_tuple__ = (0, 9, 0)

imap_processing/ccsds/excel_to_xtce.py

@@ -78,6 +78,7 @@ class XTCEGenerator:
     """
 
     def __init__(self, path_to_excel_file: Path):
+        self.source_file = path_to_excel_file.name
         # Read in all sheets from the excel file
         self.sheets = pd.read_excel(path_to_excel_file, sheet_name=None)
         # Set up the packet mapping from packetName to Apid
@@ -123,6 +124,7 @@ class XTCEGenerator:
             ].values[0]
         )
         header.attrib["author"] = "IMAP SDC"
+        header.attrib["source_file"] = self.source_file
 
         # Create the TelemetryMetaData element
         self._telemetry_metadata = Et.SubElement(root, "xtce:TelemetryMetaData")

imap_processing/cdf/config/imap_hi_variable_attrs.yaml

@@ -55,6 +55,54 @@ default_float32_attrs: &default_float32
   VALIDMAX: 3.4028235e+38
   dtype: float32
 
+default_ccsds_version: &default_ccsds_version
+  <<: *default_uint8
+  CATDESC: CCSDS packet version number
+  FIELDNAM: CCSDS version
+  VAR_TYPE: support_data
+
+default_ccsds_type: &default_ccsds_type
+  <<: *default_uint8
+  CATDESC: CCSDS packet type
+  FIELDNAM: CCSDS type
+  VAR_TYPE: support_data
+
+default_ccsds_sec_hdr_flg: &default_ccsds_sec_hdr_flg
+  <<: *default_uint8
+  CATDESC: CCSDS secondary header flag
+  FIELDNAM: CCSDS secondary header flag
+  VAR_TYPE: support_data
+
+default_ccsds_pkt_apid: &default_ccsds_pkt_apid
+  <<: *default_uint16
+  CATDESC: CCSDS application process ID
+  FIELDNAM: CCSDS APID
+  VAR_TYPE: support_data
+
+default_ccsds_seq_flgs: &default_ccsds_seq_flgs
+  <<: *default_uint8
+  CATDESC: CCSDS sequence flags
+  FIELDNAM: CCSDS sequence flags
+  VAR_TYPE: support_data
+
+default_ccsds_src_seq_ctr: &default_ccsds_src_seq_ctr
+  <<: *default_uint16
+  CATDESC: CCSDS source sequence counter
+  FIELDNAM: CCSDS sequence counter
+  VAR_TYPE: support_data
+
+default_ccsds_pkt_len: &default_ccsds_pkt_len
+  <<: *default_uint16
+  CATDESC: CCSDS packet length
+  FIELDNAM: CCSDS packet length
+  VAR_TYPE: support_data
+
+default_ccsds_cksum: &default_ccsds_cksum
+  <<: *default_uint16
+  CATDESC: CCSDS packet checksum
+  FIELDNAM: CCSDS packet checksum
+  VAR_TYPE: support_data
+
 default_ccsds_met: &hi_ccsds_met
   <<: *default_uint32
   CATDESC: CCSDS mission elapsed time (MET). 32-bit integer value that represents the MET in seconds.
@@ -78,12 +126,33 @@ hi_esa_step: &hi_esa_step
     outer ESA surfaces.
 
 # ======= L1A DE Section =======
+hi_de_src_seq_ctr:
+  <<: *default_ccsds_src_seq_ctr
+
+hi_de_pkt_len:
+  <<: *default_ccsds_pkt_len
+
 hi_de_ccsds_met:
   <<: *hi_ccsds_met
 
+hi_de_last_spin_num:
+  <<: *default_uint8
+  CATDESC: Spin number (1-based) for the first spin in the packet
+  FIELDNAM: last spin
+  FORMAT: I2
+  LABLAXIS: last spin
+  VALIDMAX: 15
+
+hi_de_spin_invalids:
+  <<: *default_uint8
+  CATDESC: Binary mask where a 1-bit indicates an invalid spin for coresponding spin in packet
+  FIELDNAM: spin flags
+  FORMAT: I3
+  LABLAXIS: spin flag
+
 hi_de_de_tag:
   <<: *default_uint16
-  CATDESC: Ticks (nominally 2 ms) since last meta-event
+  CATDESC: Ticks (nominally 1999us) since last meta-event
   FIELDNAM: Direct Event Time Tag
   LABLAXIS: DE Time Tag
 
@@ -178,12 +247,39 @@ hi_hist_angle:
   VAR_TYPE: support_data
   dtype: uint16
 
+hi_hist_version:
+  <<: *default_ccsds_version
+
+hi_hist_type:
+  <<: *default_ccsds_type
+
+hi_hist_sec_hdr_flg:
+  <<: *default_ccsds_sec_hdr_flg
+
+hi_hist_pkt_apid:
+  <<: *default_ccsds_pkt_apid
+
+hi_hist_seq_flgs:
+  <<: *default_ccsds_seq_flgs
+
+hi_hist_src_seq_ctr:
+  <<: *default_ccsds_src_seq_ctr
+
+hi_hist_pkt_len:
+  <<: *default_ccsds_pkt_len
+
 hi_hist_ccsds_met:
   <<: *hi_ccsds_met
 
 hi_hist_esa_step:
   <<: *hi_esa_step
 
+hi_hist_num_of_spins:
+  <<: *default_uint8
+  CATDESC: Number of spins included in histograms for this packet
+  FIELDNAM: Number of spins
+  LABLAXIS: Num spins
+
 hi_hist_counters:
   <<: *default_uint16
   CATDESC: Angular histogram of {counter_name} type events
@@ -193,6 +289,9 @@ hi_hist_counters:
   LABL_PTR_1: angle_label
   FORMAT: I4
 
+hi_hist_cksum:
+  <<: *default_ccsds_cksum
+
 # ======= L1B DE Section =======
 hi_de_coincidence_type:
   <<: *default_uint8

imap_processing/cdf/config/imap_hit_global_cdf_attrs.yaml

@@ -18,6 +18,20 @@ imap_hit_l1a_hk:
     Logical_source: imap_hit_l1a_hk
     Logical_source_description: IMAP Mission HIT Instrument Level-1A Housekeeping Data.
 
+imap_hit_l1a_count-rates:
+    <<: *instrument_base
+    Data_level: 1A
+    Data_type: L1A_counts>Level-1A Count Rates
+    Logical_source: imap_hit_l1a_count-rates
+    Logical_source_description: IMAP Mission HIT Instrument Level-1A Count Rates Data.
+
+imap_hit_l1a_pulse-height-events:
+    <<: *instrument_base
+    Data_level: 1A
+    Data_type: L1A_pha>Level-1A Pulse Height Events
+    Logical_source: imap_hit_l1a_pulse-height-events
+    Logical_source_description: IMAP Mission HIT Instrument Level-1A Pulse Height Events Data.
+
   # L1b
 imap_hit_l1b_hk:
     <<: *instrument_base

imap_processing/cdf/config/imap_hit_l1a_variable_attrs.yaml

@@ -2,7 +2,7 @@
 # TODO: update label_axis and min/max with values provided by instrument team.
 
 # <=== Defaults ===>
-# Assumed values for all variable attrs unless overwritten
+# Default values for variable attrs unless overwritten
 default_attrs: &default
   DEPEND_0: epoch
   DISPLAY_TYPE: time_series
@@ -14,6 +14,24 @@ default_attrs: &default
   UNITS: ' '
   SCALETYP: linear
 
+default_uint8_attrs: &default_uint8
+  <<: *default
+  FILLVAL: 255
+  FORMAT: I3
+  VALIDMIN: 0
+  VALIDMAX: 255
+  dtype: uint8
+  DEPEND_0: sc_tick
+
+default_uint16_attrs: &default_uint16
+  <<: *default
+  FILLVAL: 65535
+  FORMAT: I5
+  VALIDMIN: 0
+  VALIDMAX: 65535
+  dtype: uint16
+  DEPEND_0: sc_tick
+
 hk_support_attrs: &support_default
   <<: *default
   DISPLAY_TYPE: no_plot
@@ -46,6 +64,50 @@ adc_channels_label:
 # <=== Data Variable Attributes ===>
 #TODO is DEPEND_0 needed for no_plot variables in housekeeping?
 
+# CCSDS header variables
+version:
+  <<: *default_uint8
+  CATDESC: CCSDS packet version number
+  FIELDNAM: CCSDS version
+  VAR_TYPE: support_data
+
+type:
+  <<: *default_uint8
+  CATDESC: CCSDS packet type
+  FIELDNAM: CCSDS type
+  VAR_TYPE: support_data
+
+sec_hdr_flg:
+  <<: *default_uint8
+  CATDESC: CCSDS secondary header flag
+  FIELDNAM: CCSDS secondary header flag
+  VAR_TYPE: support_data
+
+pkt_apid:
+  <<: *default_uint16
+  CATDESC: CCSDS application process ID
+  FIELDNAM: CCSDS APID
+  VAR_TYPE: support_data
+
+seq_flgs:
+  <<: *default_uint8
+  CATDESC: CCSDS sequence flags
+  FIELDNAM: CCSDS sequence flags
+  VAR_TYPE: support_data
+
+src_seq_ctr:
+  <<: *default_uint16
+  CATDESC: CCSDS source sequence counter
+  FIELDNAM: CCSDS sequence counter
+  VAR_TYPE: support_data
+
+pkt_len:
+  <<: *default_uint16
+  CATDESC: CCSDS packet length
+  FIELDNAM: CCSDS packet length
+  VAR_TYPE: support_data
+
+# Housekeeping variables
 fsw_version_a:
   <<: *support_default
   VALIDMAX: 3

imap_processing/cdf/config/imap_idex_global_cdf_attrs.yaml

@@ -16,6 +16,13 @@ imap_idex_l1a_sci:
   Logical_source: imap_idex_l1a_sci
   Logical_source_description: IMAP Mission IDEX Instrument Level-1A Data.
 
+imap_idex_l1b_sci:
+  <<: *instrument_base
+  Data_level: 1B
+  Data_type: L1B_SCI>Level-1B Science Data
+  Logical_source: imap_idex_l1b_sci
+  Logical_source_description: IMAP Mission IDEX Instrument Level-1B Data.
+
 imap_idex_l2_sci:
   <<: *instrument_base
   Data_level: 2