JEvtWeightCorsika.hh

Go to the documentation of this file.

#ifndef __JAANET__JEVTWEIGHTCORSIKA__
#define __JAANET__JEVTWEIGHTCORSIKA__

#include "km3net-dataformat/definitions/weightlist.hh"
#include "km3net-dataformat/definitions/w2list_gseagen.hh"

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

#include "JLang/JException.hh"
#include "JLang/JClonable.hh"

#include "JAAnet/JHead.hh"
#include "JAAnet/JHeadToolkit.hh"
#include "JAAnet/JEvtWeight.hh"
#include "JAAnet/JEvtWeightFactorHelper.hh"
#include "JAAnet/JFlux.hh"


/**
 * \author bjung
 */

namespace JAANET {
  
  using JLANG::JClonable;
  using JLANG::JIndexOutOfRange;
  using JLANG::JNullPointerException;

  
  /**
   * Implementation of event weighting for Corsika data.
   */
  struct JEvtWeightCorsika :
    public JFluxHelper,
    public JClonable<JEvtWeight, JEvtWeightCorsika>
  {
    /**
     * Default Constructor.
     */
    JEvtWeightCorsika() :
      JFluxHelper()
    {}


    /** 
     * Constructor.
     *
     * \param  header            header
     */    
    JEvtWeightCorsika(const JHead& header) :
      JFluxHelper()
    {
      configure(header);
    }


    /** 
     * Constructor.
     *
     * \param  header            header
     * \param  flux              flux
     */
    JEvtWeightCorsika(const JHead& header,
                      const JFlux& flux)
    {
      configure(header);
      JFluxHelper::configure(flux);
    }


    /**
     * Copy constructor.
     *
     * \param  object           original object
     */
    JEvtWeightCorsika(const JEvtWeightCorsika& object)
    {
      this->norm = object.norm;

      if (object.is_valid()) {
        JFluxHelper::configure(*(object.get()));
      }
    }
    
    
    /**
     * Weight configuration.
     *
     * \param  header            header
     */
    void configure(const JHead& header) override
    {
      const double N = header.genvol.numberOfEvents;
      
      if (check(header) && N > 0.0) {
        
        norm = 1.0 / N;
        
      } else {

        THROW(JValueOutOfRange, "JEvtWeightCorsika::configure(): Provided header is inconsistent with Corsika.");
      }
    }


    /**
     * Check whether header is consistent with this event weighter.
     *
     * \param  header            header
     * \return                   true if consistent; else false
     */
    bool check(const JHead& header) const override
    {
      return is_gseagen(header);
    }

    
    /**
     * Get weight of given event.
     *
     * \param  evt               event
     * \return                   weight        [Hz]
     */
    double getWeight(const Evt& evt) const override
    {
      const double& Nretries = evt.w2list[W2LIST_GSEAGEN_N_RETRIES];
      
      if (is_valid() && evt.w.size() > WEIGHTLIST_DIFFERENTIAL_EVENT_RATE) {
          
        return evt.w[WEIGHTLIST_DIFFERENTIAL_EVENT_RATE] * getFactor(evt) * getNormalisation(evt) / (1 + Nretries);
        
      } else if (evt.w.size() > WEIGHTLIST_RESCALED_EVENT_RATE) {
        
        return evt.w[WEIGHTLIST_RESCALED_EVENT_RATE];

      } else if (evt.w.size() > WEIGHTLIST_EVENT_RATE) {

        return evt.w[WEIGHTLIST_EVENT_RATE] * getNormalisation(evt) / (1 + Nretries);
        
      } else {

        if (!is_valid()) {
          THROW(JNullPointerException, "JEvtWeightCorsika::getWeight(): Unspecified flux function.");
        } else {
          THROW(JIndexOutOfRange,      "JEvtWeightCorsika::getWeight(): Empty " << (evt.w.size() < 3 ? "w2-" : "w3-") << "weight.");
        }
      }
    }
  };
}

#endif