ValidationMetadataSetter Class Reference

Inheritance diagram for ValidationMetadataSetter:

Public Member Functions
	__init__ (self, List[Tuple[str]] variables, Union[str, pathlib.PurePath] rootfile, description="")
	initialize (self)
	terminate (self)

Protected Attributes
	_variables = variables
	Remember the metadata.
str	_rootfile = rootfile
	And the name of the root file.
	_description = description
	Common description/information of/about all plots in this ROOT file (will be displayed above the plots)
ROOT.TFile	_tfile = None
	Shared pointer to the root file that will be closed when the last user disconnects.

Detailed Description

Simple module to set the valdiation metadata for a given list of objects
automatically at the end of event processing

Just add this module **before** any
VariablesToNtuple/VariablesToHistogram modules and it will set the
correct validation metadata at the end of processing

Warning:
    The module needs to be before the modules creating the objects
    as terminate() functions are executed in reverse order from last to
    first module.  If this module is after the creation modules the metadata
    might not be set correctly

Definition at line 191 of file metadata.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
		List[Tuple[str]]	variables,
		Union[str, pathlib.PurePath]	rootfile,
			description = "" )

Initialize ValidationMetadataSetter

Arguments:
    variables (list(tuple(str))): List of objects to set the metadata
        for. Each entry should be the name of an object followed by the
        metadata values which will be forwarded to
        `validation_metadata_set`:
        ``(name, title, contact, description, check, xlabel, ylabel,
        metaoptions)``
        where ``xlabel``, ``ylabel`` and ``metaoptions`` are optional
    rootfile (str or pathlib.PurePath): The name of the ROOT file where
        the objects can be found
    description (str): Common description/information of/about all plots
        in this ROOT file (will be displayed above the plots)

Definition at line 207 of file metadata.py.

    ):
        """
        Initialize ValidationMetadataSetter
 
        Arguments:
            variables (list(tuple(str))): List of objects to set the metadata
                for. Each entry should be the name of an object followed by the
                metadata values which will be forwarded to
                `validation_metadata_set`:
                ``(name, title, contact, description, check, xlabel, ylabel,
                metaoptions)``
                where ``xlabel``, ``ylabel`` and ``metaoptions`` are optional
            rootfile (str or pathlib.PurePath): The name of the ROOT file where
                the objects can be found
            description (str): Common description/information of/about all plots
                in this ROOT file (will be displayed above the plots)
        """
        super().__init__()
        
        self._variables = variables
        if isinstance(rootfile, pathlib.PurePath):
            rootfile = str(rootfile)
        
        self._rootfile: str = rootfile
        
        self._description = description
        
        self._tfile: ROOT.TFile = None
 

Member Function Documentation

initialize()

initialize

(

self

)

Make sure we keep the file open

Definition at line 243 of file metadata.py.

    def initialize(self):
        """Make sure we keep the file open"""
        self._tfile = Belle2.RootFileCreationManager.getInstance().getFile(
            self._rootfile
        )
 

terminate()

terminate

(

self

)

And update the metadata at the end

Definition at line 249 of file metadata.py.

    def terminate(self):
        """And update the metadata at the end"""
        for name, *metadata in self._variables:
            name = Belle2.MakeROOTCompatible.makeROOTCompatible(name)
            validation_metadata_update(self._tfile, name, *metadata)
        if self._description:
            file_description_set(self._tfile, self._description)
        del self._tfile
 
 

Member Data Documentation

_description

_description = description

protected

Common description/information of/about all plots in this ROOT file (will be displayed above the plots)

Definition at line 238 of file metadata.py.

_rootfile

str _rootfile = rootfile

protected

And the name of the root file.

Definition at line 235 of file metadata.py.

_tfile

_tfile = None

protected

Shared pointer to the root file that will be closed when the last user disconnects.

Definition at line 241 of file metadata.py.

_variables

_variables = variables

protected

Remember the metadata.

Definition at line 231 of file metadata.py.

---

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

• validation/scripts/validation_tools/metadata.py