Inheritance diagram for ComparisonBase:

Public Member Functions
	__init__ (self, object_a, object_b, Optional[MetaOptionParser] mop=None, debug=False)

	ensure_compute (self)

	comparison_result (self)

	comparison_result_long (self)

	can_compare (self)

Public Attributes
	object_a = object_a
	store the first object to compare

	object_b = object_b
	store the second object to compare

	mop = mop
	MetaOptionParser.

	debug = debug
	enable debug?

bool	computed = False
	used to store, whether the quantities have already been compared

Protected Member Functions
str	_get_comparison_result (self)

str	_get_comparison_result_long (self)

	_compute (self)

bool	_has_correct_types (self)

None	_raise_has_correct_types (self)

bool	_has_compatible_bins (self)

None	_raise_has_compatible_bins (self)

Static Protected Member Functions
	_convert_teff_to_hist (teff_a)

Protected Attributes
str	_comparison_result = "not_compared"
	Comparison result, i.e.

str	_comparison_result_long = ""
	Longer description of the comparison result (e.g.

Detailed Description

Base class for all comparison implementations.

Follows 3 steps:

1. Initialize the class together with two ROOT objects of different
revisions (that are to be compared) and the metaoptions (given in the
corresponding validation (steering) file), that determine how to compare
them.

2. The Comparison class saves the ROOT objects and the metaoptions
internally, but does not compute anything yet

3. If :meth:`ensure_compute` is called, or any property is accessed that
depends on computation, the internal implementation :meth:`_compute`
(to be implemented in the subclass) is called.

4. :meth:`_compute` ensures that all values, like chi2, p-value etc. are
computed

5. Two properties :meth:`comparison_result` (pass/warning/error) and
:meth:`comparison_result_long` (longer description of the comparison result)
allow to access the results.

Definition at line 95 of file validationcomparison.py.

Constructor & Destructor Documentation

◆ init()

__init__	(		self,
			object_a,
			object_b,
		Optional[MetaOptionParser]	mop = None,
			debug = False )

Initialize ComparisonBase class

:param object_a:
:param object_b:
:param mop: MetaOptionParser
:param debug (bool): Debug mode enabled?

Definition at line 121 of file validationcomparison.py.

    ):
        """
        Initialize ComparisonBase class
 
        :param object_a:
        :param object_b:
        :param mop: MetaOptionParser
        :param debug (bool): Debug mode enabled?
        """
        
        self.object_a = object_a
 
        self.object_b = object_b
 
        if mop is None:
            mop = MetaOptionParser()
        
        self.mop = mop
 
        self.debug = debug
 
        self.computed = False
 
        self._comparison_result = "not_compared"
        
        self._comparison_result_long = ""

Member Function Documentation

◆ _compute()

_compute ( self )

protected

 This method performs the actual computations.

Reimplemented in AndersonDarlingTest, Chi2Test, KolmogorovTest, and PvalueTest.

Definition at line 222 of file validationcomparison.py.

    def _compute(self):
        """ This method performs the actual computations. """
 

◆ _convert_teff_to_hist()

_convert_teff_to_hist ( teff_a )

staticprotected

Convert the content of a TEfficiency plot to a histogram and set
the bin content and errors

Definition at line 313 of file validationcomparison.py.

    def _convert_teff_to_hist(teff_a):
        """
        Convert the content of a TEfficiency plot to a histogram and set
        the bin content and errors
        """
        conv_hist = teff_a.GetTotalHistogram()
        xbin_count = conv_hist.GetNbinsX()
        xbin_low = conv_hist.GetXaxis().GetXmin()
        xbin_max = conv_hist.GetXaxis().GetXmax()
 
        th1 = ROOT.TH1D(
            teff_a.GetName() + "root_conversion",
            teff_a.GetName(),
            xbin_count,
            xbin_low,
            xbin_max,
        )
        # starting from the first to the last bin, ignoring the under/overflow
        # bins
        for i in range(1, xbin_count):
            th1.SetBinContent(i, teff_a.GetEfficiency(i))
            th1.SetBinError(i, teff_a.GetEfficiencyErrorLow(i))
 
        return th1
 
 

◆ _get_comparison_result()

str _get_comparison_result ( self )

protected

 Used to format the value of :attr:`_comparison_result`.

Reimplemented in PvalueTest.

Definition at line 202 of file validationcomparison.py.

    def _get_comparison_result(self) -> str:
        """ Used to format the value of :attr:`_comparison_result`. """
 

◆ _get_comparison_result_long()

str _get_comparison_result_long ( self )

protected

 Used to format the value of :attr:`_comparison_result_long`.

Reimplemented in AndersonDarlingTest, Chi2Test, KolmogorovTest, and PvalueTest.

Definition at line 206 of file validationcomparison.py.

    def _get_comparison_result_long(self) -> str:
        """ Used to format the value of :attr:`_comparison_result_long`. """
 

◆ _has_compatible_bins()

bool _has_compatible_bins ( self )

protected

Check if both ROOT objects have the same amount of bins
@return: True if the bins are equal, otherwise False

Definition at line 275 of file validationcomparison.py.

    def _has_compatible_bins(self) -> bool:
        """
        Check if both ROOT objects have the same amount of bins
        @return: True if the bins are equal, otherwise False
        """
        if (
            self.object_a.ClassName()
            == "TEfficiency"
            == self.object_b.ClassName()
        ):
            nbins_a = self.object_a.GetTotalHistogram().GetNbinsX()
            nbins_b = self.object_b.GetTotalHistogram().GetNbinsX()
        else:
            nbins_a = self.object_a.GetNbinsX()
            nbins_b = self.object_b.GetNbinsX()
 
        return nbins_a == nbins_b
 

◆ _has_correct_types()

bool _has_correct_types ( self )

protected

@return: True if the two objects have a) a type supported for
    comparison and b) can be compared with each other

Definition at line 231 of file validationcomparison.py.

    def _has_correct_types(self) -> bool:
        """
        @return: True if the two objects have a) a type supported for
            comparison and b) can be compared with each other
        """
        if self.object_a is None or self.object_b is None:
            return False
 
        # check if the supplied object inherit from one of the supported types
        # and if they are of the same type
        supported_types = ["TProfile", "TH1D", "TH1F", "TEfficiency"]
        if self.object_a.ClassName() != self.object_b.ClassName():
            return False
        if self.object_a.ClassName() not in supported_types:
            return False
 
        if self.object_a.ClassName() == "TEfficiency":
            # can only handle TEfficiencies with dimension one atm
            if self.object_a.GetDimension() > 1:
                return False
 
        return True
 

◆ _raise_has_compatible_bins()

None _raise_has_compatible_bins ( self )

protected

Raise Exception if not both ROOT objects have the same amount of bins
@return: None

Definition at line 293 of file validationcomparison.py.

    def _raise_has_compatible_bins(self) -> None:
        """
        Raise Exception if not both ROOT objects have the same amount of bins
        @return: None
        """
        if not self._has_compatible_bins():
            msg = (
                "The objects have differing x bin count: {} has {} vs. {} "
                "has {}."
            )
            raise DifferingBinCount(
                msg.format(
                    self.object_a.GetName(),
                    self.object_a.GetNbinsX(),
                    self.object_b.GetName(),
                    self.object_b.GetNbinsX(),
                )
            )
 

◆ _raise_has_correct_types()

None _raise_has_correct_types ( self )

protected

Raise Exception if not the two objects have a) a type supported for
comparison and b) can be compared with each other
@return: None

Definition at line 254 of file validationcomparison.py.

    def _raise_has_correct_types(self) -> None:
        """
        Raise Exception if not the two objects have a) a type supported for
        comparison and b) can be compared with each other
        @return: None
        """
        if not self._has_correct_types():
            msg = (
                "Comparison of {} (Type {}) with {} (Type {}) not "
                "supported.\nPlease open a GitLab issue (validation "
                "label) if you need this supported. "
            )
            raise ObjectsNotSupported(
                msg.format(
                    self.object_a.GetName(),
                    self.object_a.ClassName(),
                    self.object_b.GetName(),
                    self.object_b.ClassName(),
                )
            )
 

◆ can_compare()

can_compare ( self )

@return: True if the two objects can be compared, False otherwise

Definition at line 225 of file validationcomparison.py.

    def can_compare(self):
        """
        @return: True if the two objects can be compared, False otherwise
        """
        return self._has_correct_types() and self._has_compatible_bins()
 

◆ comparison_result()

comparison_result ( self )

 Comparison result, i.e. pass/warning/error

Definition at line 210 of file validationcomparison.py.

    def comparison_result(self):
        """ Comparison result, i.e. pass/warning/error """
        self.ensure_compute()
        return self._comparison_result
 

◆ comparison_result_long()

comparison_result_long ( self )

 Longer description of the comparison result

Definition at line 216 of file validationcomparison.py.

    def comparison_result_long(self):
        """ Longer description of the comparison result """
        self.ensure_compute()
        return self._comparison_result_long
 

◆ ensure_compute()

ensure_compute ( self )

Ensure all required quantities get computed and are cached inside the
class

Definition at line 159 of file validationcomparison.py.

    def ensure_compute(self):
        """
        Ensure all required quantities get computed and are cached inside the
        class
        """
        if self.computed:
            return
 
        if self.mop.has_option("nocompare"):
            # is comparison disabled for this plot ?
            self._comparison_result_long = "Testing is disabled for this plot"
            return
 
        fail_message = "Comparison failed: "
 
        # Note: default for comparison_result is "not_compared"
        try:
            self._compute()
        except ObjectsNotSupported as e:
            self._comparison_result_long = fail_message + str(e)
        except DifferingBinCount as e:
            self._comparison_result = "error"
            self._comparison_result_long = fail_message + str(e)
        except TooFewBins as e:
            self._comparison_result_long = fail_message + str(e)
        except ComparisonFailed as e:
            self._comparison_result = "error"
            self._comparison_result_long = fail_message + str(e)
        except Exception as e:
            self._comparison_result = "error"
            self._comparison_result_long = (
                "Unknown error occurred. Please "
                "submit a bug report. " + str(e)
            )
        else:
            # Will be already set in case of errors above and we don't want
            # to overwrite this.
            self._comparison_result_long = self._get_comparison_result_long()
            self._comparison_result = self._get_comparison_result()
 
        self.computed = True
 

Member Data Documentation

◆ _comparison_result

str _comparison_result = "not_compared"

protected

Comparison result, i.e.

equal/warning/error

Definition at line 154 of file validationcomparison.py.

◆ _comparison_result_long

str _comparison_result_long = ""

protected

Longer description of the comparison result (e.g.

'performed Chi2 Test ... with chi2 = ...').

Definition at line 157 of file validationcomparison.py.

◆ computed

bool computed = False

used to store, whether the quantities have already been compared

Definition at line 151 of file validationcomparison.py.

◆ debug

debug = debug

enable debug?

Definition at line 148 of file validationcomparison.py.

◆ mop

mop = mop

MetaOptionParser.

Definition at line 145 of file validationcomparison.py.

◆ object_a

object_a = object_a

store the first object to compare

Definition at line 137 of file validationcomparison.py.

◆ object_b

object_b = object_b

store the second object to compare

Definition at line 140 of file validationcomparison.py.

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

validation/scripts/validationcomparison.py

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _compute()

◆ _convert_teff_to_hist()

◆ _get_comparison_result()

◆ _get_comparison_result_long()

◆ _has_compatible_bins()

◆ _has_correct_types()

◆ _raise_has_compatible_bins()

◆ _raise_has_correct_types()

◆ can_compare()

◆ comparison_result()

◆ comparison_result_long()

◆ ensure_compute()

Member Data Documentation

◆ _comparison_result

◆ _comparison_result_long

◆ computed

◆ debug

◆ mop

◆ object_a

◆ object_b

◆ init()