JTestIdentical_t.hh

Go to the documentation of this file.

#ifndef __JTESTIDENTICAL_T__
#define __JTESTIDENTICAL_T__

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

/**
 * \author rgruiz
 */

/**
 * Implementation test that verify if two histograms are the same.
 */
class JTestIdentical_t 
{ 
public:  

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

  /**
   * Bin-by-Bin test of two histograms, that verifies whether the histograms are the same.\n
   * For each bin, the test calculates the difference, and compares it with a tolerance passed as an argument.\n
   * The test is passed if the difference is smaller than the tolerance for every bin.\n 
   * The template parameter can be TH1X, TH2X or TH3X.
   * 
   * \param h1 First object
   * \param h2 Second object
   * \param tolerance tolerance value for the bin-by-bin differences   
   * \param parameterName Name of the parameter used to test the histograms
   * \param testName Name of the test used to compare the histograms
   *
   * \return Test result.
   */
  template<class T>
  JTestResult JIdenticalTest(T* h1, T* h2, double tolerance, std::string testName, std::string parameterName) {    
    
    using namespace std;
    using namespace JPP;
        
    if(h1 -> GetNbinsX() != h2 -> GetNbinsX() || h1 -> GetNbinsY() != h2 -> GetNbinsY() || h1 -> GetNbinsZ() != h2 -> GetNbinsZ())
      ERROR("Histograms with different bining. The objects: " << h1 -> GetName() << " can not be compared." << endl);
        
    T* h3 = (T*)h1->Clone(h1->GetName()==h2->GetName() ?
                          MAKE_CSTRING(to_string(h1->GetName())) :
                          MAKE_CSTRING(to_string(h1->GetName()) + "_VS_" + to_string(h2->GetName())));
    
    h3->Add(h2,-1);

    bool passed;
    
    double maxDifference = 0.0;
    
    for (int i=0 ; i < h1->GetNbinsX() ; ++i){
      for (int j=0 ; j< h1->GetNbinsY() ; ++j){
        for (int k=0 ; k< h1->GetNbinsY() ; ++k){
          
          double d = h1->GetBinContent(i+1,j+1,k+1) - h2->GetBinContent(i+1,j+1,k+1);

          if (fabs(d) > maxDifference)
            maxDifference = fabs(d);
          if (fabs(d) > tolerance)
            passed = false;
        }       
      }
    }

    JResultTitle title(testName, parameterName, passed , maxDifference);
    
    h3->SetTitle(title.getTitle().c_str());
        
    JTestResult r (testName,
                   string (h1->GetDirectory()->GetPath()).append(h1->GetName()),
                   string (h2->GetDirectory()->GetPath()).append(h2->GetName()),
                   h1->GetDirectory()->GetFile()->GetName(),
                   h2->GetDirectory()->GetFile()->GetName(),
                   parameterName, maxDifference, tolerance, h3, passed);

    return r;
  };  
}; 
  
#endif