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

imap_processing/hit/l0/data_classes/housekeeping.py

@@ -1,240 +0,0 @@
-"""L1A HIT Housekeeping data class."""
-
-from dataclasses import dataclass
-
-import numpy as np
-import space_packet_parser
-
-from imap_processing.ccsds.ccsds_data import CcsdsData
-from imap_processing.hit.l0.utils.hit_base import HITBase
-
-
-@dataclass
-class Housekeeping(HITBase):
-    """
-    L1A HIT Housekeeping data.
-
-    The HIT Housekeeping data class handles the decommutation
-    and parsing of L0 to L1A data.
-
-    Parameters
-    ----------
-    packet : dict
-        Dictionary of packet.
-    software_version : str
-        Version of software.
-    packet_file_name : str
-        Name of packet file.
-
-    Attributes
-    ----------
-    SHCOARSE : int
-        Spacecraft time.
-    MODE : int
-        Mode (0=boot, 1=maint, 2=stdby, 3=science)
-    FSW_VERSION_A : int
-        FSW version number (A.B.C bits)
-    FSW_VERSION_B : int
-        FSW version number (A.B.C bits)
-    FSW_VERSION_C : int
-        FSW version number (A.B.C bits)
-    NUM_GOOD_CMDS : int
-        Number of good commands
-    LAST_GOOD_CMD : int
-        Last good command
-    LAST_GOOD_SEQ_NUM : int
-        Last good sequence number
-    NUM_BAD_CMDS : int
-        Number of bad commands
-    LAST_BAD_CMD : int
-        Last bad command
-    LAST_BAD_SEQ_NUM : int
-        Last bad sequence number
-    FEE_RUNNING : int
-        FEE running (1) or reset (0)
-    MRAM_DISABLED : int
-        MRAM disabled (1) or enabled (0)
-    ENABLE_50KHZ : int
-        50kHz enabled (1) or disabled (0)
-    ENABLE_HVPS : int
-        HVPS enabled (1) or disabled (0)
-    TABLE_STATUS : int
-        Table status  OK (1) or error (0)
-    HEATER_CONTROL : int
-        Heater control (0=none, 1=pri, 2=sec)
-    ADC_MODE : int
-        ADC mode (0=quiet, 1=normal, 2=adcstim, 3=adcThreshold?)
-    DYN_THRESH_LVL : int
-        Dynamic threshold level (0-3)
-    NUM_EVNT_LAST_HK : int
-        Number of events since last HK update
-    NUM_ERRORS : int
-        Number of errors
-    LAST_ERROR_NUM : int
-        Last error number
-    CODE_CHECKSUM : int
-        Code checksum
-    SPIN_PERIOD_SHORT : int
-        Spin period at t=0
-    SPIN_PERIOD_LONG : int
-        Spin period at t=0
-    LEAK_I_RAW : str
-        Raw binary for Leakage current [V]
-    LEAK_I : np.ndarray
-        Leakage currents [V] formatted as (64, 1) array
-    PHASIC_STAT : int
-        PHASIC status
-    ACTIVE_HEATER : int
-        Active heater
-    HEATER_ON : int
-        Heater on/off
-    TEST_PULSER_ON : int
-        Test pulser on/off
-    DAC0_ENABLE : int
-        DAC_0 enable
-    DAC1_ENABLE : int
-        DAC_1 enable
-    PREAMP_L234A : int
-        Preamp L234A
-    PREAMP_L1A : int
-        Preamp L1A
-    PREAMP_L1B : int
-        Preamp L1B
-    PREAMP_L234B : int
-        Preamp L234B
-    TEMP0 : int
-        FEE LDO Regulator
-    TEMP1 : int
-        Primary Heater
-    TEMP2 : int
-        FEE FPGA
-    TEMP3 : int
-        Secondary Heater
-    ANALOG_TEMP : int
-        Chassis temp
-    HVPS_TEMP : int
-        Board temp
-    IDPU_TEMP : int
-        LDO Temp
-    LVPS_TEMP : int
-        Board temp
-    EBOX_3D4VD : int
-        3.4VD Ebox (digital)
-    EBOX_5D1VD : int
-        5.1VD Ebox (digital)
-    EBOX_P12VA : int
-        +12VA Ebox (analog)
-    EBOX_M12VA : int
-        -12VA Ebox (analog)
-    EBOX_P5D7VA : int
-        +5.7VA Ebox (analog)
-    EBOX_M5D7VA : int
-        -5.7VA Ebox (analog)
-    REF_P5V : int
-        +5Vref
-    L1AB_BIAS : int
-        L1A/B Bias
-    L2AB_BIAS : int
-        L2A/B Bias
-    L34A_BIAS : int
-        L3/4A Bias
-    L34B_BIAS : int
-        L3/4B Bias
-    EBOX_P2D0VD : int
-        +2.0VD Ebox (digital)
-
-    Methods
-    -------
-    __init__(packet, software_vesion, packet_file_name):
-        Uses the CCSDS packet, version of the software, and
-        the name of the packet file to parse and store information about
-        the Housekeeping packet data.
-    _parse_leak():
-        Parse each current leakage field and put into an array.
-    """
-
-    SHCOARSE: int
-    MODE: int
-    FSW_VERSION_A: int
-    FSW_VERSION_B: int
-    FSW_VERSION_C: int
-    NUM_GOOD_CMDS: int
-    LAST_GOOD_CMD: int
-    LAST_GOOD_SEQ_NUM: int
-    NUM_BAD_CMDS: int
-    LAST_BAD_CMD: int
-    LAST_BAD_SEQ_NUM: int
-    FEE_RUNNING: int
-    MRAM_DISABLED: int
-    ENABLE_50KHZ: int
-    ENABLE_HVPS: int
-    TABLE_STATUS: int
-    HEATER_CONTROL: int
-    ADC_MODE: int
-    DYN_THRESH_LVL: int
-    NUM_EVNT_LAST_HK: int
-    NUM_ERRORS: int
-    LAST_ERROR_NUM: int
-    CODE_CHECKSUM: int
-    SPIN_PERIOD_SHORT: int
-    SPIN_PERIOD_LONG: int
-    LEAK_I_RAW: str
-    LEAK_I: np.ndarray
-    PHASIC_STAT: int
-    ACTIVE_HEATER: int
-    HEATER_ON: int
-    TEST_PULSER_ON: int
-    DAC0_ENABLE: int
-    DAC1_ENABLE: int
-    PREAMP_L234A: int
-    PREAMP_L1A: int
-    PREAMP_L1B: int
-    PREAMP_L234B: int
-    TEMP0: int
-    TEMP1: int
-    TEMP2: int
-    TEMP3: int
-    ANALOG_TEMP: int
-    HVPS_TEMP: int
-    IDPU_TEMP: int
-    LVPS_TEMP: int
-    EBOX_3D4VD: int
-    EBOX_5D1VD: int
-    EBOX_P12VA: int
-    EBOX_M12VA: int
-    EBOX_P5D7VA: int
-    EBOX_M5D7VA: int
-    REF_P5V: int
-    L1AB_BIAS: int
-    L2AB_BIAS: int
-    L34A_BIAS: int
-    L34B_BIAS: int
-    EBOX_P2D0VD: int
-
-    def __init__(
-        self,
-        packet: space_packet_parser.packets.CCSDSPacket,
-        software_version: str,
-        packet_file_name: str,
-    ):
-        """Housekeeping Data class initialization method."""
-        super().__init__(software_version, packet_file_name, CcsdsData(packet.header))
-        self.parse_data(packet)
-        self._parse_leak()
-
-    def _parse_leak(self) -> None:
-        """Parse each current leakage field and put into an array."""
-        # Each Leak field is 10 bits long
-        leak_bit_length = 10
-        # There are 64 leak fields
-        num_leak_fields = 64
-        self.LEAK_I = np.empty(num_leak_fields, dtype=np.uint16)
-        # The leak fields appear in the packet in ascending order, so to append
-        # the leak fields in the correct order, the binary will be parsed
-        # from right to left.
-        for i, leak_idx in enumerate(
-            range(leak_bit_length * num_leak_fields, 0, -leak_bit_length)
-        ):
-            self.LEAK_I[i] = int(
-                self.LEAK_I_RAW[leak_idx - leak_bit_length : leak_idx], 2
-            )

imap_processing/hit/l0/data_classes/science_packet.py

@@ -1,259 +0,0 @@
-"""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

imap_processing/hit/l0/utils/hit_base.py

@@ -1,57 +0,0 @@
-"""General HIT L0 data class used for parsing data and setting attributes."""
-
-from dataclasses import dataclass, fields
-
-import space_packet_parser
-
-from imap_processing.ccsds.ccsds_data import CcsdsData
-
-
-@dataclass
-class HITBase:
-    """
-    Data structure for common values across HIT.
-
-    Attributes
-    ----------
-    ground_sw_version : str
-        Ground software version.
-    packet_file_name : str
-        File name of the source packet.
-    ccsds_header : CcsdsData
-        CCSDS header data.
-
-    Methods
-    -------
-    parse_data(packet):
-        Parse the packet and assign to class variable using the xtce defined named.
-    """
-
-    ground_sw_version: str
-    packet_file_name: str
-    ccsds_header: CcsdsData
-
-    def parse_data(self, packet: space_packet_parser.packets.CCSDSPacket) -> None:
-        """
-        Parse Lo L0 packet data.
-
-        Parameters
-        ----------
-        packet : space_packet_parser.packets.CCSDSPacket
-            A single Lo L0 packet from space packet parser.
-        """
-        attributes = [field.name for field in fields(self)]
-
-        # For each item in packet, assign it to the matching attribute in the class.
-        for key, item in packet.user_data.items():
-            value = (
-                item.derived_value if item.derived_value is not None else item.raw_value
-            )
-            if "SPARE" in key:
-                continue
-            if key not in attributes:
-                raise KeyError(
-                    f"Did not find matching attribute in {self.__class__} data class"
-                    f"for {key}"
-                )
-            setattr(self, key, value)