python.atlas_oh.OHOutputModule Class Reference

Inheritance diagram for python.atlas_oh.OHOutputModule:

Collaboration diagram for python.atlas_oh.OHOutputModule:

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
	provider
	partition
	prefix
	queue

Detailed Description

Definition at line 117 of file atlas_oh.py.

Constructor & Destructor Documentation

__init__()

def python.atlas_oh.OHOutputModule.__init__

(

self

)

Definition at line 118 of file atlas_oh.py.

    def __init__(self):
        self.target = None
 

Member Function Documentation

configure()

None python.atlas_oh.OHOutputModule.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 121 of file atlas_oh.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()).
        """
        import oh
        import ispy
        if 'target' not in options:
            raise ValueError("Must specify 'target' as an option "
                             "to OHInputModule")
        self.target = options['target']
        self.partition, self.server, self.provider = self.target.split(';')
        self.partition = ispy.IPCPartition(self.partition)
        if not self.partition.isValid():
            raise ValueError(f'Output partition {self.partition.name()} is not valid')
        self.prefix = options.get('prefix', '')
        self.provider = oh.OHRootProvider(self.partition,
                                        self.server, self.provider, None)
        self.queue = set()
        log = logging.getLogger(self.__class__.__name__)
        log.info(f'Using target {self.target}')
 

finalize()

None python.atlas_oh.OHOutputModule.finalize

(

self

)

Writes outstanding HistObjects to file 

Definition at line 157 of file atlas_oh.py.

    def finalize(self) -> None:
        """ Writes outstanding HistObjects to file """
        pass
 
 

publish()

None python.atlas_oh.OHOutputModule.publish	(		self,
		Union[HistObject, Iterable[HistObject]]	obj
	)

Accepts a HistObject containing a ROOT object to write to file 

Definition at line 148 of file atlas_oh.py.

    def publish(self, obj: Union[HistObject, Iterable[HistObject]]) -> None:
        """ Accepts a HistObject containing a ROOT object to write to file """
        import os
        if isinstance(obj, HistObject):
            obj = [obj]
 
        for o in obj:
            self.provider.publish(o.hist, os.path.join(self.prefix, o.name))
 

Member Data Documentation

partition

python.atlas_oh.OHOutputModule.partition

Definition at line 138 of file atlas_oh.py.

prefix

python.atlas_oh.OHOutputModule.prefix

Definition at line 141 of file atlas_oh.py.

provider

python.atlas_oh.OHOutputModule.provider

Definition at line 137 of file atlas_oh.py.

queue

python.atlas_oh.OHOutputModule.queue

Definition at line 144 of file atlas_oh.py.

target

python.atlas_oh.OHOutputModule.target

Definition at line 119 of file atlas_oh.py.

---

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

• atlas_oh.py