PythonVariableManager Class Reference

Public Member Functions
	getVariable (self, *args)
	getVariables (self, *args)
	addAlias (self, alias, variable)
	printAliases (self)
	clearAliases (self)
	resolveAlias (self, alias)
	addCollection (self, *args)
	getCollection (self, collection)
	resolveCollections (self, *args)
	checkDeprecatedVariable (self, variable)
	evaluate (self, variable, particle)
	evaluateVariables (self, variables, plist)
	getNames (self)
	getAliasNames (self)
	assertValidName (self, variable)

Protected Member Functions
	_instance (self)

Detailed Description

Wrapper around the variable manager class.
This is necessary for avoiding to import ROOT globally when 'variables' is imported.

Definition at line 13 of file __init__.py.

Member Function Documentation

_instance()

_instance ( self )

protected

Return an instance to the variable manager.

Definition at line 20 of file __init__.py.

    def _instance(self):
        '''
        Return an instance to the variable manager.
        '''
        # Always avoid the top-level 'import ROOT'.
        import ROOT  # noqa
        instance = ROOT.Belle2.Variable.Manager.Instance()
        return instance
 

addAlias()

addAlias	(		self,
			alias,
			variable )

Wrapper around Manager::addAlias(const std::string& alias, const std::string& variable).

Definition at line 45 of file __init__.py.

    def addAlias(self, alias, variable):
        '''
        Wrapper around Manager::addAlias(const std::string& alias, const std::string& variable).
        '''
        instance = PythonVariableManager._instance()
        if not instance.addAlias(alias, variable):
            raise RuntimeError(f"Failed to add alias '{alias}' for variable '{variable}'")
        return alias
 

addCollection()

addCollection	(		self,
		*	args )

Wrapper around Manager::addCollection(const std::string& collection, const std::vector<std::string>& variables)

Definition at line 75 of file __init__.py.

    def addCollection(self, *args):
        '''
        Wrapper around Manager::addCollection(const std::string& collection, const std::vector<std::string>& variables)
        '''
        instance = PythonVariableManager._instance()
        if not instance.addCollection(*args):
            raise RuntimeError(f"Failed to add collection with args: {args}")
 

assertValidName()

assertValidName	(		self,
			variable )

Wrapper around Manager::assertValidName(const std::string& name).

Definition at line 132 of file __init__.py.

    def assertValidName(self, variable):
        '''
        Wrapper around Manager::assertValidName(const std::string& name).
        '''
        instance = PythonVariableManager._instance()
        instance.assertValidName(variable)
 
 

checkDeprecatedVariable()

checkDeprecatedVariable	(		self,
			variable )

Wrapper around Manager::checkDeprecatedVariable(const std::string& name).

Definition at line 97 of file __init__.py.

    def checkDeprecatedVariable(self, variable):
        '''
        Wrapper around Manager::checkDeprecatedVariable(const std::string& name).
        '''
        instance = PythonVariableManager._instance()
        instance.checkDeprecatedVariable(variable)
 

clearAliases()

clearAliases

(

self

)

Wrapper around Manager::clearAliases().

Definition at line 61 of file __init__.py.

    def clearAliases(self):
        '''
        Wrapper around Manager::clearAliases().
        '''
        instance = PythonVariableManager._instance()
        instance.clearAliases()
 

evaluate()

evaluate	(		self,
			variable,
			particle )

Wrapper around Manager::evaluate(const std::string& varName, const Particle* p).

Definition at line 104 of file __init__.py.

    def evaluate(self, variable, particle):
        '''
        Wrapper around Manager::evaluate(const std::string& varName, const Particle* p).
        '''
        instance = PythonVariableManager._instance()
        return instance.evaluate(variable, particle)
 

evaluateVariables()

evaluateVariables	(		self,
			variables,
			plist )

Wrapper around Manager::evaluateVariables(const std::vector<std::string>& varNames, const ParticleList* plist).

Definition at line 111 of file __init__.py.

    def evaluateVariables(self, variables, plist):
        '''
        Wrapper around Manager::evaluateVariables(const std::vector<std::string>& varNames, const ParticleList* plist).
        '''
        instance = PythonVariableManager._instance()
        return instance.evaluateVariables(variables, plist.obj())
 

getAliasNames()

getAliasNames

(

self

)

Wrapper around Manager::getAliasNames().

Definition at line 125 of file __init__.py.

    def getAliasNames(self):
        '''
        Wrapper around Manager::getAliasNames().
        '''
        instance = PythonVariableManager._instance()
        return instance.getAliasNames()
 

getCollection()

getCollection	(		self,
			collection )

Wrapper around Manager::getCollection(const std::string& collection).

Definition at line 83 of file __init__.py.

    def getCollection(self, collection):
        '''
        Wrapper around Manager::getCollection(const std::string& collection).
        '''
        instance = PythonVariableManager._instance()
        return instance.getCollection(collection)
 

getNames()

getNames

(

self

)

Wrapper around Manager::getNames().

Definition at line 118 of file __init__.py.

    def getNames(self):
        '''
        Wrapper around Manager::getNames().
        '''
        instance = PythonVariableManager._instance()
        return instance.getNames()
 

getVariable()

getVariable	(		self,
		*	args )

Wrapper around Manager::getVariable(std::string name) and
Manager::getVariable(const std::string& functionName, const std::vector<std::string>& functionArguments).

Definition at line 29 of file __init__.py.

    def getVariable(self, *args):
        '''
        Wrapper around Manager::getVariable(std::string name) and
        Manager::getVariable(const std::string& functionName, const std::vector<std::string>& functionArguments).
        '''
        instance = PythonVariableManager._instance()
        return instance.getVariable(*args)
 

getVariables()

getVariables	(		self,
		*	args )

Wrapper around Manager::getVariables(const std::vector<std::string>& variables) and
Manager::getVariables().

Definition at line 37 of file __init__.py.

    def getVariables(self, *args):
        '''
        Wrapper around Manager::getVariables(const std::vector<std::string>& variables) and
        Manager::getVariables().
        '''
        instance = PythonVariableManager._instance()
        return instance.getVariables(*args)
 

printAliases()

printAliases

(

self

)

Wrapper around Manager::printAliases().

Definition at line 54 of file __init__.py.

    def printAliases(self):
        '''
        Wrapper around Manager::printAliases().
        '''
        instance = PythonVariableManager._instance()
        instance.printAliases()
 

resolveAlias()

resolveAlias	(		self,
			alias )

Wrapper around Manager::resolveAlias(const std::string& alias).

Definition at line 68 of file __init__.py.

    def resolveAlias(self, alias):
        '''
        Wrapper around Manager::resolveAlias(const std::string& alias).
        '''
        instance = PythonVariableManager._instance()
        return instance.resolveAlias(alias)
 

resolveCollections()

resolveCollections	(		self,
		*	args )

Wrapper around Manager::resolveCollections(const std::vector<std::string>& variables).

Definition at line 90 of file __init__.py.

    def resolveCollections(self, *args):
        '''
        Wrapper around Manager::resolveCollections(const std::vector<std::string>& variables).
        '''
        instance = PythonVariableManager._instance()
        return instance.resolveCollections(*args)
 

---

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

• analysis/scripts/variables/__init__.py