JCOMPAREHISTOGRAMS::JTestIdentical Class Reference

Implementation of the a test to check if two 1D histograms are the same. More...

#include <JTestIdentical.hh>

Inheritance diagram for JCOMPAREHISTOGRAMS::JTestIdentical:

Public Member Functions
	JTestIdentical ()
	Default constructor. More...
void	test (const TObject *o1, const TObject *o2) override
	Applies test for two ROOT TH1 histograms. More...
std::istream &	read (std::istream &in) override
	Read test parameters from input. More...
virtual std::ostream &	write (std::ostream &out, const char delimiter= ' ', const bool onlyFailures=false) const
	Write test result to output. More...
virtual void	save (TFile *f, const std::string &path, const bool onlyFailures=false) const
	Writes the test result to root file. More...
const std::string &	getTestName () const
	Get test name. More...
const std::string &	getResultType () const
	Get result type. More...

Protected Attributes
const std::string	testName
	test name More...
const std::string	resultType
	test result type More...

Private Attributes
double	tolerance
	tolerance value to accept the difference as acceptable. More...

Detailed Description

Implementation of the a test to check if two 1D histograms are the same.

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.
The input parameter tolerance, is used to evaluate whether the test is passed or failed.

Definition at line 27 of file JTestIdentical.hh.

Constructor & Destructor Documentation

JCOMPAREHISTOGRAMS::JTestIdentical::JTestIdentical ( )

inline

Default constructor.

Definition at line 35 of file JTestIdentical.hh.

                     :
      JTest_t("Identical", "Difference")
    {}

Member Function Documentation

void JCOMPAREHISTOGRAMS::JTestIdentical::test ( const TObject *  o1, const TObject *  o2  )

inlineoverridevirtual

Applies test for two ROOT TH1 histograms.

Parameters

o1	First histogram
o2	Second histogram

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 46 of file JTestIdentical.hh.

    {    
      using namespace std;
      using namespace JPP;
                  
      const TH1* h1 =  dynamic_cast<const TH1*>(o1);
      const TH1* h2 =  dynamic_cast<const TH1*>(o2);

      if (h1 == NULL || h2 == NULL) {
        THROW(JValueOutOfRange, "JTestIdentical::test(): Could not cast given TObjects to TH1.");
      }

      if(h1->GetNbinsX() != h2->GetNbinsX() ||
         h1->GetNbinsY() != h2->GetNbinsY() ||
         h1->GetNbinsZ() != h2->GetNbinsZ()) {
        THROW(JValueOutOfRange, "JTestIdentical::test(): Histograms with different bining. The objects: " <<
              h1->GetName() << " and " << h2->GetName() << " can not be compared." << endl);
      }

      TH1* h3 = (TH1*) h1->Clone(h1->GetName() == h2->GetName() ?
                                 MAKE_CSTRING(h1->GetName()                            << "_" << testName) :
                                 MAKE_CSTRING(h1->GetName() << "_VS_" << h2->GetName() << "_" << testName));

      h3->Add(h2,-1);

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

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

      const JResultTitle title(testName, resultType, passed, maxDifference);
      
      h3->SetTitle(title.getTitle().c_str());

      const int Ndims = h3->GetDimension();

      if        (Ndims == 1) {
        h3->GetYaxis()->SetTitle(resultType.c_str());
      } else if (Ndims == 2) {
        h3->GetZaxis()->SetTitle(resultType.c_str());
      }
      
      const JTestResult r (testName,
                           JRootObjectID(MAKE_STRING(h1->GetDirectory()->GetPath() << h1->GetName())),
                           JRootObjectID(MAKE_STRING(h2->GetDirectory()->GetPath() << h1->GetName())),
                           resultType, maxDifference, tolerance, h3, passed);
     
      this->push_back(r);
    }

std::istream& JCOMPAREHISTOGRAMS::JTestIdentical::read ( std::istream &  in )

inlineoverridevirtual

Read test parameters from input.

Parameters

in	input stream

Returns

input stream

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 114 of file JTestIdentical.hh.

    {
      using namespace JPP;
      
      in >> tolerance;

      if (tolerance < 0.0) {
        THROW(JValueOutOfRange, "JTestIdentical::read(): Invalid tolerance value " << tolerance);
      }

      return in;
    }

virtual std::ostream& JCOMPAREHISTOGRAMS::JTest_t::write ( std::ostream &  out, const char  delimiter = ' ', const bool  onlyFailures = false  ) const

inlinevirtualinherited

Write test result to output.

Parameters

out	output stream
delimiter	field delimiter
onlyFailures	if true, write only failures.

Returns

output stream

Definition at line 84 of file JTest_t.hh.

    {
      using namespace std;
      using namespace JPP;

      for (vector<JTestResult>::const_iterator r = this->begin() ; r != this->end() ; ++r) {

        if (onlyFailures && r->passed) { continue; }
        
        print(out, *r, delimiter, true);
      }
      
      return out;
    }

virtual void JCOMPAREHISTOGRAMS::JTest_t::save ( TFile *  f, const std::string &  path, const bool  onlyFailures = false  ) const

inlinevirtualinherited

Writes the test result to root file.

Parameters

f	A ROOT file
path	Path in root file.
onlyFailures	If true, write only failures.

Definition at line 108 of file JTest_t.hh.

    {
      using namespace std;
      using namespace JPP;

      if (f->GetDirectory(path.c_str())==0) {
        f->mkdir(path.c_str());
      }
      
      f->cd(path.c_str());

      for (vector<JTestResult>::const_iterator r = this->begin() ; r != this->end() ; ++r) {

        if (onlyFailures && r->passed) { continue; }
        
        r->obj->Write();
      }
    }

const std::string& JCOMPAREHISTOGRAMS::JTest_t::getTestName ( ) const

inlineinherited

Get test name.

Returns

test name

Definition at line 135 of file JTest_t.hh.

    {
      return testName;
    }

const std::string& JCOMPAREHISTOGRAMS::JTest_t::getResultType ( ) const

inlineinherited

Get result type.

Returns

result type

Definition at line 146 of file JTest_t.hh.

    {
      return resultType;
    }

Member Data Documentation

double JCOMPAREHISTOGRAMS::JTestIdentical::tolerance

private

tolerance value to accept the difference as acceptable.

Definition at line 130 of file JTestIdentical.hh.

const std::string JCOMPAREHISTOGRAMS::JTest_t::testName

protectedinherited

test name

Definition at line 180 of file JTest_t.hh.

const std::string JCOMPAREHISTOGRAMS::JTest_t::resultType

protectedinherited

test result type

Definition at line 181 of file JTest_t.hh.

---

The documentation for this class was generated from the following file:

• JTestIdentical.hh