plot.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
 
 
 
import sys
import math
import collections
import array
import numpy as np
import ctypes
 
import ROOT
 
import basf2
 
from tracking.root_utils import root_cd, root_save_name
 
from tracking.validation import statistics
 
import logging
 
 
def get_logger():
    """Get for the logging.Logger instance of this module
 
    Returns
    -------
    logging.Logger
        Logger instance of this module
    """
    return logging.getLogger(__name__)
 
 
 
units_by_quantity_name = {
    'x': 'cm',
    'y': 'cm',
    'z': 'cm',
    'E': 'GeV',
    'px': 'GeV',
    'p_{x}': 'GeV',
    'py': 'GeV',
    'p_{y}': 'GeV',
    'pz': 'GeV',
    'p_{z}': 'GeV',
    'pt': 'GeV',
    'p_{t}': 'GeV',
    'd0': 'cm',
    'd_{0}': 'cm',
    'phi0': None,
    '#phi_{0}': None,
    'omega': '1/cm',
    '#omega': '1/cm',
    'z0': 'cm',
    'z_{0}': 'cm',
    'tan_lambda': None,
    'tan #lambda': None}
 
 
def get_unit(quantity_name):
    """Infers the unit of a quantity from its name.
 
    Assumes the standard Belle II unit system.
 
    Currently looks up the quantity string from units_by_quantity_name.
 
    Parameters
    ----------
    quantity_name : str
        Name of a quantity (E.g. pt, x, ...)
 
    Returns
    -------
    str
    """
 
    unit = units_by_quantity_name.get(quantity_name, None)
    return unit
 
 
def compose_axis_label(quantity_name, unit=None):
    """Formats a quantity name and a unit to a label for a plot axes.
 
    If the unit is not given to is tried to infer it
    from the quantity name by the get_unit function.
 
    Parameters
    ----------
    quantity_name : str
        Name of the quantity to be displayed at the axes
    unit : str, optional
        The unit of the quantity. Defaults to get_unit(quantity_name)
 
    Returns
    -------
    str
    """
 
    if unit is None:
        unit = get_unit(quantity_name)
 
    if unit is None:
        axis_label = quantity_name
    else:
        axis_label = '%s (%s)' % (quantity_name, unit)
 
    return axis_label
 
 
def get1DBinningFromReference(name, refFileName):
    """ returns nbins, lowerbound, upperbound for TH1 / TProfile with name "name" found in the file "refFileName"
 
        @param name : name of the TH1 object to be looked for in the file
        @param refFileName : name of the reference file where the object is searched for
 
        @return int nbin, float xmin, float xmax  of the TH1
    """
 
    nbins = None
    x_min = None
    x_max = None
 
    if refFileName is None or refFileName == "":
        return nbins, x_min, x_max
 
    # store current directory to not confuse directories by opening a TFile
    oldDirectory = ROOT.gROOT.CurrentDirectory().load()
 
    tfile = ROOT.TFile(refFileName)
    if tfile.IsOpen():
        objptr = tfile.Get(name)
        if objptr and objptr.InheritsFrom("TH1"):
            nbins = objptr.GetNbinsX()
            x_min = objptr.GetXaxis().GetXmin()
            x_max = objptr.GetXaxis().GetXmax()
        else:
            basf2.B2WARNING('Requested object with name: ' + name + ' not found in file: ' + refFileName + " (or not a TH1)")
    else:
        basf2.B2WARNING('Requested file: ' + refFileName + ' could not be opened')
 
    tfile.Close()
 
    # set current directory back to original one
    oldDirectory.cd()
 
    return nbins, x_min, x_max
 
 
 
StatsEntry = ROOT.TParameter(float)
 
 
class ValidationPlot(object):
 
    """Class for generating a validation plot for the Belle II validation page.
 
    Typically it generates plots from values stored in numpy arrays and feeds them into
    plot ROOT classes for storing them.
 
    It implements an automatic binning procedure based on the rice rule and
    robust z score outlier detection.
 
    It also keeps track of additional statistics typically neglected by ROOT such as a count
    for the non finit values such as NaN, +Inf, -Inf.
 
    The special attributes for the Belle II validation page like
    * title
    * contract
    * description
    * check
    are exposed as properties of this class.
    """
 
    
    very_sparse_dots_line_style_index = 28
    # This line style is defined in the set_tstyle method below.
 
    def __init__(self, name, referenceFileName=None):
        """Constructor of the ValidationPlot
 
        Parameters
        ----------
        name : str
            A unique name to be used as the name of the ROOT object to be generated
 
        referenceFileName : str
            name of a reference file. If set the code will try to get the histogram or profile
            from that file and determine the number of bins and upper and lower bound
            (so far only implemented for 1D (TH1, TProfile), is ignored for 2D plots)
        """
 
        
        self.namename = root_save_name(name)
 
        
        self.referenceFileNamereferenceFileName = referenceFileName
 
        
        self._description_description = ''
 
        
        self._check_check = ''
 
        
        self._contact_contact = ''
 
        
        self._xlabel_xlabel = ''
 
        
        self._ylabel_ylabel = ''
 
        
        self._title_title = ''
 
        
        self.plotplot = None
 
        
        self.histogramshistograms = []
 
        
        self._is_expert_is_expert = True
 
        
        self.pvalue_warnpvalue_warn = None
 
        
        self.pvalue_errorpvalue_error = None
 
        
        self.y_logy_log = False
 
    def hist(self,
             xs,
             weights=None,
             stackby=None,
             bins=None,
             lower_bound=None,
             upper_bound=None,
             outlier_z_score=None,
             include_exceptionals=True,
             allow_discrete=False,
             cumulation_direction=None,
             is_expert=True):
        """Fill the plot with a one dimensional histogram."""
 
        # if referenceFileName was set the binning will taken from there
        if self.referenceFileNamereferenceFileName is not None:
            n, xmin, xmax = get1DBinningFromReference(self.namename, self.referenceFileNamereferenceFileName)
            if n is not None and xmin is not None and xmax is not None:
                bins = n
                upper_bound = xmax
                lower_bound = xmin
 
        th1_factory = ROOT.TH1D
        self._is_expert_is_expert = is_expert
 
        self.create_1dcreate_1d(th1_factory,
                       xs,
                       weights=weights,
                       stackby=stackby,
                       bins=bins,
                       lower_bound=lower_bound,
                       upper_bound=upper_bound,
                       outlier_z_score=outlier_z_score,
                       include_exceptionals=include_exceptionals,
                       allow_discrete=allow_discrete,
                       cumulation_direction=cumulation_direction)
 
        if not self.ylabelylabelylabelylabel:
            
            self.ylabelylabelylabelylabel = 'count'
 
        return self
 
    def profile(self,
                xs,
                ys,
                weights=None,
                stackby=None,
                bins=None,
                lower_bound=None,
                upper_bound=None,
                y_binary=None,
                y_log=None,
                outlier_z_score=None,
                include_exceptionals=True,
                allow_discrete=False,
                cumulation_direction=None,
                gaus_z_score=None,
                is_expert=True,
                is_asymmetry=False):
        """Fill the plot with a one dimensional profile of one variable over another."""
 
        # if referenceFileName was set the binning will taken from there
        if self.referenceFileNamereferenceFileName is not None:
            n = None
            xmin = None
            xmax = None
            n, xmin, xmax = get1DBinningFromReference(self.namename, self.referenceFileNamereferenceFileName)
            if n is not None and xmin is not None and xmax is not None:
                bins = n
                upper_bound = xmax
                lower_bound = xmin
 
        th1_factory = ROOT.TProfile
        self._is_expert_is_expert = is_expert
        if gaus_z_score is None:
            self.create_1dcreate_1d(th1_factory,
                           xs,
                           ys,
                           weights=weights,
                           stackby=stackby,
                           bins=bins,
                           lower_bound=lower_bound,
                           upper_bound=upper_bound,
                           outlier_z_score=outlier_z_score,
                           include_exceptionals=include_exceptionals,
                           allow_discrete=allow_discrete,
                           cumulation_direction=cumulation_direction)
        else:
            # Introduce a dummy name for the temporary two dimensional histogram
            self.namename = "_" + self.namename
            self.hist2dhist2d(xs, ys=ys, weights=weights, stackby=stackby,
                        bins=(bins, None),
                        lower_bound=(lower_bound, None),
                        upper_bound=(upper_bound, None),
                        outlier_z_score=(outlier_z_score, outlier_z_score),
                        include_exceptionals=(include_exceptionals, True),
                        allow_discrete=(allow_discrete, False),
                        is_expert=is_expert)
 
            self.namename = self.namename[1:]
            profiles = []
            for histogram in self.histogramshistograms:
                profile = self.gaus_slice_fitgaus_slice_fit(histogram,
                                              name=histogram.GetName()[1:],
                                              z_score=gaus_z_score)
                profiles.append(profile)
            self.histogramshistograms = profiles
            self.plotplot = self.create_stackcreate_stack(profiles, name=self.plotplot.GetName()[1:], reverse_stack=False)
 
        if y_log:
            self.y_logy_log = True
 
        if y_binary or self.is_binaryis_binary(ys):
            if not self.ylabelylabelylabelylabel:
                self.ylabelylabelylabelylabel = 'probability'
 
            min_y = 0
            if(is_asymmetry):
                min_y = -1.05
            for histogram in self.histogramshistograms:
                histogram.SetMinimum(min_y)
                histogram.SetMaximum(1.05)
 
            self.plotplot.SetMinimum(min_y)
            self.plotplot.SetMaximum(1.05)
 
        return self
 
    def scatter(self,
                xs,
                ys,
                stackby=None,
                lower_bound=(None, None),
                upper_bound=(None, None),
                outlier_z_score=(None, None),
                include_exceptionals=(True, True),
                max_n_data=100000,
                is_expert=True):
        """Fill the plot with a (unbinned) two dimensional scatter plot"""
 
        self._is_expert_is_expert = is_expert
 
        x_lower_bound, y_lower_bound = self.unpack_2d_paramunpack_2d_param(lower_bound)
        x_upper_bound, y_upper_bound = self.unpack_2d_paramunpack_2d_param(upper_bound)
        x_outlier_z_score, y_outlier_z_score = self.unpack_2d_paramunpack_2d_param(outlier_z_score)
        x_include_exceptionals, y_include_exceptionals = self.unpack_2d_paramunpack_2d_param(include_exceptionals)
 
        x_lower_bound, x_upper_bound = self.determine_rangedetermine_range(
            xs,
            lower_bound=x_lower_bound,
            upper_bound=x_upper_bound,
            outlier_z_score=x_outlier_z_score,
            include_exceptionals=x_include_exceptionals
        )
 
        y_lower_bound, y_upper_bound = self.determine_rangedetermine_range(
            ys,
            lower_bound=y_lower_bound,
            upper_bound=y_upper_bound,
            outlier_z_score=y_outlier_z_score,
            include_exceptionals=y_include_exceptionals
        )
 
        graph = ROOT.TGraph()
 
        graph.SetName(self.namename)
        graph.SetMarkerStyle(6)
        graph.GetHistogram().SetOption("AP")  # <-- this has no effect?
 
        # Trying to make the graph lines invisible
        color_index = 0  # white
        # Transperent white
        graph.SetLineColorAlpha(color_index, 0)
        graph.SetLineStyle(self.very_sparse_dots_line_style_indexvery_sparse_dots_line_style_index)
 
        # Transport the lower and upper bound as ranges of the axis
        graph.GetXaxis().SetLimits(x_lower_bound, x_upper_bound)
        graph.GetYaxis().SetLimits(y_lower_bound, y_upper_bound)
 
        self.createcreate(graph,
                    xs=xs,
                    ys=ys,
                    stackby=stackby,
                    reverse_stack=False)
 
        return self
 
    def grapherrors(self,
                    xs_and_err,
                    ys_and_err,
                    stackby=None,
                    lower_bound=(None, None),
                    upper_bound=(None, None),
                    outlier_z_score=(None, None),
                    include_exceptionals=(True, True),
                    max_n_data=100000,
                    is_expert=True):
        """Fill the plot with a (unbinned) two dimensional scatter plot
        xs_and_err and ys_and_err are tuples containing the values and the errors on these values
        as numpy arrays
        """
 
        self._is_expert_is_expert = is_expert
 
        xs = xs_and_err[0]
        ys = ys_and_err[0]
 
        x_lower_bound, y_lower_bound = self.unpack_2d_paramunpack_2d_param(lower_bound)
        x_upper_bound, y_upper_bound = self.unpack_2d_paramunpack_2d_param(upper_bound)
        x_outlier_z_score, y_outlier_z_score = self.unpack_2d_paramunpack_2d_param(outlier_z_score)
        x_include_exceptionals, y_include_exceptionals = self.unpack_2d_paramunpack_2d_param(include_exceptionals)
 
        x_lower_bound, x_upper_bound = self.determine_rangedetermine_range(
            xs,
            lower_bound=x_lower_bound,
            upper_bound=x_upper_bound,
            outlier_z_score=x_outlier_z_score,
            include_exceptionals=x_include_exceptionals
        )
 
        y_lower_bound, y_upper_bound = self.determine_rangedetermine_range(
            ys,
            lower_bound=y_lower_bound,
            upper_bound=y_upper_bound,
            outlier_z_score=y_outlier_z_score,
            include_exceptionals=y_include_exceptionals
        )
 
        graph = ROOT.TGraphErrors()
 
        graph.SetName(self.namename)
        graph.GetHistogram().SetOption("A")
 
        graph.SetMarkerColor(4)
        graph.SetMarkerStyle(21)
 
        # Transport the lower and upper bound as ranges of the axis
        graph.GetXaxis().SetLimits(x_lower_bound, x_upper_bound)
        graph.GetYaxis().SetLimits(y_lower_bound, y_upper_bound)
 
        self.createcreate(graph,
                    xs=xs,
                    ys=ys,
                    stackby=stackby,
                    reverse_stack=False)
 
        return self
 
    def hist2d(self,
               xs,
               ys,
               weights=None,
               stackby=None,
               bins=(None, None),
               lower_bound=(None, None),
               upper_bound=(None, None),
               outlier_z_score=(None, None),
               include_exceptionals=(True, True),
               allow_discrete=(False, False),
               quantiles=None,
               is_expert=True):
        """Fill the plot with a two dimensional histogram"""
 
        name = self.namename
        # Introduce a dummy name for the temporary two dimensional histogram
        if quantiles is not None:
            name = "_" + self.namename
 
        x_bins, y_bins = self.unpack_2d_paramunpack_2d_param(bins)
        x_lower_bound, y_lower_bound = self.unpack_2d_paramunpack_2d_param(lower_bound)
        x_upper_bound, y_upper_bound = self.unpack_2d_paramunpack_2d_param(upper_bound)
        x_outlier_z_score, y_outlier_z_score = self.unpack_2d_paramunpack_2d_param(outlier_z_score)
        x_include_exceptionals, y_include_exceptionals = self.unpack_2d_paramunpack_2d_param(include_exceptionals)
        x_allow_discrete, y_allow_discrete = self.unpack_2d_paramunpack_2d_param(allow_discrete)
 
        if quantiles is not None:
            y_include_exceptionals = True
            y_allow_discrete = False
 
        x_bin_edges, x_bin_labels = self.determine_bin_edgesdetermine_bin_edges(xs,
                                                             stackbys=stackby,
                                                             bins=x_bins,
                                                             lower_bound=x_lower_bound,
                                                             upper_bound=x_upper_bound,
                                                             outlier_z_score=x_outlier_z_score,
                                                             include_exceptionals=x_include_exceptionals,
                                                             allow_discrete=x_allow_discrete)
 
        y_bin_edges, y_bin_labels = self.determine_bin_edgesdetermine_bin_edges(ys,
                                                             stackbys=stackby,
                                                             bins=y_bins,
                                                             lower_bound=y_lower_bound,
                                                             upper_bound=y_upper_bound,
                                                             outlier_z_score=y_outlier_z_score,
                                                             include_exceptionals=y_include_exceptionals,
                                                             allow_discrete=y_allow_discrete)
 
        n_x_bins = len(x_bin_edges) - 1
        n_y_bins = len(y_bin_edges) - 1
        
        self.lower_boundlower_bound = (x_bin_edges[0], y_bin_edges[0])
        
        self.upper_boundupper_bound = (x_bin_edges[-1], y_bin_edges[-1])
 
        histogram = ROOT.TH2D(name,
                              '',
                              n_x_bins,
                              x_bin_edges,
                              n_y_bins,
                              y_bin_edges)
 
        if x_bin_labels:
            get_logger().info("Scatter plot %s is discrete in x.", name)
            x_taxis = histogram.GetXaxis()
            for i_x_bin, x_bin_label in enumerate(x_bin_labels):
                x_taxis.SetBinLabel(i_x_bin + 1, x_bin_label)
            self.add_stats_entryadd_stats_entry(histogram, "dx", 1)
 
        else:
            x_bin_width = x_bin_edges[1] - x_bin_edges[0]
            self.add_stats_entryadd_stats_entry(histogram, "dx", x_bin_width)
 
        if y_bin_labels:
            get_logger().info("Scatter plot %s is discrete in y.", name)
            y_taxis = histogram.GetYaxis()
            for i_y_bin, y_bin_label in enumerate(y_bin_labels):
                y_taxis.SetBinLabel(i_y_bin + 1, y_bin_label)
            self.add_stats_entryadd_stats_entry(histogram, "dy", 1)
 
        else:
            y_bin_width = y_bin_edges[1] - y_bin_edges[0]
            self.add_stats_entryadd_stats_entry(histogram, "dy", y_bin_width)
 
        self.createcreate(histogram, xs, ys=ys, weights=weights, stackby=stackby)
 
        if quantiles is not None:
            self.namename = self.namename[1:]
            profiles = []
            for histogram in self.histogramshistograms:
                for quantile in quantiles:
                    profile = histogram.QuantilesX(quantile, histogram.GetName()[1:] + '_' + str(quantile))
 
                    # Manually copy labels grumble grumble
                    x_taxis = histogram.GetXaxis()
                    new_x_taxis = profile.GetXaxis()
                    for i_bin in range(x_taxis.GetNbins() + 2):
                        label = x_taxis.GetBinLabel(i_bin)
                        if label != "":
                            new_x_taxis.SetBinLabel(i_bin, label)
 
                    # Remove faulty error values)
                    epsilon = sys.float_info.epsilon
                    for i_bin in range(0, profile.GetNbinsX() + 2):
                        profile.SetBinError(i_bin, epsilon)
 
                    profiles.append(profile)
 
            self.histogramshistograms = profiles
            self.plotplot = self.create_stackcreate_stack(profiles, name=self.plotplot.GetName()[1:], reverse_stack=False, force_graph=True)
 
        # Adjust the discrete bins after the filling to be equidistant
        if x_bin_labels:
            for histogram in self.histogramshistograms:
                x_taxis = histogram.GetXaxis()
                x_bin_edges = array.array("d", list(range(len(x_bin_labels) + 1)))
                x_taxis.Set(n_x_bins, x_bin_edges)
 
        # Adjust the discrete bins after the filling to be equidistant
        if y_bin_labels:
            for histogram in self.histogramshistograms:
                x_taxis = histogram.GetXaxis()
                y_bin_edges = array.array("d", list(range(len(y_bin_labels) + 1)))
                y_taxis.Set(n_y_bins, y_bin_edges)
 
        return self
 
    def fit_gaus(self, z_score=None):
        """Fit a gaus belle curve to the central portion of a one dimensional histogram
 
        The fit is applied to the central mean +- z_score * std interval of the histogram,
        such that it is less influence by non gaussian tails further away than the given z score.
 
        @param float z_score   number of sigmas to include from the mean value of the histogram.
        """
        title = "gaus"
        formula = "gaus"
 
        plot = self.plotplot
        if plot is None:
            raise RuntimeError('Validation plot must be filled before it can be fitted.')
 
        if not isinstance(plot, ROOT.TH1D):
            raise RuntimeError('Fitting is currently implemented / tested for one dimensional, non stacked validation plots.')
 
        histogram = plot
 
        fit_tf1 = ROOT.TF1("Fit", formula)
        fit_tf1.SetTitle(title)
        fit_tf1.SetParName(0, "n")
        fit_tf1.SetParName(1, "mean")
        fit_tf1.SetParName(2, "std")
 
        n = histogram.GetSumOfWeights()
        mean = histogram.GetMean()
        std = histogram.GetStdDev()
 
        fit_tf1.SetParameter(0, n)
        fit_tf1.SetParameter(1, mean)
        fit_tf1.SetParameter(2, std)
 
        fit_options = "LM"
        return self.fitfit(fit_tf1,
                        fit_options,
                        z_score=z_score)
 
    def fit_line(self):
        """Fit a general line to a one dimensional histogram"""
        title = "line"
        formula = "x++1"
        fit_tf1 = ROOT.TF1("Fit", formula)
        fit_tf1.SetTitle(title)
        fit_tf1.SetParName(0, "slope")
        fit_tf1.SetParName(1, "intercept")
        self.fitfit(fit_tf1, 'M')
 
    def fit_const(self):
        """Fit a constant function to a one dimensional histogram"""
        title = "const"
        formula = "[0]"
        fit_tf1 = ROOT.TF1("Fit", formula)
        fit_tf1.SetTitle(title)
        fit_tf1.SetParName(0, "intercept")
        self.fitfit(fit_tf1, 'M')
 
    def fit_diag(self):
        """Fit a diagonal line through the origin to a one dimensional histogram"""
        title = "diag"
        formula = "[0]*x"
        fit_tf1 = ROOT.TF1("Fit", formula)
        fit_tf1.SetTitle(title)
        fit_tf1.SetParName(0, "slope")
        self.fitfit(fit_tf1, 'M')
 
    def fit(self, formula, options, lower_bound=None, upper_bound=None, z_score=None):
        """Fit a user defined function to a one dimensional histogram
 
        Parameters
        ----------
        formula : str or TF1
            Formula string or TH1 to be fitted. See TF1 constructurs for that is a valid formula
        options : str
           Options string to be used in the fit. See TH1::Fit()
        lower_bound : float
           Lower bound of the range to be fitted
        upper_bound : float
           Upper bound of the range to be fitted
        """
        plot = self.plotplot
        if plot is None:
            raise RuntimeError('Validation plot must be filled before it can be fitted.')
 
        if not isinstance(plot, ROOT.TH1D):
            raise RuntimeError('Fitting is currently implemented / tested for one dimensional, non stacked validation plots.')
 
        histogram = plot
 
        xaxis = histogram.GetXaxis()
        n_bins = xaxis.GetNbins()
        hist_lower_bound = xaxis.GetBinLowEdge(1)
        hist_upper_bound = xaxis.GetBinUpEdge(n_bins)
 
        if z_score is not None:
            mean = histogram.GetMean()
            std = histogram.GetStdDev()
 
            if lower_bound is None:
                lower_bound = mean - z_score * std
 
            if upper_bound is None:
                upper_bound = mean + z_score * std
 
        # Setup the plotting range of the function to match the histogram
        if isinstance(formula, ROOT.TF1):
            fit_tf1 = formula
            fit_tf1.SetRange(hist_lower_bound, hist_upper_bound)
        else:
            fit_tf1 = ROOT.TF1("Fit",
                               formula,
                               hist_lower_bound,
                               hist_upper_bound)
        get_logger().info('Fitting with %s', fit_tf1.GetExpFormula())
 
        # Determine fit range
        if lower_bound is None or lower_bound < hist_lower_bound:
            lower_bound = hist_lower_bound
        if upper_bound is None or upper_bound > hist_upper_bound:
            upper_bound = hist_upper_bound
 
        # Make sure the fitted function is not automatically added since we want to do that one our own.
        # Look for the documentation of TH1::Fit() for details of the options.
        if 'N' not in options:
            options += 'N'
 
        fit_res = histogram.Fit(fit_tf1, options + "S", "", lower_bound, upper_bound)
 
        self.set_fit_tf1set_fit_tf1(histogram, fit_tf1)
        return fit_res
 
    def show(self):
        """Show the plot."""
        if self.plotplot:
            self.plotplot.Draw()
        else:
            raise ValueError("Can not show a validation plot that has not been filled.")
 
    def write(self, tdirectory=None):
        """Write the plot to file
 
        Parameters
        ----------
        tdirectory : ROOT.TDirectory, optional
            ROOT directory to which the plot should be written.
            If omitted write to the current directory
        """
        if not self.plotplot:
            raise ValueError("Can not write a validation plot that has not been filled.")
 
        with root_cd(tdirectory):
            ValidationPlot.set_tstyle()
            if self.plotplot not in self.histogramshistograms:
                self.plotplot.Write()
 
            # always disable ROOT's stat plot because it hides items
            meta_options = ["nostats"]
 
            # add expert option, if requested
            if self.is_expertis_expert:
                meta_options.append("expert")
            else:
                meta_options.append("shifter")
 
            # give a custom pvalue warning / error zone if requested
            if self.pvalue_errorpvalue_error is not None:
                meta_options.append("pvalue-error={}".format(self.pvalue_errorpvalue_error))
            if self.pvalue_warnpvalue_warn is not None:
                meta_options.append("pvalue-warn={}".format(self.pvalue_warnpvalue_warn))
 
            # Indicator if the y axes should be displayed as a logarithmic scale
            if self.y_logy_log:
                meta_options.append("logy")
 
            meta_options_str = ",".join(meta_options)
 
            for histogram in self.histogramshistograms:
                histogram.GetListOfFunctions().Add(ROOT.TNamed('MetaOptions', meta_options_str))
                histogram.Write()
 
    @property
    def is_expert(self):
        """Getter method if an plot plot is marked as expert plot"""
        return self._is_expert_is_expert
 
    @property
    def title(self):
        """Getter for the plot title"""
        return self._title_title
 
    @title.setter
    def title(self, title):
        """Setter for the plot title"""
        self._title_title = title
        if self.plotplot:
            self.plotplot.SetTitle(title)
        for histogram in self.histogramshistograms:
            histogram.SetTitle(title)
 
    @property
    def xlabel(self):
        """Getter for the axis label at the x axis"""
        return self._xlabel_xlabel
 
    @xlabel.setter
    def xlabel(self, xlabel):
        """Setter for the axis label at the x axis"""
        self._xlabel_xlabel = xlabel
        for histogram in self.histogramshistograms:
            histogram.GetXaxis().SetTitle(xlabel)
 
    @property
    def ylabel(self):
        """Getter for the axis label at the y axis"""
        return self._ylabel_ylabel
 
    @ylabel.setter
    def ylabel(self, ylabel):
        """Setter for the axis label at the y axis"""
        self._ylabel_ylabel = ylabel
        for histogram in self.histogramshistograms:
            histogram.GetYaxis().SetTitle(ylabel)
 
    @property
    def contact(self):
        """Getter for the contact email address to be displayed on the validation page"""
        return self._contact_contact
 
    @contact.setter
    def contact(self, contact):
        """Setter for the contact email address to be displayed on the validation page"""
        self._contact_contact = contact
        for histogram in self.histogramshistograms:
            found_obj = histogram.FindObject('Contact')
            if not found_obj:
                tnamed = ROOT.TNamed("Contact", contact)
                histogram.GetListOfFunctions().Add(tnamed)
                found_obj = histogram.FindObject('Contact')
            found_obj.SetTitle(contact)
 
    @property
    def description(self):
        """Getter for the description to be displayed on the validation page"""
        return self._description_description
 
    @description.setter
    def description(self, description):
        """Setter for the description to be displayed on the validation page"""
        self._description_description = description
        for histogram in self.histogramshistograms:
            found_obj = histogram.FindObject('Description')
            if not found_obj:
                tnamed = ROOT.TNamed("Description", description)
                histogram.GetListOfFunctions().Add(tnamed)
                found_obj = histogram.FindObject('Description')
            found_obj.SetTitle(description)
 
    @property
    def check(self):
        """Getter for the check to be displayed on the validation page"""
        return self._check_check
 
    @check.setter
    def check(self, check):
        """Setter for the check to be displayed on the validation page"""
        self._check_check = check
        for histogram in self.histogramshistograms:
            found_obj = histogram.FindObject('Check')
            if not found_obj:
                tnamed = ROOT.TNamed("Check", check)
                histogram.GetListOfFunctions().Add(tnamed)
                found_obj = histogram.FindObject('Check')
            found_obj.SetTitle(check)
 
    # Implementation details #
    # ###################### #
 
    @staticmethod
    def unpack_2d_param(param):
        """Unpacks a function parameter for the two dimensional plots.
 
        If it is a pair the first parameter shall apply to the x coordinate
        the second to the y coordinate. In this case the pair is returned as two values
 
        If something else is given the it is assumed that this parameter should equally apply
        to both coordinates. In this case the same values is return twice as a pair.
 
        Parameters
        ----------
        param : pair or single value
            Function parameter for a two dimensional plot
 
        Returns
        -------
        pair
            A pair of values being the parameter for the x coordinate and
            the y coordinate respectively
        """
        try:
            if len(param) == 2:
                x_param, y_param = param
        except TypeError:
            x_param = param
            y_param = param
        return x_param, y_param
 
    @staticmethod
    def is_binary(xs):
        """Determine if the data consists of boolean values"""
        return statistics.is_binary_series(xs)
 
    @staticmethod
    def is_discrete(xs, max_n_unique=None):
        """Determine if the data consists of discrete values"""
        return statistics.is_discrete_series(xs, max_n_unique=max_n_unique)
 
    @staticmethod
    def get_exceptional_values(xs):
        """Find exceptionally frequent values
 
        Parameters
        ----------
        xs : np.array (1d)
            Data series
 
        Returns
        -------
        np.array (1d)
            A list of the found exceptional values.
        """
        return statistics.rice_exceptional_values(xs)
 
    @staticmethod
    def get_robust_mean_and_std(xs):
        """Does an estimation of mean and standard deviation robust against outliers.
 
        Parameters
        ----------
        xs : np.array (1d)
            Data series
 
        Returns
        -------
        float, float
           Pair of mean and standard deviation
        """
        x_mean = statistics.truncated_mean(xs)
        x_std = statistics.trimmed_std(xs)
        return x_mean, x_std
 
    @staticmethod
    def format_bin_label(value):
        """Formats a value to be placed at a tick on an axis."""
        if np.isfinite(value) and value == np.round(value):
            return str(int(value))
        else:
            formated_value = "{:.5g}".format(value)
 
            # if the label is to long, switch to shorter "e" format
            if len(formated_value) > 8:
                formated_value = "{:.3e}".format(value)
            return formated_value
 
    def create_1d(self,
                  th1_factory,
                  xs,
                  ys=None,
                  weights=None,
                  bins=None,
                  stackby=None,
                  lower_bound=None,
                  upper_bound=None,
                  outlier_z_score=None,
                  include_exceptionals=True,
                  allow_discrete=False,
                  cumulation_direction=None):
        """Combined factory method for creating a one dimensional histogram or a profile plot."""
        name = self.namename
 
        # Coerce values to a numpy array. Do not copy if already a numpy array.
        xs = np.array(xs, copy=False)
 
        if ys is not None:
            ys = np.array(ys, copy=False)
 
        if weights is not None:
            weights = np.array(weights, copy=False)
 
        bin_edges, bin_labels = self.determine_bin_edgesdetermine_bin_edges(xs,
                                                         stackbys=stackby,
                                                         bins=bins,
                                                         lower_bound=lower_bound,
                                                         upper_bound=upper_bound,
                                                         outlier_z_score=outlier_z_score,
                                                         include_exceptionals=include_exceptionals,
                                                         allow_discrete=allow_discrete)
 
        n_bins = len(bin_edges) - 1
        self.lower_boundlower_bound = bin_edges[0]
        self.upper_boundupper_bound = bin_edges[-1]
        histogram = th1_factory(name, '', n_bins, bin_edges)
 
        if bin_labels:
            get_logger().info("One dimensional plot %s is discrete in x.", name)
            x_taxis = histogram.GetXaxis()
            for i_bin, bin_label in enumerate(bin_labels):
                x_taxis.SetBinLabel(i_bin + 1, bin_label)
            self.add_stats_entryadd_stats_entry(histogram, "dx", 1)
 
        else:
            bin_width = bin_edges[1] - bin_edges[0]
            self.add_stats_entryadd_stats_entry(histogram, "dx", bin_width)
 
        self.createcreate(histogram,
                    xs,
                    ys=ys,
                    weights=weights,
                    stackby=stackby,
                    cumulation_direction=cumulation_direction,
                    reverse_stack=True)
        # Reverse the stack to have the signal distribution at the bottom
 
        # Adjust the discrete bins after the filling to be equidistant
        if bin_labels:
            for histogram in self.histogramshistograms:
                x_taxis = histogram.GetXaxis()
                bin_edges = array.array("d", list(range(len(bin_labels) + 1)))
                x_taxis.Set(n_bins, bin_edges)
 
    def create(self,
               histogram_template,
               xs,
               ys=None,
               weights=None,
               stackby=None,
               cumulation_direction=None,
               reverse_stack=None):
        """Create histograms from a template, possibly stacked"""
 
        histograms = []
 
        if stackby is None:
            histogram = histogram_template
            self.fill_intofill_into(histogram, xs, ys, weights=weights)
            if cumulation_direction is not None:
                histogram = self.cumulatecumulate(histogram, cumulation_direction=cumulation_direction)
 
            histograms.append(histogram)
            plot = histogram
 
        else:
            stackby = np.array(stackby, copy=False)
            name = histogram_template.GetName()
 
            histograms = self.fill_into_groupedfill_into_grouped(histogram_template,
                                                xs,
                                                ys=ys,
                                                weights=weights,
                                                groupbys=stackby,
                                                groupby_label="stack")
 
            if cumulation_direction is not None:
                histograms = [self.cumulatecumulate(histogram, cumulation_direction=cumulation_direction)
                              for histogram in histograms]
 
            plot = self.create_stackcreate_stack(histograms, name=name + "_stacked", reverse_stack=reverse_stack)
 
        self.histogramshistograms = histograms
        self.plotplot = plot
        self.attach_attributesattach_attributes()
 
    @classmethod
    def create_stack(cls, histograms, name, reverse_stack, force_graph=False):
        """Create a stack of histograms"""
        if len(histograms) == 1:
            plot = histograms[0]
        else:
            if isinstance(histograms[0], (ROOT.TProfile, ROOT.TGraph)) or force_graph:
                plot = ROOT.TMultiGraph()
            else:
                plot = ROOT.THStack()
 
            plot.SetName(name)
 
            # Add the histogram in reverse order such
            # that the signal usually is on the bottom an well visible
            if reverse_stack:
                for histogram in reversed(histograms):
                    if isinstance(histogram, ROOT.TProfile) or (isinstance(histogram, ROOT.TH1) and force_graph):
                        histogram = cls.convert_tprofile_to_tgrapherrorsconvert_tprofile_to_tgrapherrors(histogram)
                        plot.Add(histogram, "APZ")
                    else:
                        plot.Add(histogram)
            else:
                for histogram in histograms:
                    if isinstance(histogram, ROOT.TProfile) or (isinstance(histogram, ROOT.TH1) and force_graph):
                        histogram = cls.convert_tprofile_to_tgrapherrorsconvert_tprofile_to_tgrapherrors(histogram)
                        plot.Add(histogram, "APZ")
                    else:
                        plot.Add(histogram)
 
        return plot
 
    @classmethod
    def convert_tprofile_to_tgrapherrors(cls, tprofile, abs_x=False):
        """Extract errors from a TProfile histogram and create a TGraph from these"""
        if isinstance(tprofile, ROOT.TGraph):
            return tprofile
 
        x_taxis = tprofile.GetXaxis()
        n_bins = x_taxis.GetNbins()
 
        # bin_ids_with_underflow = list(range(n_bins + 1))
        bin_ids_without_underflow = list(range(1, n_bins + 1))
 
        bin_centers = np.array([x_taxis.GetBinCenter(i_bin) for i_bin in bin_ids_without_underflow])
        if abs_x:
            bin_centers = np.abs(bin_centers)
        bin_widths = np.array([x_taxis.GetBinWidth(i_bin) for i_bin in bin_ids_without_underflow])
        bin_x_errors = bin_widths / 2.0
 
        # Now for the histogram content not including the underflow
        bin_contents = np.array([tprofile.GetBinContent(i_bin) for i_bin in bin_ids_without_underflow])
        bin_y_errors = np.array([tprofile.GetBinError(i_bin) for i_bin in bin_ids_without_underflow])
 
        tgrapherrors = ROOT.TGraphErrors(n_bins, bin_centers, bin_contents, bin_x_errors, bin_y_errors)
 
        tgrapherrors.GetHistogram().SetOption("APZ")  # <-- This has no effect?
 
        tgrapherrors.SetLineColor(tprofile.GetLineColor())
        tgrapherrors.SetLineColor(tprofile.GetLineColor())
 
        # Copy all functions and stats entries
        for tobject in tprofile.GetListOfFunctions():
            tgrapherrors.GetListOfFunctions().Add(tobject.Clone())
 
        # Add stats entries that are displayed for profile plots
        cls.add_stats_entryadd_stats_entry(tgrapherrors, 'count', tprofile.GetEntries())
 
        stats_values = np.array([np.nan] * 6)
        tprofile.GetStats(stats_values)
 
        sum_w = stats_values[0]
        # sum_w2 = stats_values[1]
        sum_wx = stats_values[2]
        sum_wx2 = stats_values[3]
        sum_wy = stats_values[4]
        sum_wy2 = stats_values[5]
 
        cls.add_stats_entryadd_stats_entry(tgrapherrors,
                            "x avg",
                            sum_wx / sum_w)
 
        cls.add_stats_entryadd_stats_entry(tgrapherrors,
                            "x std",
                            np.sqrt(sum_wx2 * sum_w - sum_wx * sum_wx) / sum_w)
 
        cls.add_stats_entryadd_stats_entry(tgrapherrors,
                            "y avg",
                            sum_wy / sum_w)
 
        cls.add_stats_entryadd_stats_entry(tgrapherrors,
                            "y std",
                            np.sqrt(sum_wy2 * sum_w - sum_wy * sum_wy) / sum_w)
 
        cls.add_stats_entryadd_stats_entry(tgrapherrors,
                            'cov',
                            tgrapherrors.GetCovariance())
 
        cls.add_stats_entryadd_stats_entry(tgrapherrors,
                            'corr',
                            tgrapherrors.GetCorrelationFactor())
 
        return tgrapherrors
 
    def fill_into_grouped(self,
                          histogram_template,
                          xs,
                          ys=None,
                          weights=None,
                          groupbys=None,
                          groupby_label="group"):
        """Fill data into similar histograms in groups indicated by a groupby array"""
 
        histograms = []
        unique_groupbys = np.unique(groupbys)
        name = histogram_template.GetName()
 
        for i_value, value in enumerate(unique_groupbys):
            if np.isnan(value):
                indices_for_value = np.isnan(groupbys)
            else:
                indices_for_value = groupbys == value
 
            # Make a copy of the empty histogram
            histogram_for_value = histogram_template.Clone(name + '_' + str(value))
            i_root_color = i_value + 1
 
            self.set_colorset_color(histogram_for_value, i_root_color)
 
            if groupby_label:
                self.add_stats_entryadd_stats_entry(histogram_for_value, groupby_label, value)
 
            self.fill_intofill_into(histogram_for_value,
                           xs,
                           ys=ys,
                           weights=weights,
                           filter=indices_for_value)
 
            histograms.append(histogram_for_value)
 
        return histograms
 
    def set_color(self, tobject, root_i_color):
        """Set the color of the ROOT object.
 
        By default the line color of a TGraph should be invisible, so do not change it
        For other objects set the marker and the line color
 
        Parameters
        ----------
        tobject : Plotable object inheriting from TAttLine and TAttMarker such as TGraph or TH1
            Object of which the color should be set.
        root_i_color : int
            Color index of the ROOT color table
        """
        if isinstance(tobject, ROOT.TGraph):
            tobject.SetMarkerColor(root_i_color)
        else:
            tobject.SetLineColor(root_i_color)
            tobject.SetMarkerColor(root_i_color)
 
    def fill_into(self, plot, xs, ys=None, weights=None, filter=None):
        """Fill the data into the plot object"""
        if isinstance(plot, ROOT.TGraph):
            if ys is None:
                raise ValueError("ys are required for filling a graph")
            self.fill_into_tgraphfill_into_tgraph(plot, xs, ys, filter=filter)
        elif isinstance(plot, ROOT.TGraphErrors):
            if ys is None:
                raise ValueError("ys are required for filling a graph error")
 
            self.fill_into_tgrapherrorfill_into_tgrapherror(plot, xs, ys)
        else:
            self.fill_into_th1fill_into_th1(plot, xs, ys, weights=weights, filter=filter)
 
    def fill_into_tgrapherror(self, graph, xs, ys, filter=None):
        """fill point values and error of the x and y axis into the graph"""
 
        assert(len(xs[0]) == len(ys[0]))
        # set the overall amount of points
        graph.Set(len(xs[0]))
 
        for i in range(len(xs[0])):
            graph.SetPoint(i, xs[0][i], ys[0][i])
            graph.SetPointError(i, xs[1][i], ys[1][i])
 
    def fill_into_tgraph(self, graph, xs, ys, filter=None):
        """Fill the data into a TGraph"""
 
        # Save some ifs by introducing a dummy slicing as a non filter
        if filter is None:
            filter = slice(None)
 
        xs = xs[filter]
        ys = ys[filter]
 
        max_n_data = 100000
        x_n_data = len(xs)
        y_n_data = len(ys)
 
        if max_n_data:
            if x_n_data > max_n_data or y_n_data > max_n_data:
                get_logger().warning("Number of points in scatter graph %s exceed limit %s" %
                                     (self.namename, max_n_data))
 
                get_logger().warning("Cropping  %s" % max_n_data)
 
                xs = xs[0:max_n_data]
                ys = ys[0:max_n_data]
 
        x_axis = graph.GetXaxis()
        y_axis = graph.GetYaxis()
 
        x_lower_bound = x_axis.GetXmin()
        x_upper_bound = x_axis.GetXmax()
 
        y_lower_bound = y_axis.GetXmin()
        y_upper_bound = y_axis.GetXmax()
 
        x_underflow_indices = xs < x_lower_bound
        x_overflow_indices = xs > x_upper_bound
 
        y_underflow_indices = ys < y_lower_bound
        y_overflow_indices = ys > y_upper_bound
 
        plot_indices = ~(np.isnan(xs) |
                         x_underflow_indices |
                         x_overflow_indices |
                         np.isnan(ys) |
                         y_underflow_indices |
                         y_overflow_indices)
 
        n_plot_data = np.sum(plot_indices)
        plot_xs = xs[plot_indices]
        plot_ys = ys[plot_indices]
 
        graph.Set(int(n_plot_data))
        for i, (x, y) in enumerate(zip(plot_xs, plot_ys)):
            graph.SetPoint(i, x, y)
 
        self.add_stats_entryadd_stats_entry(graph, 'count', np.sum(np.isfinite(xs)))
 
        self.add_nan_inf_statsadd_nan_inf_stats(graph, 'x', xs)
        self.add_nan_inf_statsadd_nan_inf_stats(graph, 'y', ys)
 
        x_n_underflow = np.sum(x_underflow_indices)
        if x_n_underflow:
            self.add_stats_entryadd_stats_entry(graph, 'x underf.', x_n_underflow)
 
        x_n_overflow = np.sum(x_overflow_indices)
        if x_n_overflow:
            self.add_stats_entryadd_stats_entry(graph, 'x overf.', x_n_overflow)
 
        y_n_underflow = np.sum(y_underflow_indices)
        if y_n_underflow:
            self.add_stats_entryadd_stats_entry(graph, 'y underf.', y_n_underflow)
 
        y_n_overflow = np.sum(y_overflow_indices)
        if y_n_overflow:
            self.add_stats_entryadd_stats_entry(graph, 'y overf.', y_n_overflow)
 
        self.add_stats_entryadd_stats_entry(graph, 'x avg', graph.GetMean(1))
        self.add_stats_entryadd_stats_entry(graph, 'x std', graph.GetRMS(1))
 
        self.add_stats_entryadd_stats_entry(graph, 'y avg', graph.GetMean(2))
        self.add_stats_entryadd_stats_entry(graph, 'y std', graph.GetRMS(2))
 
        self.add_stats_entryadd_stats_entry(graph, 'cov', graph.GetCovariance())
        self.add_stats_entryadd_stats_entry(graph, 'corr', graph.GetCorrelationFactor())
 
    def fill_into_th1(self, histogram, xs, ys=None, weights=None, filter=None):
        """Fill the histogram blocking non finite values
 
        Parameters
        ----------
        histogram : ROOT.TH1
            The histogram to be filled
        xs : numpy.ndarray (1d)
            Data for the first axes
        ys : numpy.ndarray (1d), optional
            Data for the second axes
        weights : numpy.ndarray (1d), optional
            Weight of the individual points. Defaults to one for each
        filter : numpy.ndarray, optional
            Boolean index array indicating which entries shall be taken.
        """
        # Save some ifs by introducing a dummy slicing as a non filter
        if filter is None:
            filter = slice(None)
 
        xs = xs[filter]
        # Count the nan and inf values in x
        self.add_nan_inf_statsadd_nan_inf_stats(histogram, 'x', xs)
        finite_filter = np.isfinite(xs)
 
        if ys is not None:
            ys = ys[filter]
            # Count the nan and inf values in y
            self.add_nan_inf_statsadd_nan_inf_stats(histogram, 'y', ys)
            finite_filter &= np.isfinite(ys)
 
        if weights is None:
            xs = xs[finite_filter]
            weights = np.ones_like(xs)
        else:
            weights = weights[filter]
            self.add_nan_inf_statsadd_nan_inf_stats(histogram, 'w', weights)
            finite_filter &= np.isfinite(weights)
            xs = xs[finite_filter]
            weights[finite_filter]
 
        if ys is not None:
            ys = ys[finite_filter]
 
        # Now fill the actual histogram
        try:
            histogram.FillN
        except AttributeError:
            Fill = histogram.Fill
            if ys is None:
                fill = np.frompyfunc(Fill, 2, 1)
                fill(xs.astype(np.float64, copy=False),
                     weights.astype(np.float64, copy=False))
            else:
                fill = np.frompyfunc(Fill, 3, 1)
                fill(xs.astype(np.float64, copy=False),
                     ys.astype(np.float64, copy=False),
                     weights.astype(np.float64, copy=False))
        else:
            if ys is None:
                # Make the array types compatible with the ROOT interface if necessary
                xs = xs.astype(np.float64, copy=False)
                weights = weights.astype(np.float64, copy=False)
                n = len(xs)
                if n != 0:
                    histogram.FillN(n, xs, weights)
                else:
                    basf2.B2WARNING("No values to be filled into histogram: " + self.namename)
 
            else:
                # Make the array types compatible with the ROOT interface if necessary
                xs = xs.astype(np.float64, copy=False)
                ys = ys.astype(np.float64, copy=False)
                weights = weights.astype(np.float64, copy=False)
                n = len(xs)
                if n != 0:
                    histogram.FillN(n, xs, ys, weights)
                else:
                    basf2.B2WARNING("No values to be filled into histogram: " + self.namename)
 
        self.set_additional_stats_tf1set_additional_stats_tf1(histogram)
 
    @classmethod
    def add_nan_inf_stats(cls, histogram, name, xs):
        """ Extracts the counts of non finite floats from a series
        and adds them as additional statistics to the histogram.
 
        Parameters
        ----------
        histogram : derived from ROOT.TH1 or ROOT.TGraph
            Something having a GetListOfFunctions method that
        name : str
            A label for the data series to be prefixed to the entries.
        xs : numpy.ndarray (1d)
            Data from which the non finit floats should be counted.
        """
        n_nans = np.isnan(xs).sum()
        if n_nans > 0:
            cls.add_stats_entryadd_stats_entry(histogram, name + ' nan', n_nans)
 
        n_positive_inf = np.sum(xs == np.inf)
        if n_positive_inf > 0:
            cls.add_stats_entryadd_stats_entry(histogram, name + ' pos inf', n_positive_inf)
 
        n_negative_inf = np.sum(xs == -np.inf)
        if n_negative_inf > 0:
            cls.add_stats_entryadd_stats_entry(histogram, name + ' neg inf', n_negative_inf)
 
    @classmethod
    def add_stats_entry(cls, histogram, label, value):
        """Add a new additional statistics to the histogram.
 
        Parameters
        ----------
        histogram : derived from ROOT.TH1 or ROOT.TGraph
            Something having a GetListOfFunctions method that holds the additional statistics
        label : str
            Label of the statistic
        value : float
            Value of the statistic
        """
        stats_entry = StatsEntry(str(label), float(value))
        histogram.GetListOfFunctions().Add(stats_entry)
        cls.set_additional_stats_tf1set_additional_stats_tf1(histogram)
 
    @classmethod
    def get_additional_stats(cls, histogram):
        """Get the additional statistics from the histogram and return them a dict.
 
        Parameters
        ----------
        histogram : derived from ROOT.TH1 or ROOT.TGraph
            Something having a GetListOfFunctions method that holds the additional statistics
 
        Returns
        -------
        collection.OrderedDict
            A map of labels to values for the additional statistics
        """
        additional_stats = collections.OrderedDict()
        for tobject in histogram.GetListOfFunctions():
            if isinstance(tobject, StatsEntry):
                stats_entry = tobject
                label = stats_entry.GetName()
                value = stats_entry.GetVal()
                additional_stats[label] = value
        return additional_stats
 
    @classmethod
    def gaus_slice_fit(cls, th2, name, z_score=None):
        """Extract a slice of a scatterplot and apply a Gaussian fit to it"""
        # profile = th2.ProfileX(name)
 
        y_taxis = th2.GetYaxis()
        th2_lower_bound = y_taxis.GetXmin()
        th2_upper_bound = y_taxis.GetXmax()
        th2_height = y_taxis.GetXmax() - y_taxis.GetXmin()
        n_y_bins = y_taxis.GetNbins()
        if z_score:
            y_mean = th2.GetMean(2)
            y_std = th2.GetStdDev(2)
            fit_lower_bound = max(th2_lower_bound, y_mean - z_score * y_std)
            fit_upper_bound = min(th2_upper_bound, y_mean + z_score * y_std)
            fit_height = fit_upper_bound - fit_lower_bound
            # Require all covered bins to be filled
            required_n_bins_inslice_filled = n_y_bins * fit_height / th2_height
        else:
            fit_lower_bound = th2_lower_bound
            fit_upper_bound = th2_upper_bound
            fit_height = fit_upper_bound - fit_lower_bound
            required_n_bins_inslice_filled = n_y_bins / 1.61
 
        # Highest required number of bins should be a third
        required_n_bins_inslice_filled = min(required_n_bins_inslice_filled, n_y_bins / 1.61)
 
        fit_tf1 = ROOT.TF1("Fit", "gaus", fit_lower_bound, fit_upper_bound)
        fit_tf1.SetParName(0, "n")
        fit_tf1.SetParName(1, "mean")
        fit_tf1.SetParName(2, "std")
        i_first_bin = 0
        i_last_bin = -1
        fit_options = "QNR"
        param_fit_th1s = ROOT.TObjArray()
        th2.FitSlicesY(fit_tf1, i_first_bin, i_last_bin,
                       int(required_n_bins_inslice_filled),
                       fit_options, param_fit_th1s)
 
        th1_means = param_fit_th1s.At(1)
        th1_means.SetName(name)
        th1_means.SetTitle(th2.GetTitle())
        for label, value in cls.get_additional_statsget_additional_stats(th2).items():
            cls.add_stats_entryadd_stats_entry(th1_means, label, value)
 
        # Manually copy labels grumble grumble
        x_taxis = th2.GetXaxis()
        new_x_taxis = th1_means.GetXaxis()
        for i_bin in range(x_taxis.GetNbins() + 2):
            label = x_taxis.GetBinLabel(i_bin)
            if label != "":
                new_x_taxis.SetBinLabel(i_bin, label)
 
        # Adjust plot bound to reflect the fit range.
        data_lower_bound = th1_means.GetMinimum(fit_lower_bound)
        data_upper_bound = th1_means.GetMaximum(fit_upper_bound)
        data_height = data_upper_bound - data_lower_bound
 
        plot_lower_bound = max(fit_lower_bound, data_lower_bound - 0.05 * data_height)
        plot_upper_bound = min(fit_upper_bound, data_upper_bound + 0.05 * data_height)
 
        th1_means.SetMinimum(plot_lower_bound)
        th1_means.SetMaximum(plot_upper_bound)
 
        return th1_means
 
    @classmethod
    def cumulate(cls, histogram, cumulation_direction=None):
        """Cumulates the histogram inplace.
 
        Parameters
        ----------
        histogram : ROOT.TH1 or ROOT.TProfile
            Filled histogram to be cumulated
        cumulation_direction : int, optional
            Direction is indicated by the sign.
            Positive means from left to right, negative means from right to left.
            If now cumulation direction is given return the histogram as is.
 
        Returns
        -------
        ROOT.TH1
            Cumulated histogram potentially altered inplace.
        """
        if not cumulation_direction:
            return histogram
 
        cumulate_backward = cumulation_direction < 0
        cumulate_forward = not cumulate_backward
 
        if isinstance(histogram, ROOT.TH2):
            raise ValueError("Cannot cumulate a two dimensional histogram.")
 
        if isinstance(histogram, ROOT.TH3):
            raise ValueError("Cannot cumulate a three dimensional histogram.")
 
        if not isinstance(histogram, ROOT.TH1):
            raise ValueError("Can only cumulate a one dimensional histogram.")
 
        if isinstance(histogram, ROOT.TProfile):
            tprofile = histogram
            # Turn the profile histogram into graph where we can set the new content and errors
            tgraph = cls.convert_tprofile_to_tgrapherrorsconvert_tprofile_to_tgrapherrors(histogram)
            tgraph.SetName(tprofile.GetName())
 
            n_bins = histogram.GetNbinsX()
            n_points = n_bins
            cumulated_content = 0.0
            cumulated_entries = 0
            cumulated_std = 0.0
 
            # Always include the overflow bins.
            i_bins = list(range(0, n_bins + 2))
            if not cumulate_forward:
                i_bins = reversed(i_bins)
 
            for i_bin in i_bins:
                i_point = i_bin - 1
                bin_content = tprofile.GetBinContent(i_bin)
                bin_entries = tprofile.GetBinEffectiveEntries(i_bin)
                bin_std = tprofile.GetBinError(i_bin)
 
                if bin_entries != 0:
                    cumulated_content = (
                        1.0 * (cumulated_entries * cumulated_content + bin_entries * bin_content) /
                        (cumulated_entries + bin_entries)
                    )
 
                    cumulated_std = (
                        math.hypot(cumulated_entries * cumulated_std, bin_entries * bin_std) /
                        (cumulated_entries + bin_entries)
                    )
 
                    cumulated_entries = cumulated_entries + bin_entries
                else:
                    # empty bin does not add anything to the cumulation
                    pass
 
                if i_point >= 0 and i_point < n_points:
                    x = tgraph.GetX()[i_point]
                    # x = ROOT.Double()
                    # y = ROOT.Double()
                    # tgraph.GetPoint(i_point, x, y)
                    tgraph.SetPoint(i_point, x, cumulated_content)
 
                    x_error = tgraph.GetErrorX(i_point)
                    tgraph.SetPointError(i_point, x_error, cumulated_std)
            return tgraph
 
        else:
            # Always include the overflow bins.
            n_bins = histogram.GetNbinsX()
            cumulated_content = 0.0
 
            i_bins = list(range(0, n_bins + 2))
            if not cumulate_forward:
                i_bins = reversed(i_bins)
 
            for i_bin in i_bins:
                bin_content = histogram.GetBinContent(i_bin)
                cumulated_content += bin_content
                histogram.SetBinContent(i_bin, cumulated_content)
 
            return histogram
 
    def determine_bin_edges(self,
                            xs,
                            stackbys=None,
                            bins=None,
                            lower_bound=None,
                            upper_bound=None,
                            outlier_z_score=None,
                            include_exceptionals=True,
                            allow_discrete=False):
        """Deducing bin edges from a data series.
 
        Parameters
        ----------
        xs : numpy.ndarray (1d)
            Data point for which a binning should be found.
        stackbys : numpy.ndarray (1d)
            Categories of the data points to be distinguishable
        bins : list(float) or int or None, optional
            Preset bin edges or preset number of desired bins.
            The default, None, means the bound should be extracted from data.
            The rice rule is used the determine the number of bins.
            If a list of floats is given return them immediatly.
        lower_bound : float or None, optional
            Preset lower bound of the binning range.
            The default, None, means the bound should be extracted from data.
        upper_bound : float or None, optional
            Preset upper bound of the binning range.
            The default, None, means the bound should be extracted from data.
        outlier_z_score : float or None, optional
            Threshold z-score of outlier detection.
            The default, None, means no outlier detection.
        include_exceptionals : bool, optional
            If the outlier detection is active this switch indicates,
            if values detected as exceptionally frequent shall be included
            nevertheless into the binning range. Default is True,
            which means exceptionally frequent values as included
            even if they are detected as outliers.
 
        Returns
        -------
        np.array (1d), list(str)
            Pair of bin edges and labels deduced from the series.
            Second element is None if the series is not detected as discrete.
        """
        debug = get_logger().debug
        debug('Determine binning for plot named %s', self.namename)
 
        if bins == 'flat':
            # Special value for the flat distribution binning
            n_bins = None
 
        elif isinstance(bins, collections.Iterable):
            # Bins is considered as an array
            # Construct a float array forwardable to root.
            bin_edges = bins
            bin_edges = array.array('d', bin_edges)
            bin_labels = None
            return bin_edges, bin_labels
 
        # If bins is not an iterable assume it is the number of bins or None
        elif bins is None:
            n_bins = None
        else:
            # Check that bins can be coerced to an integer.
            n_bins = int(bins)
 
            # Do not allow negative bin numbers
            if not n_bins > 0:
                message = 'Cannot accept n_bins=%s as number of bins, because it is not a number greater than 0.' % bins
                raise ValueError(message)
 
        # Coerce values to a numpy array. Do not copy if already a numpy array.
        xs = np.array(xs, copy=False)
 
        if self.is_binaryis_binary(xs) or (allow_discrete and self.is_discreteis_discrete(xs)):
            # This covers also the case
            debug('Discrete binning values encountered')
            finite_xs = xs[np.isfinite(xs)]
            unique_xs = np.unique(finite_xs)
 
            # Crop the unique values between the lower and upper bound
            if lower_bound is None:
                if len(unique_xs) == 0:
                    if upper_bound is None:
                        lower_bound = 0
                    else:
                        lower_bound = upper_bound - 1
                else:
                    lower_bound = np.min(unique_xs)
            else:
                unique_xs = unique_xs[unique_xs >= lower_bound]
 
            if upper_bound is None:
                if len(unique_xs) == 0:
                    upper_bound = lower_bound + 1
                else:
                    upper_bound = np.min(unique_xs)
            else:
                unique_xs = unique_xs[unique_xs <= upper_bound]
 
            if n_bins is None:
                n_bins = len(unique_xs) or 1
 
            if len(unique_xs) > 0 and n_bins >= len(unique_xs):
                # Construct a float array forwardable to root.
                bin_edges = array.array('d', unique_xs)
                format_bin_label = self.format_bin_labelformat_bin_label
                bin_labels = [format_bin_label(value) for value in bin_edges]
                bin_edges.append(bin_edges[-1] + 1)
                return bin_edges, bin_labels
 
            else:
                # Ambiguous case what to do in case of a number of requested bins
                # that is lower than the number of unique values?
 
                # Continue with an equistant binning for now.
                pass
 
            debug('Lower bound %s', lower_bound)
            debug('Upper bound %s', upper_bound)
            debug('N bins %s', n_bins)
 
        else:
            bin_range = self.determine_bin_rangedetermine_bin_range(xs,
                                                 stackbys=stackbys,
                                                 n_bins=n_bins,
                                                 lower_bound=lower_bound,
                                                 upper_bound=upper_bound,
                                                 outlier_z_score=outlier_z_score,
                                                 include_exceptionals=include_exceptionals)
 
            n_bins, lower_bound, upper_bound = bin_range
 
        n_bin_edges = n_bins + 1
        if lower_bound != upper_bound:
            if bins == "flat":
                debug("Creating flat distribution binning")
                precentiles = np.linspace(0.0, 100.0, n_bin_edges)
                bin_edges = np.unique(np.nanpercentile(xs[(lower_bound <= xs) & (xs <= upper_bound)], precentiles))
            else:
                # Correct the upper bound such that all values are strictly smaller than the upper bound
                # Make one step in single precision in the positive direction
                bin_edges = np.linspace(lower_bound, upper_bound, n_bin_edges)
 
            # Reinforce the upper and lower bound to be exact
            # Also expand the upper bound by an epsilon
            # to prevent the highest value in xs from going in the overflow bin
            bin_edges[0] = lower_bound
            bin_edges[-1] = np.nextafter(upper_bound, np.inf)
            debug('Bins %s', bin_edges)
 
        else:
            # Fall back if the array contains only one value
            bin_edges = [lower_bound, upper_bound + 1]
 
        # Construct a float array forwardable to root.
        bin_edges = array.array('d', bin_edges)
        debug('Bins %s for %s', bin_edges, self.namename)
        return bin_edges, None
 
    def determine_bin_range(self,
                            xs,
                            stackbys=None,
                            n_bins=None,
                            lower_bound=None,
                            upper_bound=None,
                            outlier_z_score=None,
                            include_exceptionals=True):
        """Calculates the number of bins, the lower bound and the upper bound from a given data series
        estimating the values that are not given.
 
        If the outlier_z_score is given the method tries to exclude outliers that exceed a certain z-score.
        The z-score is calculated (x - x_mean) / x_std. The be robust against outliers the necessary
        mean and std deviation are based on truncated mean and a trimmed std calculated from the inter
        quantile range (IQR).
 
        If additional include_exceptionals is true the method tries to find exceptional values in the series
        and always include them in the range if it finds any.
        Exceptional values means exact values that appear often in the series for whatever reason.
        Possible reasons include
        * Interal / default values
        * Failed evaluation conditions
        * etc.
        which should be not cropped away automatically if you are locking on the quality of your data.
 
        Parameters
        ----------
        xs : numpy.ndarray (1d)
            Data point for which a binning should be found.
        stackbys : numpy.ndarray (1d)
            Categories of the data points to be distinguishable
        n_bins : int or None, optional
            Preset number of desired bins. The default, None, means the bound should be extracted from data.
            The rice rule is used the determine the number of bins.
        lower_bound : float or None, optional
            Preset lower bound of the binning range.
            The default, None, means the bound should be extracted from data.
        upper_bound : float or None, optional
            Preset upper bound of the binning range.
            The default, None, means the bound should be extracted from data.
        outlier_z_score : float or None, optional
            Threshold z-score of outlier detection.
            The default, None, means no outlier detection.
        include_exceptionals : bool, optional
            If the outlier detection is active this switch indicates,
            if values detected as exceptionally frequent shall be included
            nevertheless into the binning range. Default is True,
            which means exceptionally frequent values as included
            even if they are detected as outliers.
 
        Returns
        -------
        n_bins, lower_bound, upper_bound : int, float, float
            A triple of found number of bins, lower bound and upper bound of the binning range.
        """
 
        if stackbys is not None:
            unique_stackbys = np.unique(stackbys)
            stack_ranges = []
            for value in unique_stackbys:
                if np.isnan(value):
                    indices_for_value = np.isnan(stackbys)
                else:
                    indices_for_value = stackbys == value
 
                stack_lower_bound, stack_upper_bound = \
                    self.determine_rangedetermine_range(xs[indices_for_value],
                                         lower_bound=lower_bound,
                                         upper_bound=upper_bound,
                                         outlier_z_score=outlier_z_score,
                                         include_exceptionals=include_exceptionals)
 
                stack_ranges.append([stack_lower_bound, stack_upper_bound])
 
            lower_bound = np.nanmin([lwb for lwb, upb in stack_ranges])
            upper_bound = np.nanmax([upb for lwb, upb in stack_ranges])
 
        else:
            lower_bound, upper_bound = self.determine_rangedetermine_range(xs,
                                                            lower_bound=lower_bound,
                                                            upper_bound=upper_bound,
                                                            outlier_z_score=outlier_z_score,
                                                            include_exceptionals=include_exceptionals)
 
        if n_bins is None:
            # Assume number of bins according to the rice rule.
            # The number of data points should not include outliers.
            n_data = np.sum((lower_bound <= xs) & (xs <= upper_bound))
            rice_n_bins = int(statistics.rice_n_bin(n_data))
            n_bins = rice_n_bins
 
        else:
            n_bins = int(n_bins)
            # Do not allow negative bin numbers
            if not n_bins > 0:
                message = 'Cannot accept n_bins=%s as number of bins, because it is not a number greater than 0.' % n_bins
                raise ValueError(message)
 
        return n_bins, lower_bound, upper_bound
 
    def determine_range(self,
                        xs,
                        lower_bound=None,
                        upper_bound=None,
                        outlier_z_score=None,
                        include_exceptionals=True):
        """
        Parameters
        ----------
        xs : numpy.ndarray (1d)
            Data point for which a binning should be found.
        lower_bound : float or None, optional
            Preset lower bound of the binning range.
            The default, None, means the bound should be extracted from data.
        upper_bound : float or None, optional
            Preset upper bound of the binning range.
            The default, None, means the bound should be extracted from data.
        outlier_z_score : float or None, optional
            Threshold z-score of outlier detection.
            The default, None, means no outlier detection.
        include_exceptionals : bool, optional
            If the outlier detection is active this switch indicates,
            if values detected as exceptionally frequent shall be included
            nevertheless into the binning range. Default is True,
            which means exceptionally frequent values as included
            even if they are detected as outliers.
 
        Returns
        -------
        lower_bound, upper_bound : float, float
            A pair of found lower bound and upper bound of series.
        """
        debug = get_logger().debug
 
        finite_xs_indices = np.isfinite(xs)
        if np.any(finite_xs_indices):
            finite_xs = xs[finite_xs_indices]
        else:
            finite_xs = xs
 
        make_symmetric = False
        exclude_outliers = outlier_z_score is not None and (lower_bound is None or upper_bound is None)
 
        # Look for exceptionally frequent values in the series, e.g. interal delta values like -999
        if include_exceptionals or exclude_outliers:
            exceptional_xs = self.get_exceptional_valuesget_exceptional_values(finite_xs)
            exceptional_indices = np.in1d(finite_xs, exceptional_xs)
 
        # Prepare for the estimation of outliers
        if exclude_outliers:
            if not np.all(exceptional_indices):
                # Exclude excecptional values from the estimation to be unbiased
                # even in case exceptional values fall into the central region near the mean
                x_mean, x_std = self.get_robust_mean_and_stdget_robust_mean_and_std(finite_xs[~exceptional_indices])
            else:
                x_mean, x_std = np.nan, np.nan
 
            make_symmetric = abs(x_mean) < x_std / 5.0 and lower_bound is None and upper_bound is None
 
        if include_exceptionals and len(exceptional_xs) != 0:
            lower_exceptional_x = np.min(exceptional_xs)
            upper_exceptional_x = np.max(exceptional_xs)
            make_symmetric = False
        else:
            lower_exceptional_x = np.nan
            upper_exceptional_x = np.nan
 
        # Find the lower bound, if it is not given.
        if lower_bound is None:
            try:
                lower_bound = np.min(finite_xs)
            except ValueError:
                lower_bound = -999
            # Clip the lower bound by outliers that exceed the given z score
            if outlier_z_score is not None:
                # The lower bound at which outliers exceed the given z score
                lower_outlier_bound = x_mean - outlier_z_score * x_std
 
                # Clip the lower bound such that it concides with an actual value,
                # which prevents empty bins from being produced
                indices_above_lower_outlier_bound = finite_xs >= lower_outlier_bound
 
                if np.any(indices_above_lower_outlier_bound):
                    lower_bound = np.min(finite_xs[indices_above_lower_outlier_bound])
 
                    # However we want to include at least the exceptional values in the range if there are any.
                    lower_bound = np.nanmin([lower_bound, lower_exceptional_x])
 
                debug('Lower bound after outlier detection')
                debug('Lower bound %s', lower_bound)
                debug('Lower outlier bound %s', lower_outlier_bound)
 
        # Find the upper bound, if it is not given
        if upper_bound is None:
            try:
                upper_bound = np.max(finite_xs)
            except ValueError:
                upper_bound = 999
            if outlier_z_score is not None:
                # The upper bound at which outliers exceed the given z score
                upper_outlier_bound = x_mean + outlier_z_score * x_std
 
                # Clip the upper bound such that it concides with an actual value,
                # which prevents empty bins from being produced
                indices_below_upper_outlier_bound = finite_xs <= upper_outlier_bound
 
                if np.any(indices_below_upper_outlier_bound):
                    upper_bound = np.max(finite_xs[indices_below_upper_outlier_bound])
 
                    # However we want to include at least the exceptional values in the range if there are any.
                    upper_bound = np.nanmax([upper_bound, upper_exceptional_x])
 
                debug('Upper bound after outlier detection')
                debug('Upper bound %s', upper_bound)
                debug('Upper outlier bound %s', upper_outlier_bound)
 
        if make_symmetric and lower_bound < 0 and upper_bound > 0:
            if abs(abs(lower_bound) - abs(upper_bound)) < x_std / 5.0:
                abs_bound = max(abs(lower_bound), abs(upper_bound))
                lower_bound = -abs_bound
                upper_bound = abs_bound
 
        return lower_bound, upper_bound
 
    @classmethod
    def set_additional_stats_tf1(cls, histogram):
        """Combining fit TF1 with the additional statistics and attach them to the histogram.
 
        Parameters
        ----------
        histogram : ROOT.TH1 or ROOT.TGraph or ROOT.TMultiGraph
            Something having a GetListOfFunctions method that should hold
            the combined fit and additional statistics function.
        """
        additional_stats_tf1 = cls.create_additional_stats_tf1create_additional_stats_tf1(histogram)
        cls.set_tf1set_tf1(histogram, additional_stats_tf1)
 
    @classmethod
    def set_fit_tf1(cls, histogram, fit_tf1):
        """Combining fit TF1 with the additional statistics and attach them to the histogram.
 
        Parameters
        ----------
        histogram : ROOT.TH1 or ROOT.TGraph or ROOT.TMultiGraph
            Something having a GetListOfFunctions method that should hold
            the combined fit and additional statistics function.
        """
        additional_stats_tf1 = cls.create_additional_stats_tf1create_additional_stats_tf1(histogram)
        combined_tf1 = cls.combine_fit_and_additional_statscombine_fit_and_additional_stats(fit_tf1, additional_stats_tf1)
        cls.set_tf1set_tf1(histogram, combined_tf1)
 
    @classmethod
    def set_tf1(cls, histogram, tf1):
        """Set the attached TF1 of the histogram.
 
        Parameters
        ----------
        histogram : ROOT.TH1 or ROOT.TGraph or ROOT.TMultiGraph
            Something having a GetListOfFunctions method that should hold
            the combined fit and additional statistics function.
        """
        # Delete any functions formally added
        cls.delete_tf1delete_tf1(histogram)
        if tf1 is not None:
            tf1.SetName("FitAndStats")
            histogram.GetListOfFunctions().Add(tf1)
 
    @classmethod
    def delete_tf1(cls, histogram):
        """Delete the attached TF1 from the histogram
 
        Parameters
        ----------
        histogram : ROOT.TH1 or ROOT.TGraph
            Something having a GetListOfFunctions method that holds the fit function
        """
        tf1 = histogram.FindObject("FitAndStats")
        if tf1:
            function_list = histogram.GetListOfFunctions()
            function_list.Remove(tf1)
 
    @classmethod
    def create_additional_stats_tf1(cls, histogram):
        """Create a TF1 with the additional statistics from the histogram as parameters.
 
        Parameters
        ----------
        histogram : ROOT.TH1 or ROOT.TGraph
            Something having a GetListOfFunctions method that holds the additional statistics.
 
        Returns
        -------
        ROOT.TF1
            Function with the additional statistics as parameters.
        """
 
        additional_stats = cls.get_additional_statsget_additional_stats(histogram)
        if not additional_stats:
            return None
 
        # Create dummy function, which displays additional statistics in the legend, when added to a histogram.
        # Dummy range to serve the functions
        lower_bound = 0
        upper_bound = 0
 
        # Create a formula which is zero in all cases but has space for n parameters
        # Formula string looks like 0*[0]+0*[1]+0*[2]+...
        formula_string = '+'.join('0*[' + str(i) + ']' for i in range(len(additional_stats)))
 
        # Compose a function that carries the addtional information
        additional_stats_tf1 = ROOT.TF1("Stats", formula_string, lower_bound, upper_bound)
 
        for (i, (label, value)) in enumerate(additional_stats.items()):
            # root 6 does not like labels with spaces ..
            # bug report:  https://sft.its.cern.ch/jira/browse/ROOT-7460
            # therefor this workaround:
            label = label.replace(" ", "-")
            additional_stats_tf1.SetParName(i, label)
            additional_stats_tf1.FixParameter(i, value)
 
        return additional_stats_tf1
 
    @classmethod
    def combine_fit_and_additional_stats(cls, fit_tf1, additional_stats_tf1):
        """Combine the fit function and the function carrying the additional statistics to one function.
 
        Parameters
        ----------
        fit_tf1 : ROOT.TF1
            The fit function
        additional_stats_tf1 : ROOT.TF1
            The function carrying the additional statistics as parameters
 
        Returns
        -------
        ROOT.TF1
        """
        if additional_stats_tf1 is None:
            return fit_tf1
 
        # Combine both TF1 functions
        # Get the lower and upper bound of the fit
        # Use the pass-by reference containers from pyROOT to be able to call the function
        lower_bound = ctypes.c_double()
        upper_bound = ctypes.c_double()
        fit_tf1.GetRange(lower_bound, upper_bound)
        title = fit_tf1.GetTitle()
 
        combined_formula = additional_stats_tf1.GetExpFormula().Data() + '+' + fit_tf1.GetExpFormula().Data()
        combined_tf1 = ROOT.TF1("Combined", combined_formula, lower_bound.value, upper_bound.value)
        combined_tf1.SetTitle(title)
 
        # Transfer the fitted parameters
        chi2 = fit_tf1.GetChisquare()
        combined_tf1.SetChisquare(chi2)
 
        ndf = fit_tf1.GetNDF()
        combined_tf1.SetNDF(ndf)
 
        n_stats_parameters = additional_stats_tf1.GetNpar()
        # n_fit_parameters = fit_tf1.GetNpar()
        cls.copy_tf1_parameterscopy_tf1_parameters(additional_stats_tf1, combined_tf1)
        cls.copy_tf1_parameterscopy_tf1_parameters(fit_tf1, combined_tf1, offset=n_stats_parameters)
 
        return combined_tf1
 
    @classmethod
    def copy_tf1_parameters(cls, tf1_source, tf1_target, offset=0):
        """Copy the parameters of one TF1 to  another.
 
        Parameters
        ----------
        tf1_source : ROOT.TF1
            Take parameters from here
        tf1_target : ROOT.TF1
            Copy them to here.
        offset : int, optional
            Index of the first target parameter to which to copy.
        """
        n_parameters = tf1_source.GetNpar()
 
        # Helper variables for pyROOT's mechanism to call functions by reference
        lower_bound = ctypes.c_double()
        upper_bound = ctypes.c_double()
 
        for i_source in range(n_parameters):
            parameter_name = tf1_source.GetParName(i_source)
            i_target = tf1_target.GetParNumber(parameter_name)
 
            # Workaround for a ROOT bug
            if i_target == -1:
                for i_target in range(tf1_target.GetNpar()):
                    if parameter_name == tf1_target.GetParName(i_target):
                        break
                else:
                    i_target = -1
                    continue
 
            tf1_target.SetParameter(i_target,
                                    tf1_source.GetParameter(i_source))
            tf1_target.SetParError(i_target,
                                   tf1_source.GetParError(i_source))
 
            tf1_source.GetParLimits(i_source, lower_bound, upper_bound)
            tf1_target.SetParLimits(i_target, lower_bound.value, upper_bound.value)
 
    def attach_attributes(self):
        """Reassign the special attributes of the plot forwarding them to the ROOT plot."""
        # Forward the attributes to the plot by auto assignment
        
        self.checkcheckcheckcheck = self.checkcheckcheckcheck
        
        self.contactcontactcontactcontact = self.contactcontactcontactcontact
        
        self.descriptiondescriptiondescriptiondescription = self.descriptiondescriptiondescriptiondescription
 
        
        self.xlabelxlabelxlabelxlabel = self.xlabelxlabelxlabelxlabel
        
        self.ylabelylabelylabelylabel = self.ylabelylabelylabelylabel
        
        self.titletitletitletitle = self.titletitletitletitle
 
    def set_maximum(self, maximum):
        """Sets the maximum of the vertical plotable range"""
        for histogram in self.histogramshistograms:
            if isinstance(histogram, ROOT.TH1):
                histogram.SetMaximum(histogram.GetMaximum(maximum))
            else:
                histogram.SetMaximum(maximum)
 
    def set_minimum(self, minimum):
        """Sets the minimum of the vertical plotable range"""
        for histogram in self.histogramshistograms:
            if isinstance(histogram, ROOT.TH1):
                histogram.SetMinimum(histogram.GetMinimum(minimum))
            else:
                histogram.SetMinimum(minimum)
 
    @classmethod
    def set_tstyle(cls):
        """Set the style such that the additional stats entries are shown by the TBrowser"""
        belle2_validation_style_name = "belle2_validation_style"
        belle2_validation_tstyle = ROOT.gROOT.GetStyle(belle2_validation_style_name)
        if not belle2_validation_tstyle:
            belle2_validation_tstyle = ROOT.TStyle(belle2_validation_style_name, belle2_validation_style_name)
 
            opt_fit = 112
            belle2_validation_tstyle.SetOptFit(opt_fit)
 
            opt_stat = 111111
            belle2_validation_tstyle.SetOptStat(opt_stat)
            ROOT.gROOT.SetStyle(belle2_validation_style_name)
 
            # belle2_validation_tstyle.SetLineStyleString(cls.very_sparse_dots_line_style_index, "4 2000")
 
        else:
            belle2_validation_tstyle.cd()
 
 
def test():
    """Simple test method"""
    ValidationPlot.set_tstyle()
 
    # Test a histogram plot with some nan and inf values
    normal_distributed_values = np.random.randn(1000)
 
    for i in range(10):
        normal_distributed_values[i] = np.nan
 
    for i in range(10, 20):
        normal_distributed_values[i] = np.inf
 
    for i in range(20, 30):
        normal_distributed_values[i] = -np.inf
 
    validation_histogram = ValidationPlot('test_hist')
    validation_histogram.hist(normal_distributed_values)
    validation_histogram.title = 'A normal distribution'
    validation_histogram.xlabel = 'normal'
    validation_histogram.ylabel = 'frequency'
    validation_histogram.fit_gaus()
 
    # Test for a cumulated histogram - cumulation from left to right
    cumulated_histogram = ValidationPlot('test_cum_hist')
    cumulated_histogram.hist(normal_distributed_values, cumulation_direction=1)
    cumulated_histogram.title = 'A cumulated normal distribution'
    cumulated_histogram.xlabel = 'normal'
    cumulated_histogram.ylabel = 'cdf'
    cumulated_histogram.show()
 
    # Test stacked histogram
    # Make a random selection of 40%
    stackby = np.random.binomial(1.0, 0.40, 1000)
    stacked_validation_histogram = ValidationPlot('test_stacked_hist')
    stacked_validation_histogram.hist(normal_distributed_values, stackby=stackby)
 
    # Make a scatterplot with two species.
    x = np.random.randn(1000)
    y = 3 * np.random.randn(1000)
    ones = np.ones_like(x)
    angle = np.pi / 2
 
    x1 = np.where(stackby != 0, np.cos(angle) * ones, ones) * x + np.where(stackby != 0, np.sin(angle) * ones, ones) * y
    y1 = np.where(stackby != 0, np.sin(angle) * ones, ones) * x - np.where(stackby != 0, np.cos(angle) * ones, ones) * y
 
    stacked_validation_scatter = ValidationPlot('test_stacked_scatter')
    stacked_validation_scatter.scatter(x1, y1, stackby=stackby)
 
    # Make a profile plot with the two species
    stacked_validation_profile = ValidationPlot('test_stacked_profile')
    stacked_validation_profile.profile(x1, y1, stackby=stackby)
 
    # Make a two dimensional histogram with two species
    stacked_validation_hist2d = ValidationPlot('test_stacked_hist2d')
    stacked_validation_hist2d.hist2d(x1, y1, stackby=stackby)
 
    # Test a profile with a diagonal fit
    x = np.linspace(-1, 1, 1000)
    y = x.copy()
    x[0] = np.nan
    diagonal_plot = ValidationPlot('test_diag')
    diagonal_plot.profile(x, y, bins=50)
    diagonal_plot.fit_line()
 
    # Test if cumulation works for profile plots
    cumulated_profile = ValidationPlot('test_cum_profile')
    cumulated_profile.profile(x, y, bins=50, cumulation_direction=1)
 
    tfile = ROOT.TFile('test.root', 'RECREATE')
 
    validation_histogram.write(tfile)
 
    with root_cd("expert") as tdirectory1:
        diagonal_plot.write(tdirectory1)
        cumulated_profile.write(tdirectory1)
        cumulated_histogram.write(tdirectory1)
 
    with root_cd("stacked") as tdirectory2:
        stacked_validation_histogram.write(tdirectory2)
        stacked_validation_scatter.write()
        stacked_validation_profile.write()
        stacked_validation_hist2d.write()
 
    tfile.Close()
 
    tfile = ROOT.TFile('test.root')
    tBrowser = ROOT.TBrowser()
    tBrowser.BrowseObject(tfile)
    input()
    tfile.Close()
 
 
if __name__ == '__main__':
    test()