python.AsgAnalysisConfig.EventCutFlowBlock Class Reference

Inheritance diagram for python.AsgAnalysisConfig.EventCutFlowBlock:

Collaboration diagram for python.AsgAnalysisConfig.EventCutFlowBlock:

Public Member Functions
	__init__ (self)
	instanceName (self)
	makeAlgs (self, config)

Public Attributes
	customSelections
	selectionName

Detailed Description

the ConfigBlock for an event-level cutflow

Definition at line 616 of file AsgAnalysisConfig.py.

Constructor & Destructor Documentation

__init__()

python.AsgAnalysisConfig.EventCutFlowBlock.__init__

(

self

)

Definition at line 619 of file AsgAnalysisConfig.py.

    def __init__ (self) :
        super (EventCutFlowBlock, self).__init__ ()
        self.addOption ('containerName', '', type=str,
            noneAction='error',
            info="the name of the input container, typically EventInfo.")
        self.addOption ('selectionName', '', type=str,
            noneAction='error',
            info="the name of an optional selection decoration to use.")
        self.addOption ('customSelections', [], type=None,
            info="the selections for which to generate cutflow histograms. If "
            "a single string, corresponding to a particular event selection, "
            "the event cutflow for that selection will be looked up. If a list "
            "of strings, will use explicitly those selections. If left blank, "
            "all selections attached to the container will be looked up.")
        self.addOption ('postfix', '', type=str,
            info="a postfix to apply in the naming of cutflow histograms. Set "
            "it when defining multiple cutflows.")
 

Member Function Documentation

instanceName()

python.AsgAnalysisConfig.EventCutFlowBlock.instanceName

(

self

)

Return the instance name for this block

Definition at line 637 of file AsgAnalysisConfig.py.

    def instanceName (self) :
        """Return the instance name for this block"""
        return self.containerName + '_' + self.selectionName + self.postfix
 

makeAlgs()

python.AsgAnalysisConfig.EventCutFlowBlock.makeAlgs	(		self,
			config )

Definition at line 641 of file AsgAnalysisConfig.py.

    def makeAlgs (self, config) :
 
        postfix = self.postfix
        if postfix != '' and postfix[0] != '_' :
            postfix = '_' + postfix
 
        alg = config.createAlgorithm( 'CP::EventCutFlowHistAlg', 'CutFlowDumperAlg' )
        alg.histPattern = 'cflow_' + self.containerName + "_" + self.selectionName + postfix + '_%SYS%'
        # find out which selection decorations to use
        if isinstance(self.customSelections, str):
            # user provides a dynamic reference to selections, corresponding to an EventSelection alg
            alg.selections = config.getEventCutFlow(self.customSelections)
        elif len(self.customSelections) > 0:
            # user provides a list of hardcoded selections
            alg.selections = self.customSelections
        else:
            # user provides nothing: get all available selections from EventInfo directly
            alg.selections = config.getSelectionCutFlow (self.containerName, self.selectionName)
        alg.selections = [sel+',as_char' for sel in alg.selections]
        if self.selectionName:
            alg.preselection = self.selectionName + '_%SYS%'
        alg.eventInfo = config.readName (self.containerName)
        alg.histTitle = "Event Cutflow: " + self.containerName + "." + self.selectionName
 
 

Member Data Documentation

customSelections

python.AsgAnalysisConfig.EventCutFlowBlock.customSelections

Definition at line 650 of file AsgAnalysisConfig.py.

selectionName

python.AsgAnalysisConfig.EventCutFlowBlock.selectionName

Definition at line 660 of file AsgAnalysisConfig.py.

---

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

• AsgAnalysisConfig.py