python.DQPostProcessingAlg.AthOutputModule Class Reference

Inheritance diagram for python.DQPostProcessingAlg.AthOutputModule:

Collaboration diagram for python.DQPostProcessingAlg.AthOutputModule:

Public Member Functions
def	__init__ (self)
None	configure (self, Mapping[str, Any] options)
None	publish (self, Union[HistObject, Iterable[HistObject]] obj)
None	finalize (self)

Public Attributes
	target
	overwrite
	prefix
	delay
	queue

Private Member Functions
None	_write (self)

Private Attributes
	_hsvc_funcs

Detailed Description

Definition at line 226 of file DQPostProcessingAlg.py.

Constructor & Destructor Documentation

__init__()

def python.DQPostProcessingAlg.AthOutputModule.__init__

(

self

)

Definition at line 227 of file DQPostProcessingAlg.py.

    def __init__(self):
        self.target = None
 

Member Function Documentation

_write()

None python.DQPostProcessingAlg.AthOutputModule._write (   self )

private

write obj to THistSvc 

Definition at line 274 of file DQPostProcessingAlg.py.

    def _write(self) -> None:
        """ write obj to THistSvc """
        import ROOT
        import os.path
        if not self.queue:
            return  # Nothing to do
        log = self.target.msg
        hsvc = self.target.hsvc
        for _, o in self.queue.items():
            fulltargetname = os.path.join(self.prefix, o.name) % { 'run': self.target._run }
            log.debug(f"Attempt to publish {fulltargetname} of type {type(o.hist)}")
            # it would be perverse if the type of the postprocessing output changed
            # between invocations and we will not consider it
            if isinstance(o.hist, ROOT.TH1):
                funcs = self._hsvc_funcs['hist']
                parenttype = ROOT.TH1
            elif isinstance(o.hist, ROOT.TGraph):
                funcs = self._hsvc_funcs['graph']
                parenttype = ROOT.TGraph
            elif isinstance(o.hist, ROOT.TEfficiency):
                funcs = self._hsvc_funcs['eff']
                parenttype = ROOT.TEfficiency
            else:
                log.warning(f'Do not know how to handle object {fulltargetname} of type {type(o.hist)}; skipping')
                continue
            o.hist.SetName(os.path.basename(fulltargetname))
            if funcs['exists'](fulltargetname):
                # following kind of silly procedure is necessary to avoid memory leaks
                hptr = ROOT.MakeNullPointer(parenttype)
                if funcs['get'](fulltargetname, hptr).isSuccess():
                    hsvc.deReg(hptr)
                    ROOT.SetOwnership(hptr, True) # clean up the histogram from our side
            if not funcs['reg'](fulltargetname, o.hist).isSuccess():
                log.error(f"Unable to register {fulltargetname}")
            else:
                ROOT.SetOwnership(o.hist, False)
                log.debug("Published")
        self.queue.clear()
 

configure()

None python.DQPostProcessingAlg.AthOutputModule.configure	(		self,
		Mapping[str, Any]	options
	)

Configure this module. Potential elements of "options":
target: should be a ROOT-openable filename or URL which
    can be opened for writing.
prefix: directory path to place results under.
overwrite: boolean to indicate whether results should overwrite
    existing histograms in the file.
delay: only write histograms in finalize() (not during publish()).

Definition at line 230 of file DQPostProcessingAlg.py.

    def configure(self, options: Mapping[str, Any]) -> None:
        """
        Configure this module. Potential elements of "options":
        target: should be a ROOT-openable filename or URL which
            can be opened for writing.
        prefix: directory path to place results under.
        overwrite: boolean to indicate whether results should overwrite
            existing histograms in the file.
        delay: only write histograms in finalize() (not during publish()).
        """
        if 'target' not in options:
            raise ValueError("Must specify 'target' as an option "
                             "to AthInputModule")
        self.target = options['target']
        self.overwrite = bool(options.get('overwrite', True))
        self.prefix = options.get('prefix', '/')
        self.delay = bool(options.get('delay', True))
        self.queue: Optional[Dict[str, HistObject]] = {}
        self._hsvc_funcs = {'hist': { 'exists': self.target.hsvc.existsHist,
                                      'get': self.target.hsvc.getHist,
                                      'reg': self.target.hsvc._cpp_regHist },
                            'graph': { 'exists': self.target.hsvc.existsGraph,
                                       'get': self.target.hsvc.getGraph,
                                       'reg': self.target.hsvc._cpp_regGraph },
                            'eff': { 'exists': self.target.hsvc.existsEfficiency,
                                     'get': self.target.hsvc.getEfficiency,
                                     'reg': self.target.hsvc._cpp_regEfficiency },
                            }
 

finalize()

None python.DQPostProcessingAlg.AthOutputModule.finalize

(

self

)

Outputs outstanding HistObjects 

Definition at line 313 of file DQPostProcessingAlg.py.

    def finalize(self) -> None:
        """ Outputs outstanding HistObjects """
        self._write()

publish()

None python.DQPostProcessingAlg.AthOutputModule.publish	(		self,
		Union[HistObject, Iterable[HistObject]]	obj
	)

Accepts a HistObject containing a ROOT object to write to file 

Definition at line 259 of file DQPostProcessingAlg.py.

    def publish(self, obj: Union[HistObject, Iterable[HistObject]]) -> None:
        """ Accepts a HistObject containing a ROOT object to write to file """
        if isinstance(obj, HistObject):
            obj = [obj]
        d_obj = { _.name: _ for _ in obj }
        if self.delay:
            if not self.queue:
                self.queue = d_obj
            else:
                self.queue.update(d_obj)
        else:
            self.queue = d_obj
            self._write()
            self.queue = None
 

Member Data Documentation

_hsvc_funcs

python.DQPostProcessingAlg.AthOutputModule._hsvc_funcs

private

Definition at line 248 of file DQPostProcessingAlg.py.

delay

python.DQPostProcessingAlg.AthOutputModule.delay

Definition at line 246 of file DQPostProcessingAlg.py.

overwrite

python.DQPostProcessingAlg.AthOutputModule.overwrite

Definition at line 244 of file DQPostProcessingAlg.py.

prefix

python.DQPostProcessingAlg.AthOutputModule.prefix

Definition at line 245 of file DQPostProcessingAlg.py.

queue

python.DQPostProcessingAlg.AthOutputModule.queue

Definition at line 266 of file DQPostProcessingAlg.py.

target

python.DQPostProcessingAlg.AthOutputModule.target

Definition at line 228 of file DQPostProcessingAlg.py.

---

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

• DQPostProcessingAlg.py