JCOMPAREHISTOGRAMS::JTest_t Class Reference

Interface to read input and write output for TObject tests. More...

#include <JTest_t.hh>

Inheritance diagram for JCOMPAREHISTOGRAMS::JTest_t:

Public Member Functions
	JTest_t (const std::string &testName, const std::string &resultType)
	Constructor.
virtual void	test (const TObject *o1, const TObject *o2)=0
	Tests compatibility between two TObjects.
virtual std::istream &	read (std::istream &in)=0
	Read test parameters from input.
virtual std::ostream &	write (std::ostream &out, const char delimiter=' ', const bool onlyFailures=false) const
	Write test result to output.
virtual void	save (TFile *f, const std::string &path, const bool onlyFailures=false) const
	Writes the test result to root file.
const std::string &	getTestName () const
	Get test name.
const std::string &	getResultType () const
	Get result type.

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

Friends
std::istream &	operator>> (std::istream &in, JTest_t &test)
	Read test parameters from input.
std::ostream &	operator<< (std::ostream &out, const JTest_t &test)
	Write test result to output.

Detailed Description

Interface to read input and write output for TObject tests.

This is an abstract class from which the different tests are derived.
All tests have in common the methods from this interface.
For each test, the parameters are passed through an istream, and parsed by the read() method.
For each test, the different results are stored in the internal results buffer.
The write() method is used to print a message with the result of the test.
The save() method is used to save a graphical output with the test results into a .root file.
For a list of available tests see JTestDictionary()

Definition at line 40 of file JTest_t.hh.

Constructor & Destructor Documentation

JTest_t()

JCOMPAREHISTOGRAMS::JTest_t::JTest_t ( const std::string & testName, const std::string & resultType )

inline

Constructor.

Parameters

testName	test name
resultType	result type

Definition at line 51 of file JTest_t.hh.

                                         :
      testName  (testName),
      resultType(resultType)
    {}

Member Function Documentation

test()

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

pure virtual

Tests compatibility between two TObjects.

Parameters

o1	First object
o2	Second object

Implemented in JCOMPAREHISTOGRAMS::JTestChi2, JCOMPAREHISTOGRAMS::JTestChi2_Bin, JCOMPAREHISTOGRAMS::JTestChi2_Slice2D, JCOMPAREHISTOGRAMS::JTestIdentical, JCOMPAREHISTOGRAMS::JTestKolmogorov_1D, JCOMPAREHISTOGRAMS::JTestKolmogorov_2D, JCOMPAREHISTOGRAMS::JTestKolmogorov_Slice2D, JCOMPAREHISTOGRAMS::JTestPoissonLogLikelihoodRatio, JCOMPAREHISTOGRAMS::JTestPoissonLogLikelihoodRatioBeestonBarlow, JCOMPAREHISTOGRAMS::JTestRuns_1D, JCOMPAREHISTOGRAMS::JTestRuns_Slice2D, JCOMPAREHISTOGRAMS::JTestSignificance, and JCOMPAREHISTOGRAMS::JTestZero.

read()

virtual std::istream & JCOMPAREHISTOGRAMS::JTest_t::read ( std::istream & in )

pure virtual

Read test parameters from input.

Parameters

in	input stream

Returns

input stream

Implemented in JCOMPAREHISTOGRAMS::JTestChi2, JCOMPAREHISTOGRAMS::JTestChi2_Bin, JCOMPAREHISTOGRAMS::JTestChi2_Slice2D, JCOMPAREHISTOGRAMS::JTestIdentical, JCOMPAREHISTOGRAMS::JTestKolmogorov_1D, JCOMPAREHISTOGRAMS::JTestKolmogorov_2D, JCOMPAREHISTOGRAMS::JTestKolmogorov_Slice2D, JCOMPAREHISTOGRAMS::JTestPoissonLogLikelihoodRatio, JCOMPAREHISTOGRAMS::JTestPoissonLogLikelihoodRatioBeestonBarlow, JCOMPAREHISTOGRAMS::JTestRuns_1D, JCOMPAREHISTOGRAMS::JTestRuns_Slice2D, JCOMPAREHISTOGRAMS::JTestSignificance, and JCOMPAREHISTOGRAMS::JTestZero.

write()

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

inlinevirtual

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

save()

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

inlinevirtual

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();
      }
    }

getTestName()

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

inline

Get test name.

Returns

test name

Definition at line 135 of file JTest_t.hh.

    {
      return testName;
    }

getResultType()

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

inline

Get result type.

Returns

result type

Definition at line 146 of file JTest_t.hh.

    {
      return resultType;
    }

Friends And Related Symbol Documentation

operator>>

std::istream & operator>> ( std::istream & in, JTest_t & test )

friend

Read test parameters from input.

Parameters

in	input stream
test	test

Returns

input stream

Definition at line 159 of file JTest_t.hh.

    {
      return test.read(in);
    }

operator<<

std::ostream & operator<< ( std::ostream & out, const JTest_t & test )

friend

Write test result to output.

Parameters

out	output stream
test	test

Returns

output stream

Definition at line 172 of file JTest_t.hh.

    {
      return test.write(out);
    }

Member Data Documentation

testName

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

protected

test name

Definition at line 180 of file JTest_t.hh.

resultType

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

protected

test result type

Definition at line 181 of file JTest_t.hh.

---

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

• JTest_t.hh