JFluxHelper.hh

Go to the documentation of this file.

#ifndef __JAANET__JFLUXHELPER__
#define __JAANET__JFLUXHELPER__

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

#include "JLang/JSharedPointer.hh"

#include "JAAnet/JFlux.hh"

/**
 * \author bjung
 */

namespace JAANET {
  
  using JLANG::JSharedPointer;
  using JLANG::JNullPointerException;


  /**
   * Helper class for event weighing.
   */
  struct JFluxHelper :
    public JSharedPointer<JFlux>
  {
    using JSharedPointer<JFlux>::is_valid;
    
    /**
     * Default constructor.
     */
    JFluxHelper()
    {}
    
    
    /**
     * Constructor.
     *
     * \param  function          flux function
     */
    JFluxHelper(const JFlux& function)
    {
      configure(function);
    }
    
    
    /**
     * Flux configuration.
     *
     * \param  function          flux function
     */
    void configure(const JFlux& function)
    {
      reset(function.clone());
    }
    
    
    /**
     * Get flux of given event.
     *
     * \param  evt               event
     * \return                   flux         [GeV * m^-2 * sr^-1 * s^-1]
     */
    double getFlux(const Evt& evt) const
    {
      if (is_valid()) {
        return get()->getFlux(evt);
      } else {
        THROW(JNullPointerException, "JFluxHelper::getFlux(): Unspecified flux function.");
      }
    }
  };
}

#endif