JEvtWeightFactorFunction.hh

Go to the documentation of this file.

#ifndef __JAANET__JEVTWEIGHTFACTORFUNCTION__
#define __JAANET__JEVTWEIGHTFACTORFUNCTION__

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

#include "JLang/JClonable.hh"

#include "JAAnet/JEvtWeightFactor.hh"

/**
 * \author bjung
 */

namespace JAANET {
  
  using JLANG::JClonable;
  
  
  /**
   * Implementation of event-weight factor interface.\n
   * Note that the template argument refers to a function of which the copy constuctor needs to be defined.
   */
  template<class JFunction_t>
  struct JEvtWeightFactorFunction :
    public JClonable<JEvtWeightFactor, JEvtWeightFactorFunction<JFunction_t> >
  {
    /** 
     * Constructor.
     *
     * \param  function          function for event-weight factor
     */
    JEvtWeightFactorFunction(const JFunction_t& function) :
      function(function)
    {}

    
    /**
     * Get weight-factor for given event.
     *
     * \param  evt               event
     * \return                   event-weight factor
     */
    double getFactor(const Evt& evt) const override
    {
      return function(evt);
    }
    
  private:
    
    JFunction_t function;
  };
  

  /**
   * Type definition of pointer to event-weight factor.
   */
  typedef double (*pEvtWeightFactor)(const Evt&);

  
  /**
   * Implementation of C-style event-weight factor.
   */
  template<>
  struct JEvtWeightFactorFunction<pEvtWeightFactor> :
    public JClonable<JEvtWeightFactor, JEvtWeightFactorFunction<pEvtWeightFactor> >
  {
    /** 
     * Constructor.
     *
     * \param  function          event-weight factor
     */
    JEvtWeightFactorFunction(pEvtWeightFactor function) :
      function(function)
    {}
    
    
    /**
     * Get weight-factor for given event.
     *
     * \param  evt               event
     * \return                   event-weight factor
     */
    double getFactor(const Evt& evt) const override
    {
      return (*function)(evt);
    }
    
  private:    

    pEvtWeightFactor function;
  };


  /**
   * Auxiliary method for creating an interface to an event-weight factor.
   *
   * \param  function             function object
   * \return                      event-weight factor interface
   */
  template<class JFunction_t>
  inline JEvtWeightFactorFunction<JFunction_t> make_weightFactor(const JFunction_t& function) {
    return JEvtWeightFactorFunction<JFunction_t>(function);
  }  


  /**
   * Auxiliary method for creating an interface to an event-weight factor.
   *
   * \param  function             function pointer
   * \return                      event-weight factor interface
   */
  inline JEvtWeightFactorFunction<pEvtWeightFactor> make_weightFactor(pEvtWeightFactor function) {
    return JEvtWeightFactorFunction<pEvtWeightFactor>(function);
  }
}

#endif