JTestSignificance_2D.hh

Go to the documentation of this file.

#ifndef __JTESTSIGNIFICANCE_2D__
#define __JTESTSIGNIFICANCE_2D__

#include <istream>
#include <ostream>
#include "JCompareHistograms/JTest_t.hh"
#include "JCompareHistograms/JTestSignificance_t.hh"

/**
 * \author bofearraigh
 * \author rgruiz
 */

/**
 * Significance test applied to 2D histograms
 */
class JTestSignificance_2D: 
  public JTest_t , 
  public JTestSignificance_t
{ 
public:  

  /**
   * Default constructor.
   */
  JTestSignificance_2D(){}

  /**
   * Read test parameters from input.
   *
   * \param  in            input stream
   * \return               input stream
   */
  std::istream& read(std::istream& in) override{ 
    return in >> threshold >> K;
  };

  /**
   * Write test result to output.
   *
   * \param  out           output stream
   * \param  delimiter     field delimiter
   * \param  onlyFailures  If true, write only failures.
   * \return               output stream
   */
  std::ostream& write(std::ostream& out, std::string delimiter = " ", bool onlyFailures = false) const override{
    for (std::vector<JTestResult>::const_iterator r = results.begin() ; r != results.end() ; ++r) {
      if (onlyFailures){
        if (!r->passed)
          out << std::scientific << std::setprecision(2) << (r->passed ? JPP::GREEN : JPP::RED) << r->print(delimiter) << std::endl;
      }else{
        out << std::scientific << std::setprecision(2) << (r->passed ? JPP::GREEN : JPP::RED) << r->print(delimiter) << std::endl;
      }
    }
    return out;
  };

  /**
   * Applies Significance test for two ROOT TH1 histograms.
   * 
   * \param o1 First histogram
   * \param o2 Second histogram
   */
  void test(TObject* o1, TObject* o2) override{    

    using namespace std;
    
    if (!(dynamic_cast<TH2*>(o1) == NULL) && !(dynamic_cast<TH2*>(o2) == NULL)) {

      TH2D* h1 =  dynamic_cast<TH2D*>(o1);
      TH2D* h2 =  dynamic_cast<TH2D*>(o2);
  
      if (h1 -> GetNbinsX() != h2 -> GetNbinsX() || h1 -> GetNbinsY() != h2 -> GetNbinsY())
        ERROR("Histograms with different bining. The objects: " << h1 -> GetName() << " can not be compared." << endl);

      if (K<0)
        K = h2->GetEntries()/h1->GetEntries();
      
      JTestResult r = JSignificanceTest<TH2D>(h1, h2, threshold, K, name, parameter);
     
      results.push_back(r);
    }
  };

  /**
   * Writes the test result to root file
   * \param f A ROOT file 
   * \param path Path in root file.
   * \param onlyFailures  If true, write only failures.
   */
  virtual void save(TFile* f , std::string path, bool onlyFailures = false) override{
    
    using namespace std;
    
    for (vector<JTestResult>::const_iterator r = results.begin() ; r != results.end() ; ++r){
      
      if (onlyFailures){
        if (!r->passed){
          if (f -> GetDirectory(path.c_str())==0) f->mkdir(path.c_str());
          f->cd(path.c_str());
          r->obj->Write();
        }
      }else{
        if (f -> GetDirectory(path.c_str())==0) f->mkdir(path.c_str());
        f->cd(path.c_str());
        r->obj->Write();
      }
    }      
  }

  /**
   * Clear results
   */
  void clear() override{
    results.clear();
  }
  
  /**
   * Get test name.
   */
  std::string getName() override{
    return name;
  }

  /**
   * Get parameter name.
   */
  std::string getParameter() override{
    return parameter;
  }


private:
  double threshold;                           //!< threshold p-value to decide if test is passed.
  double K;                                   //!< normalization factor between histograms.
  const std::string name      = "Significance_2D"; //!< test name.
  const std::string parameter = "Significance";    //!< test name.
}; 
#endif