TrackVariable Class Reference

Public Member Functions
def	__init__ (self, name1, name2, latex, unit, plaintext)
def	getName (self)

Public Attributes
	name1
	ROOT branch name for the first track.
	name2
	ROOT branch name for the second track.
	latex
	LaTeX string for axis labels.
	unit
	Unit descriptor for plotting and residuals.
	plaintext
	Plain-text identifier for file naming.

Detailed Description

Metadata for an observable with one ROOT branch per track.

Used for two-track events (cosmics, dimuons) where each track has its
own branch.

Parameters
----------
name1 : str
    ROOT branch name for the first track.
name2 : str
    ROOT branch name for the second track.
latex : str
    LaTeX string for axis labels (e.g. ``r"d$_0$"``).
unit : Unit
    Unit instance describing display and residual units.
plaintext : str
    Short plain-text identifier used for file names (e.g. ``"d"``).

Definition at line 96 of file variables.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			name1,
			name2,
			latex,
			unit,
			plaintext
	)

Initialize a two-track variable description.

Parameters
----------
name1 : str
    ROOT branch name for the first track.
name2 : str
    ROOT branch name for the second track.
latex : str
    LaTeX string for axis labels.
unit : Unit
    Unit instance describing display and residual units.
plaintext : str
    Short plain-text identifier used for file names.

Definition at line 116 of file variables.py.

    def __init__(self, name1, name2, latex, unit, plaintext):
        """Initialize a two-track variable description.
 
        Parameters
        ----------
        name1 : str
            ROOT branch name for the first track.
        name2 : str
            ROOT branch name for the second track.
        latex : str
            LaTeX string for axis labels.
        unit : Unit
            Unit instance describing display and residual units.
        plaintext : str
            Short plain-text identifier used for file names.
        """
        
        self.name1 = name1
        
        self.name2 = name2
        
        self.latex = latex
        
        self.unit = unit
        
        self.plaintext = plaintext
 

Member Function Documentation

getName()

def getName

(

self

)

Return a list of both ROOT branch names (track 1 then track 2).

Returns
-------
list of str

Definition at line 143 of file variables.py.

    def getName(self):
        """Return a list of both ROOT branch names (track 1 then track 2).
 
        Returns
        -------
        list of str
        """
        return [self.name1, self.name2]
 
 
# Unit instances

Member Data Documentation

latex

latex

LaTeX string for axis labels.

Definition at line 137 of file variables.py.

name1

name1

ROOT branch name for the first track.

Definition at line 133 of file variables.py.

name2

name2

ROOT branch name for the second track.

Definition at line 135 of file variables.py.

plaintext

plaintext

Plain-text identifier for file naming.

Definition at line 141 of file variables.py.

unit

unit

Unit descriptor for plotting and residuals.

Definition at line 139 of file variables.py.

---

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

• alignment/scripts/alignment_validation/variables.py