TrgCoincidences.py

#!/usr/local/bin/python
#
#                               Copyright 2004
#                                     by
#                        The Board of Trustees of the
#                     Leland Stanford Junior University.
#                            All rights reserved.
#

__facility__ = "Online"
__abstract__ = "GLAST LAT Trigger Coincidence Interface: Coincidence definition classes"
__author__   = "Jim Panetta <panetta@slac.stanford.edu> SLAC - GLAST I&T"
__date__     = "2/14/04"
__version__  = "$Revision: 2.1 $"
__release__  = "$Name: R04-12-00 $"
__credits__  = "SLAC"

import LATTE.copyright_SLAC


from TrgObject import TrgObject


"""TrgCoincidences: Interface for Trigger Coincidence classes"""

class TrgRois(TrgObject):
  """\brief Trigger ROI (Region of Interest) list class definition
  """
  def __init__(self):
    """\brief TrgRois constructor
    """
    pass
  
  def roi(self, regionNumber):
    """\brief roi 'pure virtual' method
    Reference into the list of ROIs
    \param regionNumber  A region number
    \return A TrgRoi objece
    """
    raise NotImplementedError
    pass
  
  
class TrgRoi(TrgObject):
  """\brief Trigger ROI (Region of Interest) class definition
  """
  def __init__(self):
    """\brief TrgRoi constructor
    """
    pass

  def tile(self, tileNumber):
    """\brief tile 'pure virtual' method
    
    \param tileNumber  A tile number
    \return A boolean
    """
    raise NotImplementedError
    pass


class TrgCoincidences(TrgRois):
  """\brief Trigger Coincidences class definition
  """
  def __init__(self):
    """\brief TrgCoincidences constructor
    """
    TrgRois.__init__(self)

  def coincidence(self, coincidenceNumber):
    """\brief coincidence 'pure virtual' method
    Reference into the list of coincidences.
    \param coincidenceNumber  A coincidence number
    \return A TrgCoincidence object
    """
    raise NotImplementedError
    pass


class TrgCoincidence(TrgObject):
  """\brief Trigger Coincidence class definition
  This class defines the set of tiles which will constitute any one coincidence.
  """
  def __init__(self):
    """\brief TrgCoincidence constructor
    """
    pass

  def inCoincidence(self, tileNumber):
    """\brief InCoincidence 'pure virtual' method
    To be satisfied by the user.
    \param tileNumber  A tile number [0..107]
    \return An integer
    """
    raise NotImplementedError
    pass

---