hcal::test::IsCloseEnough Class Reference

Our custom checker which makes sure that the input energy/position is "close enough" to the truth energy/position. More...

Public Member Functions
	IsCloseEnough (double const &truth, double const &abs_diff, double const &rel_diff)
	Constructor.
bool	match (const double &daq) const override
	Performs the test for this matcher.
virtual std::string	describe () const override
	Describes matcher for printing to terminal.

Private Attributes
double	truth_
	correct (sim-level)
const double	MAX_ABSOLUTE_DIFF
	maximum absolute difference
const double	MAX_RELATIVE_DIFF
	maximum relative difference

Detailed Description

Our custom checker which makes sure that the input energy/position is "close enough" to the truth energy/position.

Definition at line 66 of file HcalDigiPipelineTest.cxx.

Constructor & Destructor Documentation

IsCloseEnough()

hcal::test::IsCloseEnough::IsCloseEnough ( double const & truth, double const & abs_diff, double const & rel_diff )

inline

Constructor.

Sets the truth level

Definition at line 83 of file HcalDigiPipelineTest.cxx.

      : truth_{truth},
        MAX_ABSOLUTE_DIFF{abs_diff},
        MAX_RELATIVE_DIFF{rel_diff} {}

Member Function Documentation

describe()

virtual std::string hcal::test::IsCloseEnough::describe ( ) const

inlineoverridevirtual

Describes matcher for printing to terminal.

Definition at line 104 of file HcalDigiPipelineTest.cxx.

                                              {
    std::ostringstream ss;
    ss << "is within an absolute difference of " << MAX_ABSOLUTE_DIFF
       << " OR a relative difference of " << MAX_RELATIVE_DIFF << " with "
       << truth_;
    return ss.str();
  }

References MAX_ABSOLUTE_DIFF, MAX_RELATIVE_DIFF, and truth_.

match()

bool hcal::test::IsCloseEnough::match ( const double & daq ) const

inlineoverride

Performs the test for this matcher.

We check that the input is either within the absolute difference or the relative difference.

Definition at line 96 of file HcalDigiPipelineTest.cxx.

                                               {
    return (daq == Approx(truth_).epsilon(MAX_RELATIVE_DIFF) or
            daq == Approx(truth_).margin(MAX_ABSOLUTE_DIFF));
  }

References MAX_ABSOLUTE_DIFF, MAX_RELATIVE_DIFF, and truth_.

Member Data Documentation

MAX_ABSOLUTE_DIFF

const double hcal::test::IsCloseEnough::MAX_ABSOLUTE_DIFF

private

maximum absolute difference

Definition at line 72 of file HcalDigiPipelineTest.cxx.

Referenced by describe(), and match().

MAX_RELATIVE_DIFF

const double hcal::test::IsCloseEnough::MAX_RELATIVE_DIFF

private

maximum relative difference

Definition at line 75 of file HcalDigiPipelineTest.cxx.

Referenced by describe(), and match().

truth_

double hcal::test::IsCloseEnough::truth_

private

correct (sim-level)

Definition at line 69 of file HcalDigiPipelineTest.cxx.

Referenced by describe(), and match().

---

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

• Hcal/test/HcalDigiPipelineTest.cxx