JFrame.hh

Go to the documentation of this file.

#ifndef __JTRIGGER__JFRAME__
#define __JTRIGGER__JFRAME__

#include <vector>

#include "km3net-dataformat/online/JDAQHit.hh"
#include "km3net-dataformat/online/JDAQClock.hh"
#include "JTrigger/JMatch.hh"
#include "JTrigger/JPMTHeader.hh"
#include "JTrigger/JHitToolkit.hh"
#include "JTrigger/JCalibration.hh"
#include "JLang/JSTDToolkit.hh"


/**
 * \author mdejong
 */

namespace JTRIGGER {}
namespace JPP { using namespace JTRIGGER; }

namespace JTRIGGER {

  using KM3NETDAQ::JDAQHit;


  /**
   * Data frame for calibrated hits of one PMT.
   *
   * Note that the calibration is applied on the fly in the member method JFrame::push_back.
   */
  template<class JElement_t, class JAllocator_t = std::allocator<JElement_t> >
  class JFrame :
    public JPMTHeader,
    public JCalibration,
    public std::vector<JElement_t, JAllocator_t>,
    public JHitToolkit<JElement_t>
  {
  public:

    typedef std::vector<JElement_t, JAllocator_t>                        container_type;
    typedef JElement_t                                                   value_type;
    typedef JMatch<value_type>                                           match_type;

    typedef typename container_type::iterator                            iterator;
    typedef typename container_type::const_iterator                      const_iterator;
    typedef typename container_type::reverse_iterator                    reverse_iterator;
    typedef typename container_type::const_reverse_iterator              const_reverse_iterator;

    using container_type::push_back;
    using JHitToolkit<JElement_t>::join;


    /**
     * Default constructor.
     */
    JFrame() :
      JPMTHeader  (),
      JCalibration(),
      std::vector<JElement_t, JAllocator_t>(),
      JHitToolkit<JElement_t>()
    {}


    /**
     * Constructor.
     *
     * \param  chronometer    DAQ chronometer
     * \param  id             PMT identifier
     * \param  axis           PMT axis
     * \param  calibration    calibration
     */
    JFrame(const JDAQChronometer&   chronometer,
           const JDAQPMTIdentifier& id,
           const JAxis3D&           axis,
           const JCalibration&      calibration) :
      JPMTHeader  (chronometer, id, axis),
      JCalibration(calibration),
      std::vector<JElement_t, JAllocator_t>(),
      JHitToolkit<JElement_t>()
    {}


    /**
     * Copy constructor.
     *
     * \param  input          frame
     */
    JFrame(const JFrame<JElement_t, JAllocator_t>& input) :
      JPMTHeader  (input.getPMTHeader()),
      JCalibration(input.getCalibration()),
      std::vector<JElement_t, JAllocator_t>(input.begin(), input.end()),
      JHitToolkit<JElement_t>()
    {
      if (input.hasEndMarker()) {
        this->putEndMarker();
      }
    }


    /**
     * Append DAQ hit.
     *
     * The time calibration is applied before the hit is appended.
     *
     * \param  hit            DAQ hit
     */
    void push_back(const JDAQHit& hit)
    {
      container_type::push_back(this->getHit(hit, this->getCalibration()));
    }


    /**
     * Check presence of end marker.
     *
     * \return                true if end marker present; else false
     */
    bool hasEndMarker() const
    {
      return (this->capacity() > this->size() && this->getT(*(this->end())) == this->getT(this->getEndMarker()));
    }


    /**
     * Append end marker to data.
     *
     * Note that the end marker is put within the capacity of the container whilst its size is maintained.
     */
    void putEndMarker() 
    {
      JPP::putEndMarker(*this, this->getEndMarker());
    }


    /**
     * Reset.
     *
     * Clear container and put end marker.
     */
    void reset()
    {
      this->clear();
      this->putEndMarker();
    }


    /**
     * Apply high-rate veto.
     *
     * If vetoed, the container is cleared and an end marker is put.
     *
     * \param  rate_Hz        high-rate veto [Hz] 
     */
    void applyHighRateVeto(const double rate_Hz)
    {
      using KM3NETDAQ::getFrameTime;

      if (this->size() * 1.0e9 / getFrameTime() > rate_Hz) {
        this->reset();
      }
    }


    /**
     * Join consecutive hits when matched according given criterion.
     *
     * \param  match          match criterion
     */
    void join(const match_type& match)
    {
      iterator out = this->begin();

      for (const_iterator p = this->begin(); p != this->end(); ) {

        *out = *p;

        while (++p != this->end() && match(*out,*p)) {
          *out = join(*out,*p);
        }

        ++out;
      }

      if (out != this->end()) {
        this->erase(out, this->end());
        this->putEndMarker();
      }
    }


    /**
     * Filter-out consecutive hits when matched according given criterion.
     *
     * Note that all hits which are matched are removed.
     *
     * \param  match          match criterion
     */
    void filter(const match_type& match)
    {
      iterator out = this->begin();

      for (const_iterator p = this->begin(); p != this->end(); ) {

        const_iterator q = p; 

        for (const_iterator i = p; ++q != this->end() && match(*i,*q); ++i) {}

        if (std::distance(p,q) == 1) {
          *out = *p;
          ++out;
        }

        p = q;
      }

      if (out != this->end()) {
        this->erase(out, this->end());
        this->putEndMarker();
      }
    }
  };
}

#endif