Source code for pymepix.processing.datatypes

# This file is part of Pymepix
#
# In all scientific work using Pymepix, please reference it as
#
# A. F. Al-Refaie, M. Johny, J. Correa, D. Pennicard, P. Svihra, A. Nomerotski, S. Trippel, and J. Küpper:
# "PymePix: a python library for SPIDR readout of Timepix3", J. Inst. 14, P10003 (2019)
# https://doi.org/10.1088/1748-0221/14/10/P10003
# https://arxiv.org/abs/1905.07999
#
# Pymepix is free software: you can redistribute it and/or modify it under the terms of the GNU
# General Public License as published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
# even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with this program. If not,
# see <https://www.gnu.org/licenses/>.

"""Defines data that is passed between processing objects"""

from enum import IntEnum



[docs]
class MessageType(IntEnum):
    """Defines the type of message that is being passed into a multiprocessing queue"""

    RawData = 0
    """Raw UDP packets"""
    PixelData = 1
    """Decoded Pixel/Trigger Data"""
    TriggerData = 8
    """Decoded Triggers"""
    EventData = 2
    """Event Data"""
    CentroidData = 3
    """Centroided Data"""
    OpenFileCommand = 4
    """Open File message"""
    CloseFileCommand = 5
    """Close File Message"""