GlobalVariable Class Reference

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

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

Detailed Description

Metadata for a scalar observable stored in a single ROOT branch per event.

Parameters
----------
name : str
    ROOT branch name.
latex : str
    LaTeX string for axis labels (e.g. ``r"$M_{inv}$"``).
unit : Unit
    Unit instance describing display and residual units.
plaintext : str
    Short plain-text identifier used for file names (e.g. ``"run"``).

Definition at line 48 of file variables.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			name,
			latex,
			unit,
			plaintext
	)

Initialize a global variable description.

Parameters
----------
name : str
    ROOT branch name.
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 63 of file variables.py.

    def __init__(self, name, latex, unit, plaintext):
        """Initialize a global variable description.
 
        Parameters
        ----------
        name : str
            ROOT branch name.
        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.name = name
        
        self.latex = latex
        
        self.unit = unit
        
        self.plaintext = plaintext
 

Member Function Documentation

getName()

def getName

(

self

)

Return a list containing the single ROOT branch name.

Returns
-------
list of str

Definition at line 86 of file variables.py.

    def getName(self):
        """Return a list containing the single ROOT branch name.
 
        Returns
        -------
        list of str
        """
        return [self.name]
 
 

Member Data Documentation

latex

latex

LaTeX string for axis labels.

Definition at line 80 of file variables.py.

name

name

ROOT branch name.

Definition at line 78 of file variables.py.

plaintext

plaintext

Plain-text identifier for file naming.

Definition at line 84 of file variables.py.

unit

unit

Unit descriptor for plotting and residuals.

Definition at line 82 of file variables.py.

---

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

• alignment/scripts/alignment_validation/variables.py