JFluxFunction.hh

Go to the documentation of this file.

#ifndef __JAANET__JFLUXFUNCTION__
#define __JAANET__JFLUXFUNCTION__

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

#include "JLang/JClonable.hh"

#include "JAAnet/JFlux.hh"

/**
 * \author bjung
 */

namespace JAANET {
  
  using JLANG::JClonable;
  
  
  /**
   * Implementation of flux function.\n
   * Note that the template argument refers to a function of which the copy constuctor needs to be defined.
   */
  template<class JFunction_t>
  struct JFluxFunction :
    public JClonable<JFlux, JFluxFunction<JFunction_t> >
  {
    /** 
     * Constructor.
     *
     * \param  function          flux function
     */
    JFluxFunction(const JFunction_t& function) :
      function(function)
    {}
    
    
    /**
     * Get flux for given event.
     *
     * \param  evt               event
     * \return                   flux        [GeV * m^-2 * sr^-1 * s^-1]
     */
    double getFlux(const Evt& evt) const override
    {
      return function(evt);
    }
    
  private:
    
    JFunction_t function;
  };
  

  /**
   * Type definition of pointer to flux function.
   */
  typedef double (*pFlux)(const Evt&);
  

  /**
   * Implementation of C-style flux function.\n
   */
  template<>
  struct JFluxFunction<pFlux> :
    public JClonable<JFlux, JFluxFunction<pFlux> >
  {
    /** 
     * Constructor.
     *
     * \param  function          flux function
     */
    JFluxFunction(pFlux function) :
      function(function)
    {}
    
    
    /**
     * Get flux for given event.
     *
     * \param  evt               event
     * \return                   flux        [GeV * m^-2 * sr^-1 * s^-1]
     */
    double getFlux(const Evt& evt) const override
    {
      return (*function)(evt);
    }
    
  private:    

    pFlux function;
  };


  /**
   * Auxiliary method for creating flux function.
   *
   * \param  function             function
   * \return                      flux function
   */
  template<class JFunction_t>
  inline JFluxFunction<JFunction_t> make_fluxFunction(const JFunction_t& function) {
    return JFluxFunction<JFunction_t>(function);
  }


  /**
   * Auxiliary method for creating flux function.
   *
   * \param  function             function
   * \return                      flux function
   */
  inline JFluxFunction<pFlux> make_fluxFunction(pFlux function) {
    return JFluxFunction<pFlux>(function);
  }
}

#endif