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 makePtEtaSelectionConfig (seq, containerName, *postfix=None, minPt=None, maxEta=None, useClusterEta=None, selectionDecoration=None, selectionName='')
 
def makeObjectCutFlowConfig (seq, containerName, *postfix=None, selectionName)
 
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 636 of file AsgAnalysisConfig.py.

636 def makeCommonServicesConfig( seq ):
637  """Create the common services config"""
638 
639  seq.append (CommonServicesConfig ())
640 
641 
642 

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

727 def makeEventCutFlowConfig( seq, containerName,
728  *, postfix = None, selectionName, customSelections = None):
729  """Create an event-level cutflow config
730 
731  Keyword arguments:
732  containerName -- name of the container
733  postfix -- a postfix to apply to decorations and algorithm names.
734  selectionName -- the name of the selection to do the cutflow for
735  customSelections -- a list of decorations to use in the cutflow, to override the retrieval of all decorations
736  """
737 
738  config = EventCutFlowBlock (containerName, selectionName)
739  config.setOptionValue ('postfix', postfix)
740  config.setOptionValue ('customSelections', customSelections)
741  seq.append (config)
742 
743 

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

661  saveCutBookkeepers=None,
662  runNumber=None,
663  cutBookkeepersSystematics=None ):
664  """Create a generator analysis algorithm sequence
665 
666  Keyword arguments:
667  saveCutBookkeepers -- save cut bokkeepers information into output file
668  runNumber -- MC run number
669  cutBookkeepersSystematics -- store CutBookkeepers systematics
670  """
671 
672  config = GeneratorAnalysisBlock ()
673  config.setOptionValue ('saveCutBookkeepers', saveCutBookkeepers)
674  config.setOptionValue ('runNumber', runNumber)
675  config.setOptionValue ('cutBookkeepersSystematics', cutBookkeepersSystematics)
676  seq.append (config)
677 
678 
679 

◆ makeObjectCutFlowConfig()

def python.AsgAnalysisConfig.makeObjectCutFlowConfig (   seq,
  containerName,
postfix = None,
  selectionName 
)
Create a pt-eta kinematic selection config

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.
  selectionName -- the name of the selection to do the cutflow for

Definition at line 709 of file AsgAnalysisConfig.py.

709 def makeObjectCutFlowConfig( seq, containerName,
710  *, postfix = None, selectionName):
711  """Create a pt-eta kinematic selection config
712 
713  Keyword arguments:
714  containerName -- name of the container
715  postfix -- a postfix to apply to decorations and algorithm
716  names. this is mostly used/needed when using this
717  sequence with multiple working points to ensure all
718  names are unique.
719  selectionName -- the name of the selection to do the cutflow for
720  """
721 
722  config = ObjectCutFlowBlock (containerName, selectionName)
723  config.setOptionValue ('postfix',postfix)
724  seq.append (config)
725 
726 

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

744 def makeOutputThinningConfig( seq, containerName,
745  *, postfix = None, selection = None, selectionName = None, outputName = None, configName='Thinning'):
746  """Create an output thinning config
747 
748  This will do a consistent selection of output containers (if there
749  is a preselection or a selection specified) and then creates a set
750  of view containers (or deep copies) based on that selection.
751 
752  Keyword arguments:
753  containerName -- name of the container
754  postfix -- a postfix to apply to decorations and algorithm
755  names. this is mostly used/needed when using this
756  sequence with multiple working points to ensure all
757  names are unique.
758  selection -- the name of an optional selection decoration to use
759  outputName -- an optional name for the output container
760 
761  """
762 
763  config = OutputThinningBlock (containerName, configName)
764  config.setOptionValue ('postfix', postfix)
765  config.setOptionValue ('selection', selection)
766  config.setOptionValue ('selectionName', selectionName)
767  config.setOptionValue ('outputName', outputName)
768  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 643 of file AsgAnalysisConfig.py.

643 def makePileupReweightingConfig( seq, campaign=None, files=None, useDefaultConfig=None, userLumicalcFiles=None, userPileupConfigs=None ):
644  """Create a PRW analysis config
645 
646  Keyword arguments:
647  """
648  # TO DO: add explanation of the keyword arguments, left to experts
649 
650  config = PileupReweightingBlock ()
651  config.setOptionValue ('campaign', campaign)
652  config.setOptionValue ('files', files)
653  config.setOptionValue ('useDefaultConfig', useDefaultConfig)
654  config.setOptionValue ('userLumicalcFiles', userLumicalcFiles)
655  config.setOptionValue ('userPileupConfigs', userPileupConfigs)
656  seq.append (config)
657 
658 
659 

◆ makePtEtaSelectionConfig()

def python.AsgAnalysisConfig.makePtEtaSelectionConfig (   seq,
  containerName,
postfix = None,
  minPt = None,
  maxEta = None,
  useClusterEta = None,
  selectionDecoration = None,
  selectionName = '' 
)
Create a pt-eta kinematic selection config

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.
  minPt -- minimum pt value
  maxEta -- maximum eta value
  useClusterEta -- use cluster eta (for electrons/photons) instead of track eta
  selectionDecoration -- the name of the decoration to set
  selectionName -- the name of the selection to append this to

Definition at line 680 of file AsgAnalysisConfig.py.

680 def makePtEtaSelectionConfig( seq, containerName,
681  *, postfix = None, minPt = None, maxEta = None,
682  useClusterEta = None,
683  selectionDecoration = None, selectionName = ''):
684  """Create a pt-eta kinematic selection config
685 
686  Keyword arguments:
687  containerName -- name of the container
688  postfix -- a postfix to apply to decorations and algorithm
689  names. this is mostly used/needed when using this
690  sequence with multiple working points to ensure all
691  names are unique.
692  minPt -- minimum pt value
693  maxEta -- maximum eta value
694  useClusterEta -- use cluster eta (for electrons/photons) instead of track eta
695  selectionDecoration -- the name of the decoration to set
696  selectionName -- the name of the selection to append this to
697  """
698 
699  config = PtEtaSelectionBlock (containerName, selectionName)
700  config.setOptionValue ('postfix',postfix)
701  config.setOptionValue ('minPt',minPt)
702  config.setOptionValue ('maxEta',maxEta)
703  config.setOptionValue ('selectionDecoration',selectionDecoration)
704  config.setOptionValue ('useClusterEta',useClusterEta)
705  seq.append (config)
706 
707 
708 
python.AsgAnalysisConfig.makeEventCutFlowConfig
def makeEventCutFlowConfig(seq, containerName, *postfix=None, selectionName, customSelections=None)
Definition: AsgAnalysisConfig.py:727
python.AsgAnalysisConfig.makePtEtaSelectionConfig
def makePtEtaSelectionConfig(seq, containerName, *postfix=None, minPt=None, maxEta=None, useClusterEta=None, selectionDecoration=None, selectionName='')
Definition: AsgAnalysisConfig.py:680
python.AsgAnalysisConfig.makeOutputThinningConfig
def makeOutputThinningConfig(seq, containerName, *postfix=None, selection=None, selectionName=None, outputName=None, configName='Thinning')
Definition: AsgAnalysisConfig.py:744
python.AsgAnalysisConfig.makeGeneratorAnalysisConfig
def makeGeneratorAnalysisConfig(seq, saveCutBookkeepers=None, runNumber=None, cutBookkeepersSystematics=None)
Definition: AsgAnalysisConfig.py:660
python.AsgAnalysisConfig.makeObjectCutFlowConfig
def makeObjectCutFlowConfig(seq, containerName, *postfix=None, selectionName)
Definition: AsgAnalysisConfig.py:709
python.AsgAnalysisConfig.makeCommonServicesConfig
def makeCommonServicesConfig(seq)
Definition: AsgAnalysisConfig.py:636
python.AsgAnalysisConfig.makePileupReweightingConfig
def makePileupReweightingConfig(seq, campaign=None, files=None, useDefaultConfig=None, userLumicalcFiles=None, userPileupConfigs=None)
Definition: AsgAnalysisConfig.py:643