ClassificationAnalysis Class Reference

Inheritance diagram for ClassificationAnalysis:

Collaboration diagram for ClassificationAnalysis:

Public Member Functions
def	__init__ (self, contact, quantity_name, cut_direction=None, cut=None, lower_bound=None, upper_bound=None, outlier_z_score=None, allow_discrete=None, unit=None)
def	analyse (self, estimates, truths, auxiliaries={})
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
	plots
	cached dictionary of plots in the truth-classification analysis
	fom
	cached value of the figure of merit in the truth-classification analysis
	cut_direction
	cached value of the cut direction (< or >) in the truth-classification analysis
	cut
	cached value of the threshold in the truth-classification analysis
	lower_bound
	cached lower bound for this truth-classification analysis
	upper_bound
	cached upper bound for this truth-classification analysis
	outlier_z_score
	cached Z-score (for outlier detection) for this truth-classification analysis
	allow_discrete
	cached discrete-value flag for this truth-classification analysis
	unit
	cached measurement unit for this truth-classification analysis
	contact
	contact person

Private Attributes
	_contact
	cached contact person of the truth-classification analysis

Detailed Description

Perform truth-classification analysis

Definition at line 19 of file classification.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			contact,
			quantity_name,
			cut_direction = None,
			cut = None,
			lower_bound = None,
			upper_bound = None,
			outlier_z_score = None,
			allow_discrete = None,
			unit = None
	)

Compare an estimated quantity to the truths by generating standardized validation plots.

Definition at line 22 of file classification.py.

    def __init__(
        self,
        contact,
        quantity_name,
        cut_direction=None,
        cut=None,
        lower_bound=None,
        upper_bound=None,
        outlier_z_score=None,
        allow_discrete=None,
        unit=None
    ):
        """Compare an estimated quantity to the truths by generating standardized validation plots."""
 
        
        self._contact = contact
        
        self.quantity_name = quantity_name
 
        
        self.plots = collections.OrderedDict()
        
        self.fom = None
 
        
        self.cut_direction = cut_direction
        
        self.cut = cut
 
        
        self.lower_bound = lower_bound
        
        self.upper_bound = upper_bound
        
        self.outlier_z_score = outlier_z_score
        
        self.allow_discrete = allow_discrete
        
        self.unit = unit
 

Member Function Documentation

analyse()

def analyse	(		self,
			estimates,
			truths,
			auxiliaries = {}
	)

Compares the concrete estimate to the truth and efficiency, purity and background rejection
as figure of merit and plots the selection as a stacked plot over the truths.

Parameters
----------
estimates : array_like
    Selection variable to compare to the truths
truths : array_like
    Binary true class values.

Definition at line 62 of file classification.py.

contact() [1/2]

def contact

(

self

)

Get the name of the contact person

Definition at line 470 of file classification.py.

contact() [2/2]

def contact	(		self,
			contact
	)

Set the name of the contact person

Definition at line 475 of file classification.py.

write()

def write	(		self,
			tdirectory = None
	)

Write the plots to the ROOT TDirectory

Definition at line 485 of file classification.py.

---

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

• tracking/scripts/tracking/validation/classification.py