ResolutionAnalysis Class Reference

Public Member Functions
def	__init__ (self, quantity_name, bin_spacing, bin_name, bin_unit=None, unit=None, outlier_z_score=None, contact='', plot_name=None, plot_title=None, min_required_entries=None, plot_name_prefix='', plot_name_postfix='', plot_title_postfix='', referenceFileName=None)
def	analyse (self, bin_values, truths, estimates, which_plots=None, is_expert=None)
def	contact (self)
def	contact (self, contact)
def	write (self, tDirectory=None)

Public Attributes
	quantity_name
	cached name of the quantity in the truth-classification analysis
	unit
	cached measurement unit for this truth-classification analysis
	bin_spacing
	cached value of the histogram bin spacing
	bin_name
	cached value of the bin name
	bin_unit
	cached value of the bin measurement unit
	outlier_z_score
	cached value of the Z-score (for outlier detection)
	min_required_entries
	cached value of the minimum number of entries
	plot_name
	cached value of the base name of the plot
	plot_title
	cached value of the plot title
	plot_name_prefix
	cached value of the prefix prepended to the plot name
	plot_name_postfix
	cached value of the suffix appended to the plot name
	plot_title_postfix
	cached value of the suffix appended to the plot title
	plots
	cached value of the dictionary of plots to be created
	referenceFileName
	cached value of the reference filename
	contact
	Forward the contact to all plots by reassigning the contact.

Static Public Attributes
float	default_outlier_z_score = 5.0
	default Z-score (for outlier detection)
int	default_min_required_entries = 50
	default minimum number of entries
str	default_plot_name = "{plot_name_prefix}_{subplot_name}{plot_name_postfix}"
	default plot name
str	default_plot_title = "{subplot_title} of {quantity_name}{plot_title_postfix}"
	default plot title
list	default_which_plots
	default list of plots to create
bool	default_is_expert = True
	by default, create expert plots

Protected Attributes
	_contact
	cached value of the contact person

Detailed Description

Perform resolution analysis

Definition at line 25 of file resolution.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			quantity_name,
			bin_spacing,
			bin_name,
			bin_unit = None,
			unit = None,
			outlier_z_score = None,
			contact = '',
			plot_name = None,
			plot_title = None,
			min_required_entries = None,
			plot_name_prefix = '',
			plot_name_postfix = '',
			plot_title_postfix = '',
			referenceFileName = None
	)

Performs a comparison of an estimated quantity to their truths by generating standardized validation plots.

Definition at line 44 of file resolution.py.

    ):
        """Performs a comparison of an estimated quantity to their truths by generating standardized validation plots."""
 
        
        self.quantity_name = quantity_name
        
        self.unit = unit or get_unit(quantity_name)
        
        self.bin_spacing = bin_spacing
        
        self.bin_name = bin_name
        
        self.bin_unit = bin_unit
 
        if outlier_z_score is None:
            
            self.outlier_z_score = self.default_outlier_z_score
        else:
            self.outlier_z_score = outlier_z_score
 
        
        self.min_required_entries = min_required_entries
        if self.min_required_entries is None:
            self.min_required_entries = self.default_min_required_entries
 
        
        self.plot_name = plot_name
        
        self.plot_title = plot_title
 
        
        self.plot_name_prefix = plot_name_prefix or root_save_name(quantity_name)
        
        self.plot_name_postfix = plot_name_postfix
        
        self.plot_title_postfix = plot_title_postfix
 
        
        self._contact = contact
        
        self.plots = collections.OrderedDict()
 
        
        self.referenceFileName = referenceFileName
 

Member Function Documentation

analyse()

def analyse	(		self,
			bin_values,
			truths,
			estimates,
			which_plots = None,
			is_expert = None
	)

Compares the concrete estimate to the truth and generates plots of the resolution

Parameters
----------
bin_values : array_like(float
    The parameter used for binning
truths : array_like(float)
    Sample of the true values
estimates : array_like(float)
    Corresponding estimations

Definition at line 105 of file resolution.py.

    ):
        """Compares the concrete estimate to the truth and generates plots of the resolution
 
        Parameters
        ----------
        bin_values : array_like(float
            The parameter used for binning
        truths : array_like(float)
            Sample of the true values
        estimates : array_like(float)
            Corresponding estimations
        """
 
        if is_expert is None:
            is_expert = self.default_is_expert
 
        if which_plots is None:
            which_plots = self.default_which_plots
 
        quantity_name = self.quantity_name
 
        # axis_label = compose_axis_label(quantity_name, self.unit)
 
        plot_name_prefix = self.plot_name_prefix
        outlier_z_score = self.outlier_z_score
 
        plot_name = self.plot_name
        if plot_name is None:
            plot_name = self.default_plot_name
 
        plot_name = formatter.format(plot_name,
                                     quantity_name=quantity_name,
                                     plot_name_prefix=plot_name_prefix,
                                     plot_name_postfix=self.plot_name_postfix)
 
        plot_title = self.plot_title
        if plot_title is None:
            plot_title = self.default_plot_title
 
        plot_title = formatter.format(plot_title,
                                      quantity_name=quantity_name,
                                      plot_title_postfix=self.plot_title_postfix)
 
        # compute residuals
        residuals = estimates - truths
 
        # Resolution #
        
        if "resolution" in which_plots:
 
            # creating plots for all configured bins
            res_histogram = []
            resolution_values = []
 
            for i in range(len(self.bin_spacing) - 1):
                lower_bin = self.bin_spacing[i]
                upper_bin = self.bin_spacing[i + 1]
                assert (lower_bin < upper_bin)
                bin_center = lower_bin + (upper_bin - lower_bin) / 2.0
                assert (len(bin_values) == len(residuals))
 
                # compile a list of values which are in this bin
                sel_residuals = collections.deque()
 
                for i in range(len(bin_values)):
                    if bin_values[i] >= lower_bin and bin_values[i] < upper_bin:
                        sel_residuals.append(residuals[i])
 
                residuals_hist_name = formatter.format(plot_name, subplot_name="residuals") + \
                    f"{lower_bin}_to_{upper_bin}"
                vplot = ValidationPlot(residuals_hist_name, self.referenceFileName)
                vplot.hist(sel_residuals,
                           outlier_z_score=outlier_z_score,
                           is_expert=is_expert)
                vplot.xlabel = compose_axis_label("#Delta " + quantity_name + " (estimate - truth)", self.unit)
                vplot.title = formatter.format(plot_title, subplot_title='Residual distribution')
 
                # this values will stay None if no fit could be performed
                gaus_sigma = None
                gaus_sigma_err = None
 
                # check if the minimum number of entries are in the histogram
                if vplot.histograms[0].GetEntries() >= self.min_required_entries:
                    fit_res = vplot.fit_gaus(z_score=1)
 
                    # extract fit result from ROOT's TFitResut
                    params = fit_res.GetParams()
                    errs = fit_res.Errors()
 
                    # gaus_mean = params[1]
                    gaus_sigma = params[2]
                    gaus_sigma_err = errs[2]
 
                    res_histogram += [(lower_bin, upper_bin, bin_center, vplot)]
                    self.plots['residuals' + residuals_hist_name] = vplot
 
                # store the fit results
                resolution_values += [(lower_bin, upper_bin, bin_center, gaus_sigma, gaus_sigma_err)]
 
            resolution_graph_name = formatter.format(plot_name, subplot_name="resolution")
            resolution_graph = ValidationPlot(resolution_graph_name, self.referenceFileName)
 
            # compile all required data going into the final TGraphErrors
            xs = []
            xs_err = []
            ys = []
            ys_err = []
 
            for v in resolution_values:
                # could be None if no fit was possible for this bin
                if v[3]:
                    xs += [v[2]]
                    xs_err = [0.0]
                    ys += [v[3]]
                    ys_err = [v[4]]
 
            # convert to numpy array before giving to the plotting code
            resolution_graph.grapherrors((np.array(xs), np.array(xs_err)), (np.array(ys), np.array(ys_err)),
                                         is_expert=is_expert)
            resolution_graph.xlabel = compose_axis_label(self.bin_name, self.bin_unit)
            resolution_graph.ylabel = compose_axis_label(self.quantity_name, self.unit)
            resolution_graph.title = formatter.format(plot_title, subplot_title='Resolution')
 
            self.plots[resolution_graph_name] = resolution_graph
 
        
        self.contact = self.contact
 

contact() [1/2]

def contact

(

self

)

Get the contact person's name

Definition at line 241 of file resolution.py.

    def contact(self):
        """Get the contact person's name"""
        return self._contact
 

contact() [2/2]

def contact	(		self,
			contact
	)

Set the contact person's name

Definition at line 246 of file resolution.py.

    def contact(self, contact):
        """Set the contact person's name"""
        self._contact = contact
        for validation_plot in list(self.plots.values()):
            validation_plot.contact = contact
 

write()

def write	(		self,
			tDirectory = None
	)

Write all validation plot to the given Root directory

Definition at line 252 of file resolution.py.

    def write(self, tDirectory=None):
        """Write all validation plot to the given Root directory"""
        for validation_plot in list(self.plots.values()):
            validation_plot.write(tDirectory)

Member Data Documentation

_contact

_contact

protected

cached value of the contact person

Definition at line 98 of file resolution.py.

bin_name

bin_name

cached value of the bin name

Definition at line 70 of file resolution.py.

bin_spacing

bin_spacing

cached value of the histogram bin spacing

Definition at line 68 of file resolution.py.

bin_unit

bin_unit

cached value of the bin measurement unit

Definition at line 72 of file resolution.py.

contact

contact

Forward the contact to all plots by reassigning the contact.

Definition at line 238 of file resolution.py.

default_is_expert

bool default_is_expert = True

static

by default, create expert plots

Definition at line 42 of file resolution.py.

default_min_required_entries

int default_min_required_entries = 50

static

default minimum number of entries

Definition at line 31 of file resolution.py.

default_outlier_z_score

float default_outlier_z_score = 5.0

static

default Z-score (for outlier detection)

Definition at line 29 of file resolution.py.

default_plot_name

str default_plot_name = "{plot_name_prefix}_{subplot_name}{plot_name_postfix}"

static

default plot name

Definition at line 33 of file resolution.py.

default_plot_title

str default_plot_title = "{subplot_title} of {quantity_name}{plot_title_postfix}"

static

default plot title

Definition at line 35 of file resolution.py.

default_which_plots

list default_which_plots

static

Initial value:

=  [
        "resolution",
    ]

default list of plots to create

Definition at line 37 of file resolution.py.

min_required_entries

min_required_entries

cached value of the minimum number of entries

Definition at line 81 of file resolution.py.

outlier_z_score

outlier_z_score

cached value of the Z-score (for outlier detection)

Definition at line 76 of file resolution.py.

plot_name

plot_name

cached value of the base name of the plot

Definition at line 86 of file resolution.py.

plot_name_postfix

plot_name_postfix

cached value of the suffix appended to the plot name

Definition at line 93 of file resolution.py.

plot_name_prefix

plot_name_prefix

cached value of the prefix prepended to the plot name

Definition at line 91 of file resolution.py.

plot_title

plot_title

cached value of the plot title

Definition at line 88 of file resolution.py.

plot_title_postfix

plot_title_postfix

cached value of the suffix appended to the plot title

Definition at line 95 of file resolution.py.

plots

plots

cached value of the dictionary of plots to be created

Definition at line 100 of file resolution.py.

quantity_name

quantity_name

cached name of the quantity in the truth-classification analysis

Definition at line 64 of file resolution.py.

referenceFileName

referenceFileName

cached value of the reference filename

Definition at line 103 of file resolution.py.

unit

unit

cached measurement unit for this truth-classification analysis

Definition at line 66 of file resolution.py.

---

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

• tracking/scripts/tracking/validation/resolution.py