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

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)

imap_processing/tests/cdf/shared/default_global_cdf_attrs_schema.yaml

@@ -1,246 +0,0 @@
-DOI:
-  description: >
-    DOI is a persistent Unique Digital Identifier with the form
-    https://doi.org/<PREFIX>/<SUFFIX> with the <PREFIX> identifying the DOI
-    registration authority and the <SUFFIX> identifying the dataset. The DOI should point to
-    a landing page for additional information about the dataset. DOIs are typically created by
-    the SPASE naming authority or archive.
-  default: null
-  required: false # NOT Required in ISTP Guide (Recommended)
-  validate: true # include in validation
-  overwrite: false
-Data_level:
-  description: >
-    This attribute is used in file name creation and records the level of processsing done
-    on the dataset. For HERMES the following are valid values:
-    - l0>Level 0
-    - l1>Level 1
-    - l2>Level 2
-    - l3>Level 3
-    - l4>Level 4
-    - ql>Quicklook
-  default: null
-  required: true # NOT Required in ISTP Guide (Derived)
-  validate: false
-  overwrite: true
-Data_product_descriptor:
-  description: >
-    This is an optional field that may not be needed for all products. Where it is used, identifier
-    should be short (e.q. 3-8 characters) descriptors that are helpful to end- users. If a
-    descriptor contains multiple components, underscores are used to separate those components.
-  default: null
-  required: false # NOT Required in ISTP Guide (Derived)
-  validate: false
-  overwrite: true
-Data_type:
-  description: >
-    This attribute is used by CDF file writing software to create a filename. It is a
-    combination of the following filename components: mode, data level, and optional data
-    product descriptor.
-  default: null
-  required: false # NOT Required in ISTP Guide (Derived)
-  validate: false
-  overwrite: true
-Data_version:
-  description: >
-    This attribute identifies the version of a particular CDF data file.
-  default: null
-  required: true
-  validate: true
-  overwrite: false
-Descriptor:
-  description: >
-    This attribute identifies the name of the instrument or sensor that collected the data. Both
-    a long name and a short name are given. For any data file, only a single value is allowed.
-    For HERMES, the following are valid values:
-    - EEA>Electron Electrostatic Analyzer
-    - MERIT>Miniaturized Electron pRoton Telescope
-    - NEMISIS> Noise Eliminating Magnetometer In a Small Integrated System
-    - SPAN-I>Solar Probe Analyzer for Ions
-  default: null
-  required: true
-  validate: true
-  overwrite: false
-Discipline:
-  description: >
-    This attribute describes both the science discipline and sub discipline. For HERMES,
-    this value should always be "Space Physics>Magnetospheric Science."
-  default: Space Physics>Magnetospheric Science
-  required: true
-  validate: true
-  overwrite: false
-File_naming_convention:
-  description: >
-    If File_naming_convention was not set, it uses default setting:
-      source_datatype_descriptor_yyyyMMdd
-  default: source_datatype_descriptor_yyyyMMdd
-  required: false
-  validate: false
-  overwrite: true
-Generation_date:
-  description: >
-    Date stamps the creation of the file using the syntax yyyymmdd, e.g., "
-  default: null
-  required: false # NOT Required in ISTP Guide (Recommended)
-  validate: true
-  overwrite: true
-HTTP_LINK:
-  description: >
-    The 'HTTP_LINK', 'LINK_TEXT', and 'LINK_TITLE' attributes store the URL with a
-    description of this dataset at the HERMES SDC. The use of HTTP_LINK attribute requires
-    the existence and equal number of corresponding LINK_TEXT and LINK_TITLE attributes.
-    If text is not needed for these attributes, use an empty string "".
-  default: null
-  required: false # NOT Required in ISTP Guide (Recommended)
-  validate: true
-  overwrite: false
-Instrument_mode:
-  description: >
-    TBS
-  default: null
-  required: false # NOT Required in ISTP Guide (Derived)
-  validate: false
-  overwrite: false
-Instrument_type:
-  description: >
-    This attribute is used to facilitate making choices of instrument type. More than one entry
-    is allowed. Acceptable values for HERMES include:
-    - Magnetic Fields (space)
-    - Particles (space)
-    - Plasma and Solar Wind
-    - Ephemeris -> Ephemeris/Attitude/Ancillary
-  default: null
-  required: true
-  validate: true
-  overwrite: false
-LINK_TEXT:
-  description: >
-    The 'HTTP_LINK', 'LINK_TEXT', and 'LINK_TITLE' attributes store the URL with a
-    description of this dataset at the HERMES SDC. The use of HTTP_LINK attribute requires
-    the existence and equal number of corresponding LINK_TEXT and LINK_TITLE attributes.
-    If text is not needed for these attributes, use an empty string "".
-  default: null
-  required: false # NOT Required in ISTP Guide (Recommended)
-  validate: true
-  overwrite: false
-LINK_TITLE:
-  description: >
-    The 'HTTP_LINK', 'LINK_TEXT', and 'LINK_TITLE' attributes store the URL with a
-    description of this dataset at the HERMES SDC. The use of HTTP_LINK attribute requires
-    the existence and equal number of corresponding LINK_TEXT and LINK_TITLE attributes.
-    If text is not needed for these attributes, use an empty string "".
-  default: null
-  required: false # NOT Required in ISTP Guide (Recommended)
-  validate: true
-  overwrite: false
-Logical_file_id:
-  description: >
-    This attribute stores the name of the CDF file but without the
-    file extension (e.g. ".cdf"). This attribute is required to avoid loss of the original source
-    in the case of accidental (or intentional) renaming.
-  default: null
-  required: true
-  validate: true
-  overwrite: true
-Logical_source:
-  description: >
-    This attribute determines the file naming convention in the SKT Editor and is used by
-    CDA Web. It is composed of the following values:
-    - source_name - (e.g. spacecraft identifier)
-    - descriptor - (e.g. instrument identifier - see Section Error! Reference source not
-    found.)
-    - data_type - (e.g. mode, data level, and optional data product descriptor - value
-    come from 'Data_type' attribute)
-  default: null
-  required: true
-  validate: true
-  overwrite: true
-Logical_source_description:
-  description: >
-    This attribute writes out the full words associated with the encrypted Logical_source
-    above, e.g., "Level 1 Dual Electron Spectrometer Survey Data". Users on CDAWeb see
-    this value on their website.
-  default: null
-  required: true
-  validate: true
-  overwrite: true
-MODS:
-  description: >
-    This attribute is an SPDF standard global attribute, which is used to denote the history of
-    modifications made to the CDF data set. The MODS attribute should contain a
-    description of all significant changes to the data set, essentially capturing a log of high-
-    level release notes. This attribute can have as many entries as necessary and should be
-    updated if the Interface Number ("X") of the version number changes.
-  default: null
-  required: false # NOT Required in ISTP Guide (Recommended)
-  validate: true
-  overwrite: false
-Mission_group:
-  description: >
-    This attribute has a single value and is used to facilitate making choices of source through
-    CDAWeb. This value should be "HERMES."
-  default: HERMES
-  required: true
-  validate: true
-  overwrite: false
-PI_affiliation:
-  description: >
-    This attribute value should include the HERMES mission PI affiliation followed by a
-    comma-separated list of any Co-I affiliations that are responsible for this particular
-    dataset. The following are valid HERMES values, of which the abbreviations should be
-    used exclusively within this attribute value, and the full text of the affiliation included in
-    the general 'text' attribute as it is used solely in plot labels.
-    - GSFC - Goddard Space Flight Center
-    - UCB - University of California, Berkeley
-    - SSL - Space Sciences Laboratory, UCB
-    - UM - University of Michigan
-  default: null
-  required: true
-  validate: true
-  overwrite: false
-PI_name:
-  description: >
-    This attribute value should include first initial and last name of the HERMES mission PI
-    followed by a comma-separated list of any Co-Is that are responsible for this particular
-    dataset.
-  default: null
-  required: true
-  validate: true
-  overwrite: false
-Project:
-  description: >
-    This attribute identifies the name of the project and indicates ownership. For HERMES,
-    this value should be "STP>Solar-Terrestrial Physics".
-  default: STP>Solar-Terrestrial Physics
-  required: true
-  validate: true
-  overwrite: false
-Source_name:
-  description: >
-    This attribute identifies the observatory where the data originated. The following are
-    valid values for HERMES:
-    - HERMES>Heliophysics Environmental and Radiation Measurement Experiment Suite
-  default: HERMES>Heliophysics Environmental and Radiation Measurement Experiment Suite
-  required: true
-  validate: true
-  overwrite: false
-Start_time:
-  description: >
-    The start time of the contained data given in YYYYMMDD_hhmmss
-  default: null
-  required: false # NOT Required in ISTP Guide (Derived)
-  validate: false
-  overwrite: true
-TEXT:
-  description: >
-    This attribute is an SPDF standard global attribute, which is a text description of the
-    experiment whose data is included in the CDF. A reference to a journal article(s) or to a
-    World Wide Web page describing the experiment is essential and constitutes the
-    minimum requirement. A written description of the data set is also desirable. This
-    attribute can have as many entries as necessary to contain the desired information.
-    Typically, this attribute is about a paragraph in length and is not shown on CDAWeb.
-    CDAWeb is the web portal for access to SPDF data, available at https://cdaweb.gsfc.nasa.gov.
-  default: null
-  required: true
-  validate: true
-  overwrite: false