JPMTRunByRunSimulator.hh

Go to the documentation of this file.

#ifndef __JDETECTOR__JPMTRUNBYRUNSIMULATOR__
#define __JDETECTOR__JPMTRUNBYRUNSIMULATOR__

#include "JDetector/JPMTDefaultSimulator.hh"
#include "JDetector/JPMTRateRange.hh"
#include "JDetector/JPMTParametersMap.hh"
#include "JDetector/JDetector.hh"
#include "JTrigger/JSummaryRouter.hh"
#include "JDAQ/JDAQSummaryFrame.hh"


/**
 * \author mdejong
 */

namespace JDETECTOR {}
namespace JPP { using namespace JDETECTOR; }

namespace JDETECTOR {

  using JTRIGGER::JSummaryRouter;
  

  /**
   * PMT simulation based on run-by-run information.
   *
   * This class overwrites the method JPMTDefaultSimulator::getPMTstatus.
   * The actual PMT status is determined from summary data.
   * The frequency range corresponds to the acceptable range of singles rates.
   * Outside this range, the PMT is considered default.
   */
  class JPMTRunByRunSimulator :
    public JPMTDefaultSimulator
  {
  public:
    /**
     * Constructor.
     *
     * \param  router         summary router
     * \param  parameters     PMT parameters
     * \param  detector       detector
     * \param  range_Hz       PMT rate range [Hz]
     */
    JPMTRunByRunSimulator(const JSummaryRouter&    router,
                          const JPMTParametersMap& parameters, 
                          const JDetector&         detector,
                          const JPMTRateRange&     range_Hz) :
      JPMTDefaultSimulator(parameters, detector),
      summary_router(router),
      range(range_Hz)
    {}


    /**
     * Get PMT rate range.
     *
     * \return                PMT rate range [Hz]
     */
    const JPMTRateRange& getPMTRateRange() const
    {
      return range;
    }


    /**
     * Set PMT rate range.
     *
     * \param  range_Hz       PMT rate range [Hz]
     */
    void setPMTRateRange(const JPMTRateRange& range_Hz)
    {
      this->range = range_Hz;
    }

    
    /**
     * Get PMT status.
     *
     * If PMT status is false, the method JPMTDefaultSimulatorInterface::processHits does not produce any hits.
     *
     * \param  id             PMT identifier
     * \return                PMT status
     */
    virtual bool getPMTstatus(const JPMTIdentifier& id) const
    {
      if (summary_router.hasSummaryFrame(id.getModuleID())) {

        const KM3NETDAQ::JDAQSummaryFrame& frame = summary_router.getSummaryFrame(id.getModuleID());
        
        return (!frame.testHighRateVeto(id.getPMTAddress()) &&
                !frame.testFIFOStatus  (id.getPMTAddress()) &&
                range(frame.getRate(id.getPMTAddress())));
      }

      return false;
    }


  protected:
    const JSummaryRouter& summary_router;
    JPMTRateRange         range;           //!< [Hz]
  };
}

#endif