ATLAS Offline Software
Classes | Functions
python.AsgAnalysisConfig Namespace Reference

Classes

class  CommonServicesConfig
 
class  EventCutFlowBlock
 
class  GeneratorAnalysisBlock
 
class  IFFLeptonDecorationBlock
 
class  IOStatsBlock
 
class  MCTCLeptonDecorationBlock
 
class  ObjectCutFlowBlock
 
class  OutputThinningBlock
 
class  PerEventSFBlock
 
class  PileupReweightingBlock
 
class  PtEtaSelectionBlock
 
class  SelectionDecorationBlock
 
class  SystematicsCategories
 

Functions

def makeCommonServicesConfig (seq)
 
def makePileupReweightingConfig (seq, campaign=None, files=None, useDefaultConfig=None, userLumicalcFiles=None, userPileupConfigs=None)
 
def makeGeneratorAnalysisConfig (seq, saveCutBookkeepers=None, runNumber=None, cutBookkeepersSystematics=None)
 
def makeEventCutFlowConfig (seq, containerName, *postfix=None, selectionName, customSelections=None)
 
def makeOutputThinningConfig (seq, containerName, *postfix=None, selection=None, selectionName=None, outputName=None, configName='Thinning')
 

Function Documentation

◆ makeCommonServicesConfig()

def python.AsgAnalysisConfig.makeCommonServicesConfig (   seq)
Create the common services config

Definition at line 655 of file AsgAnalysisConfig.py.

655 def makeCommonServicesConfig( seq ):
656  """Create the common services config"""
657 
658  seq.append (CommonServicesConfig ())
659 
660 
661 

◆ makeEventCutFlowConfig()

def python.AsgAnalysisConfig.makeEventCutFlowConfig (   seq,
  containerName,
postfix = None,
  selectionName,
  customSelections = None 
)
Create an event-level cutflow config

Keyword arguments:
  containerName -- name of the container
  postfix -- a postfix to apply to decorations and algorithm names.
  selectionName -- the name of the selection to do the cutflow for
  customSelections -- a list of decorations to use in the cutflow, to override the retrieval of all decorations

Definition at line 699 of file AsgAnalysisConfig.py.

699 def makeEventCutFlowConfig( seq, containerName,
700  *, postfix = None, selectionName, customSelections = None):
701  """Create an event-level cutflow config
702 
703  Keyword arguments:
704  containerName -- name of the container
705  postfix -- a postfix to apply to decorations and algorithm names.
706  selectionName -- the name of the selection to do the cutflow for
707  customSelections -- a list of decorations to use in the cutflow, to override the retrieval of all decorations
708  """
709 
710  config = EventCutFlowBlock (containerName, selectionName)
711  config.setOptionValue ('postfix', postfix)
712  config.setOptionValue ('customSelections', customSelections)
713  seq.append (config)
714 
715 

◆ makeGeneratorAnalysisConfig()

def python.AsgAnalysisConfig.makeGeneratorAnalysisConfig (   seq,
  saveCutBookkeepers = None,
  runNumber = None,
  cutBookkeepersSystematics = None 
)
Create a generator analysis algorithm sequence

Keyword arguments:
  saveCutBookkeepers -- save cut bokkeepers information into output file
  runNumber -- MC run number
  cutBookkeepersSystematics -- store CutBookkeepers systematics

Definition at line 679 of file AsgAnalysisConfig.py.

680  saveCutBookkeepers=None,
681  runNumber=None,
682  cutBookkeepersSystematics=None ):
683  """Create a generator analysis algorithm sequence
684 
685  Keyword arguments:
686  saveCutBookkeepers -- save cut bokkeepers information into output file
687  runNumber -- MC run number
688  cutBookkeepersSystematics -- store CutBookkeepers systematics
689  """
690 
691  config = GeneratorAnalysisBlock ()
692  config.setOptionValue ('saveCutBookkeepers', saveCutBookkeepers)
693  config.setOptionValue ('runNumber', runNumber)
694  config.setOptionValue ('cutBookkeepersSystematics', cutBookkeepersSystematics)
695  seq.append (config)
696 
697 
698 

◆ makeOutputThinningConfig()

def python.AsgAnalysisConfig.makeOutputThinningConfig (   seq,
  containerName,
postfix = None,
  selection = None,
  selectionName = None,
  outputName = None,
  configName = 'Thinning' 
)
Create an output thinning config

This will do a consistent selection of output containers (if there
is a preselection or a selection specified) and then creates a set
of view containers (or deep copies) based on that selection.

Keyword arguments:
  containerName -- name of the container
  postfix -- a postfix to apply to decorations and algorithm
             names.  this is mostly used/needed when using this
             sequence with multiple working points to ensure all
             names are unique.
  selection -- the name of an optional selection decoration to use
  outputName -- an optional name for the output container

Definition at line 716 of file AsgAnalysisConfig.py.

716 def makeOutputThinningConfig( seq, containerName,
717  *, postfix = None, selection = None, selectionName = None, outputName = None, configName='Thinning'):
718  """Create an output thinning config
719 
720  This will do a consistent selection of output containers (if there
721  is a preselection or a selection specified) and then creates a set
722  of view containers (or deep copies) based on that selection.
723 
724  Keyword arguments:
725  containerName -- name of the container
726  postfix -- a postfix to apply to decorations and algorithm
727  names. this is mostly used/needed when using this
728  sequence with multiple working points to ensure all
729  names are unique.
730  selection -- the name of an optional selection decoration to use
731  outputName -- an optional name for the output container
732 
733  """
734 
735  config = OutputThinningBlock (containerName, configName)
736  config.setOptionValue ('postfix', postfix)
737  config.setOptionValue ('selection', selection)
738  config.setOptionValue ('selectionName', selectionName)
739  config.setOptionValue ('outputName', outputName)
740  seq.append (config)

◆ makePileupReweightingConfig()

def python.AsgAnalysisConfig.makePileupReweightingConfig (   seq,
  campaign = None,
  files = None,
  useDefaultConfig = None,
  userLumicalcFiles = None,
  userPileupConfigs = None 
)
Create a PRW analysis config

Keyword arguments:

Definition at line 662 of file AsgAnalysisConfig.py.

662 def makePileupReweightingConfig( seq, campaign=None, files=None, useDefaultConfig=None, userLumicalcFiles=None, userPileupConfigs=None ):
663  """Create a PRW analysis config
664 
665  Keyword arguments:
666  """
667  # TO DO: add explanation of the keyword arguments, left to experts
668 
669  config = PileupReweightingBlock ()
670  config.setOptionValue ('campaign', campaign)
671  config.setOptionValue ('files', files)
672  config.setOptionValue ('useDefaultConfig', useDefaultConfig)
673  config.setOptionValue ('userLumicalcFiles', userLumicalcFiles)
674  config.setOptionValue ('userPileupConfigs', userPileupConfigs)
675  seq.append (config)
676 
677 
678 
python.AsgAnalysisConfig.makeEventCutFlowConfig
def makeEventCutFlowConfig(seq, containerName, *postfix=None, selectionName, customSelections=None)
Definition: AsgAnalysisConfig.py:699
python.AsgAnalysisConfig.makeOutputThinningConfig
def makeOutputThinningConfig(seq, containerName, *postfix=None, selection=None, selectionName=None, outputName=None, configName='Thinning')
Definition: AsgAnalysisConfig.py:716
python.AsgAnalysisConfig.makeGeneratorAnalysisConfig
def makeGeneratorAnalysisConfig(seq, saveCutBookkeepers=None, runNumber=None, cutBookkeepersSystematics=None)
Definition: AsgAnalysisConfig.py:679
python.AsgAnalysisConfig.makeCommonServicesConfig
def makeCommonServicesConfig(seq)
Definition: AsgAnalysisConfig.py:655
python.AsgAnalysisConfig.makePileupReweightingConfig
def makePileupReweightingConfig(seq, campaign=None, files=None, useDefaultConfig=None, userLumicalcFiles=None, userPileupConfigs=None)
Definition: AsgAnalysisConfig.py:662