ATLAS Offline Software
Loading...
Searching...
No Matches
JetReclusteringConfig.py
Go to the documentation of this file.
1# Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
2
3from AnalysisAlgorithmsConfig.ConfigBlock import ConfigBlock
4from AthenaCommon.SystemOfUnits import GeV
5
6class JetReclusteringBlock(ConfigBlock):
7 """ConfigBlock for the jet reclustering algorithm:
8 run FastJet with small-R jets as input. The output
9 is a new container containing the reclustered jets.
10 The default output variables are the RC jet kinematics
11 as well as a vector of indices pointing to the
12 small-R jets that formed the RC jets. With `saveSubstructure`,
13 the kt splitting scales d12 and d23 and Qw of the RC jets are
14 also saved."""
15
16 def __init__(self):
17 super().__init__()
18 self.addOption ('containerName', None, type=str,
19 noneAction='error',
20 info='name of the output reclustered jets container.',
21 meta={'role':'container'})
22 self.addOption ('jets', None, type=str,
23 noneAction='error',
24 info='the input jet collection to recluster, with a possible selection, in the format `container` or `container.selection`.',
25 meta={'role':'containerRef'})
26 self.addOption ('clusteringAlgorithm', 'AntiKt', type=str,
27 info='algorithm to use to recluster the jets: `AntiKt`, `Kt`, `CamKt`.',
28 meta={'choices':(['AntiKt','Kt','CamKt'],1)})
29 self.addOption ('reclusteredJetsRadius', 1.0, type=float,
30 info='radius parameter of the reclustering algorithm.')
31 self.addOption ('minPt', 200*GeV, type=float,
32 info=r'minimum $p_\mathrm{T}$ requirement (in MeV) on the reclustered jets, creating the selection `passed_sel`.')
33 self.addOption ('maxEta', 0., type=float,
34 info=r'maximum $\vert\eta\vert$ requirement on the reclustered jets, creating the selection `passed_sel`.')
35 self.addOption ('maxRapidity', 2.5, type=float,
36 info='maximum rapidity requirement on the reclustered jets, creating the selection `passed_sel`.')
37 self.addOption ('saveSubstructure', False, type=bool,
38 info='whether to compute and save the kt splitting scales d12 and d23 and Qw '
39 'of the reclustered jets, using their small-R jets as constituents.')
40 def instanceName (self) :
41 """Return the instance name for this block"""
42 return self.containerName
43
44 def makeAlgs(self, config):
45
46 alg = config.createAlgorithm('CP::JetReclusteringAlg', 'JetReclusteringAlg')
47
48 alg.jets, alg.jetSelection = config.readNameAndSelection(self.jets)
49 alg.reclusteredJets = config.writeName(self.containerName)
50 alg.smallRjetIndices = 'smallRjetIndices_%SYS%'
51 alg.rcJetEnergy = 'e_%SYS%'
53 alg.rcJetD12 = 'd12_%SYS%'
54 alg.rcJetD23 = 'd23_%SYS%'
55 alg.rcJetQw = 'Qw_%SYS%'
56 alg.clusteringAlgorithm = self.clusteringAlgorithm
57 alg.reclusteredJetsRadius = self.reclusteredJetsRadius
58
59 # prepare selection algorithm
60 if self.minPt > 0 or self.maxEta > 0 or self.maxRapidity > 0 :
61 selAlg = config.createAlgorithm('CP::AsgSelectionAlg', 'RCJetsMinPtAlg')
62 selAlg.selectionDecoration = 'passed_sel,as_bits'
63 config.addPrivateTool('selectionTool', 'CP::AsgPtEtaSelectionTool')
64 selAlg.selectionTool.minPt = self.minPt
65 selAlg.selectionTool.maxEta = self.maxEta
66 selAlg.selectionTool.maxRapidity = self.maxRapidity
67 selAlg.particles = config.readName(self.containerName)
68 selAlg.preselection = config.getPreselection(self.containerName, '')
69 config.addSelection(self.containerName, 'passed_sel', selAlg.selectionDecoration)
70
71 config.addOutputVar(self.containerName, 'pt', 'pt', auxType="float")
72 config.addOutputVar(self.containerName, 'eta', 'eta', auxType="float")
73 config.addOutputVar(self.containerName, 'phi', 'phi', auxType="float")
74 config.addOutputVar(self.containerName, 'm', 'm', auxType="float")
75 config.addOutputVar(self.containerName, alg.rcJetEnergy, 'e', auxType="float")
76 config.addOutputVar(self.containerName, alg.smallRjetIndices, 'small_r_jet_indices', auxType="vector_int")
77 if self.saveSubstructure:
78 config.addOutputVar(self.containerName, alg.rcJetD12, 'd12', auxType="float")
79 config.addOutputVar(self.containerName, alg.rcJetD23, 'd23', auxType="float")
80 config.addOutputVar(self.containerName, alg.rcJetQw, 'Qw', auxType="float")