ATLAS Offline Software
Classes | Functions
python.AsgAnalysisConfig Namespace Reference

Classes

class  CommonServicesConfig
 
class  EventCutFlowBlock
 
class  GeneratorAnalysisBlock
 
class  IFFLeptonDecorationBlock
 
class  IOStatsBlock
 
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 625 of file AsgAnalysisConfig.py.

625 def makeCommonServicesConfig( seq ):
626  """Create the common services config"""
627 
628  seq.append (CommonServicesConfig ())
629 
630 
631 

◆ 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 669 of file AsgAnalysisConfig.py.

669 def makeEventCutFlowConfig( seq, containerName,
670  *, postfix = None, selectionName, customSelections = None):
671  """Create an event-level cutflow config
672 
673  Keyword arguments:
674  containerName -- name of the container
675  postfix -- a postfix to apply to decorations and algorithm names.
676  selectionName -- the name of the selection to do the cutflow for
677  customSelections -- a list of decorations to use in the cutflow, to override the retrieval of all decorations
678  """
679 
680  config = EventCutFlowBlock (containerName, selectionName)
681  config.setOptionValue ('postfix', postfix)
682  config.setOptionValue ('customSelections', customSelections)
683  seq.append (config)
684 
685 

◆ 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 649 of file AsgAnalysisConfig.py.

650  saveCutBookkeepers=None,
651  runNumber=None,
652  cutBookkeepersSystematics=None ):
653  """Create a generator analysis algorithm sequence
654 
655  Keyword arguments:
656  saveCutBookkeepers -- save cut bokkeepers information into output file
657  runNumber -- MC run number
658  cutBookkeepersSystematics -- store CutBookkeepers systematics
659  """
660 
661  config = GeneratorAnalysisBlock ()
662  config.setOptionValue ('saveCutBookkeepers', saveCutBookkeepers)
663  config.setOptionValue ('runNumber', runNumber)
664  config.setOptionValue ('cutBookkeepersSystematics', cutBookkeepersSystematics)
665  seq.append (config)
666 
667 
668 

◆ 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 686 of file AsgAnalysisConfig.py.

686 def makeOutputThinningConfig( seq, containerName,
687  *, postfix = None, selection = None, selectionName = None, outputName = None, configName='Thinning'):
688  """Create an output thinning config
689 
690  This will do a consistent selection of output containers (if there
691  is a preselection or a selection specified) and then creates a set
692  of view containers (or deep copies) based on that selection.
693 
694  Keyword arguments:
695  containerName -- name of the container
696  postfix -- a postfix to apply to decorations and algorithm
697  names. this is mostly used/needed when using this
698  sequence with multiple working points to ensure all
699  names are unique.
700  selection -- the name of an optional selection decoration to use
701  outputName -- an optional name for the output container
702 
703  """
704 
705  config = OutputThinningBlock (containerName, configName)
706  config.setOptionValue ('postfix', postfix)
707  config.setOptionValue ('selection', selection)
708  config.setOptionValue ('selectionName', selectionName)
709  config.setOptionValue ('outputName', outputName)
710  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 632 of file AsgAnalysisConfig.py.

632 def makePileupReweightingConfig( seq, campaign=None, files=None, useDefaultConfig=None, userLumicalcFiles=None, userPileupConfigs=None ):
633  """Create a PRW analysis config
634 
635  Keyword arguments:
636  """
637  # TO DO: add explanation of the keyword arguments, left to experts
638 
639  config = PileupReweightingBlock ()
640  config.setOptionValue ('campaign', campaign)
641  config.setOptionValue ('files', files)
642  config.setOptionValue ('useDefaultConfig', useDefaultConfig)
643  config.setOptionValue ('userLumicalcFiles', userLumicalcFiles)
644  config.setOptionValue ('userPileupConfigs', userPileupConfigs)
645  seq.append (config)
646 
647 
648 
python.AsgAnalysisConfig.makeEventCutFlowConfig
def makeEventCutFlowConfig(seq, containerName, *postfix=None, selectionName, customSelections=None)
Definition: AsgAnalysisConfig.py:669
python.AsgAnalysisConfig.makeOutputThinningConfig
def makeOutputThinningConfig(seq, containerName, *postfix=None, selection=None, selectionName=None, outputName=None, configName='Thinning')
Definition: AsgAnalysisConfig.py:686
python.AsgAnalysisConfig.makeGeneratorAnalysisConfig
def makeGeneratorAnalysisConfig(seq, saveCutBookkeepers=None, runNumber=None, cutBookkeepersSystematics=None)
Definition: AsgAnalysisConfig.py:649
python.AsgAnalysisConfig.makeCommonServicesConfig
def makeCommonServicesConfig(seq)
Definition: AsgAnalysisConfig.py:625
python.AsgAnalysisConfig.makePileupReweightingConfig
def makePileupReweightingConfig(seq, campaign=None, files=None, useDefaultConfig=None, userLumicalcFiles=None, userPileupConfigs=None)
Definition: AsgAnalysisConfig.py:632