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
	cutFlowHistograms
	cutFlowHistogramsWithSystematics
	customSelections
	selectionName

Detailed Description

the ConfigBlock for an event-level cutflow

Definition at line 769 of file AsgAnalysisConfig.py.

Constructor & Destructor Documentation

__init__()

python.AsgAnalysisConfig.EventCutFlowBlock.__init__

(

self

)

Definition at line 772 of file AsgAnalysisConfig.py.

    def __init__(self):
        super().__init__()
        self.addOption('selectionName', '', type=str,
            noneAction='error',
            info="the name of the event selection to generate cutflow histograms for. "
            "If left blank, all selections on EventInfo will be used.",
            meta={'role':'region'})
        self.addOption('customSelections', [], type=None,
            info="explicit list of selection decorations to use for the cutflow. "
            "If provided, takes precedence over selectionName.")
        self.addOption('cutFlowHistograms', True, type=bool,
            info="whether to generate cutflow histograms for the selection cuts.")
        self.addOption('cutFlowHistogramsWithSystematics', True, type=bool,
            info="whether to generate cutflow histograms for the selection cuts "
                "when running with systematics.")
        self.addOption ('streamName', None, type=str,
            info="name of the output stream to save the cut bookkeeper in.")
 

Member Function Documentation

instanceName()

python.AsgAnalysisConfig.EventCutFlowBlock.instanceName

(

self

)

Definition at line 790 of file AsgAnalysisConfig.py.

    def instanceName(self):
        return 'EventInfo_' + self.selectionName
 

makeAlgs()

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

Definition at line 793 of file AsgAnalysisConfig.py.

    def makeAlgs(self, config):
        if not self.cutFlowHistograms:
            return
 
        if not config.noSystematics() and not self.cutFlowHistogramsWithSystematics:
            return
 
        # Setup stream name
        streamName = self.streamName or config.defaultHistogramStream()
 
        postfix = ('_' + self.selectionName) if self.selectionName else ''
 
        alg = config.createAlgorithm('CP::EventCutFlowHistAlg', 'CutFlowDumperAlg')
        alg.RootStreamName = streamName
        alg.histPattern = 'cflow_EventInfo' + postfix + '_%SYS%'
        alg.eventInfo = config.readName('EventInfo')
        alg.histTitle = 'Event Cutflow: EventInfo.' + self.selectionName
 
        if isinstance(self.customSelections, list) and len(self.customSelections) > 0:
            # user provides a hardcoded list of selections
            alg.selections = self.customSelections
        elif self.selectionName:
            # resolve selectionName to the list of cuts registered by EventSelectionConfig
            alg.selections = config.getEventCutFlow(self.selectionName)
        else:
            # fallback: get all available selections from EventInfo
            alg.selections = config.getSelectionCutFlow('EventInfo', '')
 
        alg.selections = [sel + ',as_char' for sel in alg.selections]
 

Member Data Documentation

customSelections

python.AsgAnalysisConfig.EventCutFlowBlock.customSelections

Definition at line 811 of file AsgAnalysisConfig.py.

cutFlowHistograms

python.AsgAnalysisConfig.EventCutFlowBlock.cutFlowHistograms

Definition at line 794 of file AsgAnalysisConfig.py.

cutFlowHistogramsWithSystematics

python.AsgAnalysisConfig.EventCutFlowBlock.cutFlowHistogramsWithSystematics

Definition at line 797 of file AsgAnalysisConfig.py.

selectionName

python.AsgAnalysisConfig.EventCutFlowBlock.selectionName

Definition at line 814 of file AsgAnalysisConfig.py.

---

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

• AsgAnalysisConfig.py