JExperiment.hh

Go to the documentation of this file.

#ifndef __JASTRONOMY__JEXPERIMENT__
#define __JASTRONOMY__JEXPERIMENT__
 
#include "TObject.h"
#include "TH1.h"
#include "TH2.h"
#include "TH3.h"
#include "TAxis.h"
 
 
/**
 * \file
 *
 * Experiment.
 * \author mdejong
 */
namespace JASTRONOMY {}
namespace JPP { using namespace JASTRONOMY; }
 
namespace JASTRONOMY {
 
  /**
   * Auxiliary base class for experiment.
   */
  struct JExperiment
  {
    /**
     * Get minimal signa-to-noise ratio.
     *
     * \return            signa-to-noise ratio.
     */
    static double getSNR()
    {
      return get_snr();
    }
  
 
    /**
     * Set minimal signa-to-noise ratio.
     *
     * \param  value      signa-to-noise ratio.
     */
    static void setSNR(const double value)
    {
      get_snr() = value;
    }
  
 
    /**
     * Check validity of signal and background.
     *
     * \param  s          signal
     * \param  b          background
     * \return            true if signal and backgroud are valid; else false
     */
    static bool check(const double s, const double b)
    {
      return (s > 0.0 && b > 0.0 && s/b >= getSNR());
    }
 
 
    /**
     * Check histogram bins.
     *
     * \param  ha             histogram axis
     * \param  hb             histogram axis
     * \return                true if same binning; else false
     */
    static bool check(const TAxis* ha, const TAxis* hb)
    {
      return (ha->GetNbins() == hb->GetNbins()       &&
              ha->GetXmin()  == hb->GetXmin()        &&
              ha->GetXmax()  == hb->GetXmax());
    }
 
    /**
     * Check histogram bins.
     *
     * \param  ha             histogram
     * \param  hb             histogram
     * \return                true if same binning; else false
     */
    static bool check(const TH1& ha, const TH1& hb)
    {
      return check(ha.GetXaxis(), hb.GetXaxis());
    }
 
 
    /**
     * Check histogram bins.
     *
     * \param  ha             histogram
     * \param  hb             histogram
     * \return                true if same binning; else false
     */
    static bool check(const TH2& ha, const TH2& hb)
    {
      return (check(ha.GetXaxis(), hb.GetXaxis())    &&
              check(ha.GetYaxis(), hb.GetYaxis()));
    }
 
 
    /**
     * Check histogram bins.
     *
     * \param  ha             histogram
     * \param  hb             histogram
     * \return                true if same binning; else false
     */
    static bool check(const TH3& ha, const TH3& hb)
    {
      return (check(ha.GetXaxis(), hb.GetXaxis())    &&
              check(ha.GetYaxis(), hb.GetYaxis())    &&
              check(ha.GetZaxis(), hb.GetZaxis()));
    }
 
  private:
    /**
     * Get minimal signa-to-noise ratio.
     *
     * \return            signa-to-noise ratio.
     */
    static double& get_snr()
    {
      static double value = 0.0;
 
      return value;
    }
  };
}
 
#endif