JTestRuns_2D.hh

Go to the documentation of this file.

#ifndef __JTESTRUNS_2D__
#define __JTESTRUNS_2D__

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

/**
 * \author rgruiz
 */

/**
 * Implementation of the Chi2 test for 2D histograms.\n
 * This class is derived from the abstract class JTest_t(). For a general description of the implementation of this and other tests derived from JTest_t(), see its documentation.\n
 * The parameter slice() can have the values x, X, y or Y. The histograms are sliced along the corresponding axis, and the JRunsTest() test is applied to each slice.\n 
 * This test uses the input parameter threshold() to evaluate whether the test is passed or failed for each slice.\n 
 * The evaluation is done by comparing the threshold value with the result of the JRunsTest() test.\n 
 * The results for each slice are stored in the results buffer (see JTest_t().)
 */
class JTestRuns_2D: 
  public JTestRuns_t, 
  public JTest_t 
{ 
public:  
  
  JTestRuns_2D(){}
  
  /**
   * Read test parameters from input.
   *
   * \param  in            input stream
   * \return               input stream
   */
  std::istream& read(std::istream& in) override{ 
    return in >> threshold >> slice;
  };

  /**
   * 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;
  };

  /**
   * Tests the statistical compatibility of two ROOT TObjects
   * 
   * \param o1 First object
   * \param o2 Second object
   */
  void test(TObject* o1, TObject* o2) override{    

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

      if(slice == 'x' || slice == 'X' || slice == 'y' || slice == 'Y'){
        
        JTestResult r = JRunsTestSlice(h1, h2, threshold, failuresThreshold, name, parameter, slice);

        results.push_back(r);
        
      } else {
        ERROR ("Slice option should be: x, X, y or Y, and not " + slice);
      }
      
    } else if (!(dynamic_cast<TH1*>(o1) == NULL) && !(dynamic_cast<TH1*>(o2) == NULL)) {
      ERROR("For 1D histograms call JChi2_1D: " << o1->GetName() << endl);
    }
  };

  /**
   * 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 value to decide if test is passed.
  double failuresThreshold;               //!< threshold value to decide if test is passed.
  char   slice;                           //!< Axis to slice. x or X for x-axis, y or Y for y-axis, n or N for None.
  const std::string name = "Runs_2D";     //!< test name.
  const std::string parameter = "#sigma"; //!< parameter name.
}; 
  
#endif