ATLAS Offline Software
CaloSwTransitionRegionsCorr.py
Go to the documentation of this file.
1 # Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
2 
3 #
4 # File: CaloClusterCorrection/python/CaloSwTransitionRegionsCorr.py
5 # Created: Dec, 2007, L. Carminati
6 # Purpose: Steering module for transition region correction.
7 #
8 # This module is used to set up the transition region correction.
9 #
10 # The entry point for this module is make_CaloSwTransitionRegionsCorr, which
11 # returns a new correction tool. The available versions are given
12 # in the table below.
13 #
14 
15 
16 from AthenaConfiguration.ComponentFactory import CompFactory
17 from CaloClusterCorrection.constants import \
18  CALOCORR_COOL, CALOCORR_DEFAULT_KEY, CALOCORR_SW
19 from CaloClusterCorrection.common import makecorr
20 
21 #
22 # This table lists all available versions of this correction.
23 # See common.py for a description of the contents.
24 #
25 from CaloClusterCorrection.constants import sw_valid_keys as keys
26 cls = CompFactory.CaloSwTransitionRegionsCorr # CaloClusterCorrection
27 CaloSwTransitionRegionsCorr_versions = [
28 
29  # 12.0.3 simulation and reconstruction, with ideal (calib0) geometry.
30  ['v1', cls, ['CaloSwTransitionRegionsCorr_v1.' +
31  'CaloSwTransitionRegionsCorr_v1_parms',
32  'caloswcorr_pool', CALOCORR_COOL], keys],
33 
34  # ATLAS-CSC-05-00-00 (14.0.0) geometry simulation.
35  ['v5', cls, ['CaloSwTransitionRegionsCorr_v5.' +
36  'CaloSwTransitionRegionsCorr_v5_parms',
37  'caloswcorr_pool', CALOCORR_COOL], keys],
38 
39  # ATLAS-CSC-05-00-00 (14.0.0) geometry simulation.
40  # Some fixes for eta=0 and eta=0.8 .
41  ['v5_1', cls, ['CaloSwTransitionRegionsCorr_v5_1.'+
42  'CaloSwTransitionRegionsCorr_v5_1_parms',
43  'caloswcorr_pool', CALOCORR_COOL], keys],
44  ]
45 
46 #
47 # Create a new tool instance.
48 # FLAGS is the configuration flags instance.
49 # NAME is the base name for this tool. If defaulted, a name will
50 # be constructed from the name of the correction, the version, and the key.
51 # If SUFFIX is not None, it will be added onto the end of the tool name.
52 # VERSION is a string specifying which of several versions of the correction
53 # to choose. If defaulted, the latest version of the correction is chosen.
54 # KEY is a string to specify the type of cluster to which the correction
55 # applies. The convention is to use `ele55' for 5x5 electron clusters,
56 # `gam35' for 3x5 photon clusters, and so on.
57 # SOURCE tells from where we should read the calibration constants.
58 # See common.py for a description of the possibilities.
59 # CONFCLASS gives the Configurable class to use to create the tool.
60 # It may (and usually should) be defaulted.
61 #
62 # Additional keyword arguments may be passed to override any tool
63 # parameters/constants.
64 #
66  name = None,
67  suffix = None,
68  version = None,
69  key = CALOCORR_DEFAULT_KEY,
70  source = None,
71  confclass = None,
72  **kw):
73 
74  # Make the tool.
75  return makecorr (flags,
76  versions = CaloSwTransitionRegionsCorr_versions,
77  name = name,
78  basename = 'trcorr',
79  suffix = suffix,
80  version = version,
81  key = key,
82  sampling = None,
83  source = source,
84  confclass = confclass,
85  corrclass = CALOCORR_SW,
86  **kw)
CaloSwTransitionRegionsCorr.make_CaloSwTransitionRegionsCorr
def make_CaloSwTransitionRegionsCorr(flags, name=None, suffix=None, version=None, key=CALOCORR_DEFAULT_KEY, source=None, confclass=None, **kw)
Definition: CaloSwTransitionRegionsCorr.py:65