JWeightEvent.hh

Go to the documentation of this file.

#ifndef __JAANET__JWEIGHTEVENT__
#define __JAANET__JWEIGHTEVENT__

#include "km3net-dataformat/offline/Head.hh"
#include "km3net-dataformat/offline/Evt.hh"

#include "JLang/JClonable.hh"

#include "JAAnet/JHead.hh"

/**
 * \author mdejong
 */

namespace JAANET {

  using JLANG::JClonable;

  
  /**
   * Low-level interface for event weighing.
   */
  struct JWeightEvent :
    public JClonable<JWeightEvent>
  {
    /**
     * Virtual destructor.
     */
    virtual ~JWeightEvent()
    {}
    

    /**
     * Configuration.
     *
     * \param  header            header
     */
    virtual void configure(const JHead& header) = 0;


    /**
     * Check whether header is consistent with this event weighter.
     *
     * \param  header            header
     * \return                   true if consistent; else false
     */
    virtual bool check(const JHead& head) const = 0;

    
    /**
     * Get weight of given event.
     *
     * \param  evt               event
     * \return                   weight        [Hz]
     */
    virtual double getWeight(const Evt& evt) const = 0;

    
    /**
     * Get weight of given event.
     *
     * \param  evt               event
     * \param  flux              neutrino flux [m^-2 s^-1 sr^-1 GeV^-1]
     * \return                   weight        [Hz]
     */
    virtual double getWeight(const Evt&   evt,
                             const double flux) const
    {
      return getWeight(evt);
    }
  };
}

#endif