ConfigurationSettings.cxx 62.4 KB
Newer Older
1
/*
2
   Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
Tomas Dado's avatar
Tomas Dado committed
3
 */
4
5
6
7
8
9
10
11
12
13
14
15
16

#include "TopConfiguration/ConfigurationSettings.h"

#include <algorithm>
#include <cstdlib>
#include <fstream>
#include <sstream>
#include <iomanip>
#include <iostream>
#include <boost/algorithm/string.hpp>
#include <boost/algorithm/string/trim_all.hpp>

namespace top {
Tomas Dado's avatar
Tomas Dado committed
17
  ConfigurationSettings* ConfigurationSettings::m_instance = 0;
18

Tomas Dado's avatar
Tomas Dado committed
19
  ConfigurationSettings::ConfigurationSettings() : m_configured(false) {
20
    registerParameter("ElectronCollectionName", "Name of the Electron container");
21
22
    registerParameter("FwdElectronCollectionName",
                      "Name of the Forward Electrons container, ForwardElectrons or None (default)", "None");
23
24
25
26
    registerParameter("MuonCollectionName", "Name of the Muon container");
    registerParameter("PhotonCollectionName", "Name of the Photon container");
    registerParameter("JetCollectionName", "Name of the Jet container");
    registerParameter("LargeJetCollectionName", "Name of the large-R Jet container");
27
    registerParameter("LargeJetSubstructure", "Setup to use when applying grooming on the large-R jet", "None");
Tomas Dado's avatar
Tomas Dado committed
28
    registerParameter("TrackJetCollectionName", "Name of the track Jet container", "None");
aknue's avatar
aknue committed
29
    registerParameter("TrackCollectionName", "Name of the track container", "None");
30
    registerParameter("TauCollectionName", "Name of the Tau container");
31
32
    registerParameter("JetGhostTrackDecoName", "Name of the jet decoration that holds the ghost-associated track.",
                      "None");
33
34

    registerParameter("TruthCollectionName", "Name of the Truth container");
Tomas Dado's avatar
Tomas Dado committed
35
    registerParameter("TruthElectronCollectionName", "Name of the Truth Electron container", "TruthElectrons");
36
37
38
39
40
    registerParameter("TruthMuonCollectionName", "Name of the Truth Muon container", "TruthMuons");
    registerParameter("TruthPhotonCollectionName", "Name of the Truth Photon container", "None");
    registerParameter("TruthMETCollectionName", "Name of the Truth MET container", "MET_Truth");
    registerParameter("TruthJetCollectionName", "Name of the Truth Jet container");
    registerParameter("TruthLargeRJetCollectionName", "Name of the Truth Large R Jet container", "None");
41
    registerParameter("TruthTauCollectionName", "Name of the Truth tau container", "None");
42
43

    registerParameter("applyTTVACut", "Decide if to apply lepton z0/d0 cuts", "True");
44

Tomas Dado's avatar
Tomas Dado committed
45
46
    registerParameter("GRLDir", "Location of GRL File", "TopAnalysis");
    registerParameter("GRLFile", "Name of GRL File", " ");
47

Tomas Dado's avatar
Tomas Dado committed
48
49
    registerParameter("TDPPath", "Path to TopDataPreparation file (accessible via PathResolver)",
                      "dev/AnalysisTop/TopDataPreparation/XSection-MC16-13TeV.data");
50

Tomas Dado's avatar
Tomas Dado committed
51
52
53
54
    registerParameter("DumpBtagSystsInSystTrees",
                      "Dump systematics-shifted b-tagging SFs in systematic TTrees, True or False (default: False)",
                      "False");
    registerParameter("StorePerJetBtagSFs", "Store per-jet btag SFs", "False");
55

Tomas Dado's avatar
Tomas Dado committed
56
57
58
    registerParameter("ElectronID", "Type of electron. Likelihood LooseAndBLayerLH, MediumLH, TightLH", "TightLH");
    registerParameter("ElectronIDLoose",
                      "Type of electron for background. Likelihood LooseAndBLayerLH, MediumLH, TightLH", "MediumLH");
59
    registerParameter("ElectronPt", "Electron pT cut for object selection (in MeV). Default 25 GeV.", "25000.");
Tomas Dado's avatar
Tomas Dado committed
60
61
62
63
64
65
66
67
68
69
70
    registerParameter("EgammaSystematicModel", "Egamma Calibration Systematic model : FULL_v1 , 1NP_v1 (default)",
                      "1NP_v1");
    registerParameter("ElectronEfficiencySystematicModel",
                      "Electron Efficiency Systematic model : FULL, SIMPLIFIED, TOTAL (default)", "TOTAL");
    registerParameter("ElectronEfficiencySystematicModelEtaBinning",
                      "Electron Efficiency Systematic model eta binning (option for SIMPLIFIED model, do not specify to use default; format XXX:YYY:ZZZ, e.g. 0.0:1.37:4.9)",
                      "default");
    registerParameter("ElectronEfficiencySystematicModelEtBinning",
                      "Electron Efficiency Systematic model E_T binning (option for SIMPLIFIED model, do not specify to use default; format XXX:YYY:ZZZ. e.g. 4000:7000:10000:15000:13000000)",
                      "default");
    registerParameter("ElectronIsolation",
Baptiste Ravina's avatar
Baptiste Ravina committed
71
                      "Isolation to use : Gradient, FCLoose, FCTight, FCHighPtCaloOnly, PLVTight, PLVLoose, (EXPERIMENTAL: HighPtCaloOnly, Loose, Tight, TightTrackOnly, TightTrackOnly_FixedRad), (DANGEROUS: PflowTight, PflowLoose), None",
72
                      "FCTight");
Tomas Dado's avatar
Tomas Dado committed
73
    registerParameter("ElectronIsolationLoose",
Baptiste Ravina's avatar
typo    
Baptiste Ravina committed
74
                      "Isolation to use : Gradient, FCLoose, FCTight, FCHighPtCaloOnly, PLVTight, PLVLoose, (EXPERIMENTAL: HighPtCaloOnly, Loose, Tight, TightTrackOnly, TightTrackOnly_FixedRad), (DANGEROUS: PflowTight, PflowLoose), None",
Tomas Dado's avatar
Tomas Dado committed
75
                      "None");
76
77
    registerParameter("ElectronIsolationSF", "Force electron isolation SF (e.g. None). EXPERIMENTAL!", " ");
    registerParameter("ElectronIsolationSFLoose", "Force electron isolation SF (e.g. None). EXPERIMENTAL!", " ");
Tomas Dado's avatar
Tomas Dado committed
78
79
80
81
82
    registerParameter("ElectronVetoLArCrack", "True/False. Set to False to disable LAr crack veto (not recommended).",
                      "True");
    registerParameter("UseElectronChargeIDSelection",
                      "True/False. Switch on/off electron charge ID selection (Default False).", "False");
    registerParameter("UseEgammaLeakageCorrection",
83
84
85
                      "True/False. Switch on/off super cluster based core leakage correction -- REQUIRES ptag>p3947 (Default True).", "False");
    registerParameter("UseEgammaPileupCorrection",
                      "True/False. Switch on/off improved egamma pileup correction is correction", "True");
86
    registerParameter("EnablePromptLeptonImprovedVetoStudies",
87
88
                      "True/False. Adds the (many!) variables necessary to validate the PromptLeptonImprovedVeto electron+muon isolation -- TEMPORARY, for studies only (Default False).",
                      "False");
Tomas Dado's avatar
Tomas Dado committed
89
90
91

    registerParameter("FwdElectronID", "Type of fwd electron. Loose, Medium, Tight (default)", "Tight");
    registerParameter("FwdElectronIDLoose", "Type of fwd loose electrons. Loose, Medium, Tight (default)", "Tight");
92
93
94
    registerParameter("FwdElectronPt", "Fwd Electron pT cut for object selection (in MeV). Default 25 GeV.", "25000.");
    registerParameter("FwdElectronMinEta", "Fwd Electron lower |eta| cut for object selection. Default 2.5", "2.5");
    registerParameter("FwdElectronMaxEta", "Fwd Electron upper |eta| cut for object selection. Default 4.9", "4.9");
Tomas Dado's avatar
Tomas Dado committed
95
96
97
    registerParameter("FwdElectronBCIDCleaningRunRange",
                      "Specify run range for which the BCID cleaning must be applied for fwd el. in data: \"XXX:YYY\"; the cleaning will be applied for XXX<=runNumber<=YYY",
                      "266904:311481");
98

99
100
101

    registerParameter("PhotonPt", "Photon pT cut for object selection (in MeV). Default 25 GeV.", "25000.");
    registerParameter("PhotonEta", "Absolute Photon eta cut for object selection. Default 2.5.", "2.5");
Tomas Dado's avatar
Tomas Dado committed
102
103
104
105
106
107
108
109
110
    registerParameter("PhotonID", "Type of photon. Definition to use : Tight, Loose and None.", "Tight");
    registerParameter("PhotonIDLoose", "Type of photon for background. Definition to use : Tight, Loose, None.",
                      "Loose");
    registerParameter("PhotonIsolation",
                      "Isolation to use : FixedCutTightCaloOnly, FixedCutTight, FixedCutLoose, (EXPERIMENTAL: TightCaloOnly, Tight, Loose), None.",
                      "FixedCutTight");
    registerParameter("PhotonIsolationLoose",
                      "Isolation to use : FixedCutTightCaloOnly, FixedCutTight, FixedCutLoose, (EXPERIMENTAL: TightCaloOnly, Tight, Loose), None.",
                      "FixedCutLoose");
111
112

    registerParameter("MuonPt", "Muon pT cut for object selection (in MeV). Default 25 GeV.", "25000");
Tomas Dado's avatar
Tomas Dado committed
113
114
115
116
117
118
119
    registerParameter("MuonEta", "Absolute Muon eta cut for object selection. Default 2.5.", "2.5");
    registerParameter("MuonQuality",
                      "Muon quality cut for object selection. Options are VeryLoose, Loose, Medium (default) and Tight",
                      "Medium");
    registerParameter("MuonQualityLoose",
                      "Muon quality cut for object selection. Options are VeryLoose, Loose, Medium (default) and Tight",
                      "Medium");
120
    registerParameter("MuonUseMVALowPt",
121
122
                      "Turn on MVA for low-pT muons (only for LowPt WP). Optimized to improve efficiency and hadron rejection. - Default: False",
                      "False");
123
    registerParameter("MuonUse2stationHighPt",
124
125
                      "Allows muon reconstruction using 2-station muons with missing inner MS station for |eta|<1.3 - Default: True (only for HighPt)",
                      "True");
126
    registerParameter("MuonUseMVALowPtLoose",
127
128
                      "Turn on MVA for low-pT muons (only for LowPt WP) for Loose tree. Optimized to improve efficiency and hadron rejection. - Default: False",
                      "False");
129
    registerParameter("MuonUse2stationHighPtLoose",
130
131
                      "Allows muon reconstruction using 2-station muons with missing inner MS station for |eta|<1.3 for Loose tree - Default: True (only for HighPt)",
                      "True");
Tomas Dado's avatar
Tomas Dado committed
132
    registerParameter("MuonIsolation",
133
                      "Isolation to use : PflowTight_VarRad, PflowTight_FixedRad, PflowLoose_VarRad, PflowLoose_FixedRad, HighPtTrackOnly, TightTrackOnly_VarRad, TightTrackOnly_FixedRad, PLVTight, PLVLoose, Tight_VarRad, Tight_FixedRad, Loose_VarRad, Loose_FixedRad, FCTight, FCLoose, FCTightTrackOnly, FCTightTrackOnly_FixedRad, FCLoose_FixedRad, FCTight_FixedRad, FixedCutPflowTight, FixedCutPflowLoose, FCTight_FixedRad, AntiMuon_nominal, AntiMuon_shapeSyst1, AntiMuon_shapeSyst2, None",
134
                      "PflowTight_FixedRad, PLImprovedTight, PLImprovedVeryTight");
Tomas Dado's avatar
Tomas Dado committed
135
    registerParameter("MuonIsolationLoose",
136
                      "Isolation to use : PflowTight_VarRad, PflowTight_FixedRad, PflowLoose_VarRad, PflowLoose_FixedRad, HighPtTrackOnly, TightTrackOnly_VarRad, TightTrackOnly_FixedRad, PLVTight, PLVLoose, Tight_VarRad, Tight_FixedRad, Loose_VarRad, Loose_FixedRad, FCTight, FCLoose, FCTightTrackOnly, FCTightTrackOnly_FixedRad, FCLoose_FixedRad, FCTight_FixedRad, FixedCutPflowTight, FixedCutPflowLoose, FCTight_FixedRad, None",
137
                      "None");
138
139
    registerParameter("MuonIsolationSF", "Force muon isolation SF (e.g. None). EXPERIMENTAL!", " ");
    registerParameter("MuonIsolationSFLoose", "Force muon isolation SF (e.g. None). EXPERIMENTAL!", " ");
140
141
142
143
144
145
    registerParameter("MuonDoSmearing2stationHighPt",
                      "True/False, to turn on/off spacial corrections for 2-station muons reconstruction with missing inner MS station allowed for abs(eta)<1.3, only with MuonQuality HighPt. - Default: True",
                      "True");
    registerParameter("MuonDoExtraSmearingHighPt",
                      "True/False, To be used by analyses using willing to check their sensitivity to momentum resolution effects at large muon momenta and in case move to the HighPt WP - Default: false",
                      "false");
146
    registerParameter("UseAntiMuons", "Use AntiMuons for fake estimate. Default: false", "false");
Tomas Dado's avatar
Tomas Dado committed
147
    registerParameter("UseSoftMuons", "True to use soft muons, False (default) otherwise", "False");
148
    registerParameter("SoftMuonPt", "Soft Muon pT cut for object selection (in MeV). Default 4 GeV.", "4000");
Tomas Dado's avatar
Tomas Dado committed
149
150
151
152
    registerParameter("SoftMuonEta", "Absolute Soft Muon eta cut for object selection. Default 2.5.", "2.5");
    registerParameter("SoftMuonQuality",
                      "Soft Muon quality cut for object selection. Options are Loose, Medium, Tight (default), LowPt",
                      "Tight");
153
    registerParameter("SoftMuonUseMVALowPt",
154
155
                      "Turn on MVA for low-pT soft muons (only for LowPt WP). Optimized to improve efficiency and hadron rejection. - Default: False",
                      "False");
Tomas Dado's avatar
Tomas Dado committed
156
157
158
    registerParameter("SoftMuonDRJet",
                      "Soft Muon maximum dR wrt nearest selected jet. Can be set to 999. to keep all soft muons. Default 0.4",
                      "0.4");
159
160
161
    registerParameter("SoftMuonDRJetUseRapidity",
                      "How to calculate DR(soft muon,jet) for the SoftMuonDRJet cut: True -> use rapidity; False -> use pseudorapidity. Default False",
                      "False");
162
    registerParameter("SoftMuonAdditionalTruthInfo",
163
                      "Experimental: store additional truth information on soft muons particle-level origin: True or False (default)",
164
165
                      "False");
    registerParameter("SoftMuonAdditionalTruthInfoCheckPartonOrigin",
166
                      "Experimental: store additional truth information on soft muons parton-level origin; requires SoftMuonAdditionalTruthInfo to be true; automatically disabled if PS!=pythia8 and PS!=herwigpp : True or False (default)",
167
168
                      "False");
    registerParameter("SoftMuonAdditionalTruthInfoDoVerbose",
169
                      "Debug output for soft muon additional truth-level information: True or False (default)",
170
                      "False");
171
172

    registerParameter("JetPt", "Jet pT cut for object selection (in MeV). Default 25 GeV.", "25000.");
Tomas Dado's avatar
Tomas Dado committed
173
    registerParameter("JetEta", "Absolute Jet eta cut for object selection. Default 2.5.", "2.5");
174

175
176
177
178
    registerParameter("JVTinMETCalculation",
                      "Perfom a JVT cut on the jets in the MET recalculation? True (default) or False.", "True");
    registerParameter("SaveFailJVTJets", "Save the jets that failed the JVT cut? False (default) or True.", "False");
    registerParameter("JVTWP", "Set JVT WP, default is set to \'Default\' (Tight for PFlow and Medium for Topo).",
Tomas Dado's avatar
Tomas Dado committed
179
                      "Default");
180
    registerParameter("ForwardJVTWP", "Set fJVT Working Point for selecting forward jets (|eta|>2.5 & 20GeV<pT<60GeV)"
181
                                      "\'None\': No fJVT (doesn't run tool for selection) - use this if you don't have forward jets in your selection or if using using PFlow jets with a derivation older than p4173, \'Tight\' (fJVT<0.4, recommended), \'Medium\': (fJVT<0.5, if combined with ForwardJVTinMETCalculation this will set MET WP to Tenacious with stricter JVTinMET requirements",
182
                      "None");
183
    registerParameter("ForwardJVTinMETCalculation",
184
185
186
187
188
189
190
191
                      "Use fJVT cut on forward jets to improve resolution in the MET recalculation? \'False\' (default - must set false if using pflow jets with derivations older than P4173), or \'True\'",
                      "False");
    registerParameter("SaveFailForwardJVTJets",
                      "Save the jets that failed the fJVT cut? \'False\' (default), or \'True\'", "False");
    registerParameter("AdvancedUsage_METUncertaintiesConfigDir",
                      "Path to directory containing MET uncertainties configs (including trailing /) \'Latest\' (default), or previous \'METUtilities/data17_13TeV/prerec_Jan16/\'",
                      "Latest");

Tomas Dado's avatar
Tomas Dado committed
192
    registerParameter("JetPtGhostTracks",
193
194
                      "Jet pT threshold for ghost track systematic variations calculation (in MeV). Default 25 GeV.",
                      "25000.");
195
196
197
    registerParameter("JetEtaGhostTracks",
                      "Jet eta threshold for ghost track systematic variations calculation. Default 2.5",
                      "2.5");
198
199
200
201
    registerParameter("GhostTrackspT",
                      "PT of the ghost tracks associated small-R jets (in MeV). Default 500 MeV.",
                      "500.");
    registerParameter("GhostTracksVertexAssociation",
202
203
                      "WP of the ghost track vertex association. Option: none, nominal and tight. Default nominal.",
                      "nominal");
204
    registerParameter("GhostTracksQuality",
205
206
207
                      "WP of the ghost track quality. Option: TightPrimary, LoosePrimary. Loose, NoCut. Default TightPrimary.",
                      "TightPrimary");

208
209
210
211
212
213
214
215
216
217
    registerParameter("LargeRJetPtGhostTracks",
                      "Jet pT threshold for ghost track systematic variations calculation (in MeV). Default 150000 GeV.",
                      "150000.");
    registerParameter("LargeRJetEtaGhostTracks",
                      "Jet eta threshold for ghost track systematic variations calculation. Default 2.0",
                      "2.0");
    registerParameter("GhostTrackspTLargeR",
                      "PT of the ghost tracks associated large-R jets (in MeV). Default 500 MeV.",
                      "500.");
    registerParameter("GhostTracksVertexAssociationLargeR",
218
219
                      "WP of the ghost track vertex association (for largeR jets). Option: none, nominal and tight. Default nominal.",
                      "nominal");
220
    registerParameter("GhostTracksQualityLargeR",
221
222
223
                      "WP of the ghost track quality (for largeR jets). Option: TightPrimary, LoosePrimary. Loose, NoCut. Default TightPrimary.",
                      "TightPrimary");

Tomas Dado's avatar
Tomas Dado committed
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
    registerParameter("JetUncertainties_NPModel",
                      "AllNuisanceParameters, CategoryReduction (default), GlobalReduction, StrongReduction - for JetUncertainties",
                      "CategoryReduction");
    registerParameter("JetUncertainties_QGFracFile", "To specify a root file with quark/gluon fractions,"
                                                     " in order to reduce FlavourComposition and response uncertainties."
                                                     " Default: None (i.e. no file is used and default flat 50+/-50% fraction is used).",
                      "None");
    registerParameter("JetUncertainties_QGHistPatterns", "To specify a pattern for the name of the quark/gluon fractions histograms, or a list of DSIDs which will have their specific histogram."
                                                         " Two syntaxes are possible, either a single string or a list of DSIDs separated by commas:"
                                                         "   \"MyQGHisto\" (the histograms with \"MyQGHisto\" in their names will be used for all DSIDs),"
                                                         "   \"410470,410472,345873,345874,345875\" (for the listed DSIDs, histograms with the processed DSID will be used, while the flat 50+/-50% fraction will be used for the other DSIDs)."
                                                         " Default: None (i.e. no specific pattern is looked for in the name of the provided histograms).",
                      "None");
    registerParameter("JetJERSmearingModel",
                      "All (inc. data smearing), All_PseudoData (use MC as pseudo-data), Full (inc. data smearing), Full_PseudoData (use MC as pseudo-data) or Simple (MC only - default)",
                      "Simple");
    registerParameter("JetCalibSequence", "Jet calibaration sequence, GSC (default) or JMS", "GSC");
    registerParameter("StoreJetTruthLabels", "Flag to store truth labels for jets - True (default) or False", "True");

    registerParameter("JSF", "Used for top mass analysis, default is 1.0", "1.0");
244
245
    registerParameter("bJSF", "Used for top mass analysis, default is 1.0", "1.0");

246
    registerParameter("LargeRJetPt", "LargeRJet pT cut for object selection (in MeV). Default 150 GeV.", "150000.");
Tomas Dado's avatar
Tomas Dado committed
247
    registerParameter("LargeRJetEta", "Absolute large-R jet eta cut for object selection. Default 2.0.", "2.0");
248
249
250
    registerParameter("LargeRJetSubstructureVariables",
                      "List of substructure variables stored in the output separated by commas. By default no variable is added to output.",
                      " ");
Tomas Dado's avatar
Tomas Dado committed
251
252
253
    registerParameter("LargeRJetUncertainties_NPModel",
                      "AllNuisanceParameters, CategoryReduction (default), GlobalReduction, - for LCTopo Large-R Jet Uncertainties or Scale_TCC_all - for TCC Large-R Jet Uncertainties",
                      "CategoryReduction");
254
    registerParameter("AdvancedUsage_LargeRJetUncertaintiesConfigDir",
255
256
                      "Path to directory containing large-R jet uncertainties config",
                      "rel21/Summer2019");
257
    registerParameter("LargeRJESJMSConfig",
258
                      "Calibration for large-R JES/JMS. CombMass, CaloMass, TCCMass or UFOSDMass (default CombMass).",
259
                      "CombMass");
260
261
262
263
    registerParameter("BoostedJetTagging",
                      "Boosted jet taggers to use in the analysis, separated by commas or white spaces."
                      " By default, no tagger is used.",
                      " ");
264

265
    registerParameter("TrackJetPt", "Track Jet pT cut for object selection (in MeV). Default 10 GeV.", "10000.");
Tomas Dado's avatar
Tomas Dado committed
266
267
    registerParameter("TrackJetEta", "Absolute Track Jet eta cut for object selection. Default 2.5.", "2.5");

aknue's avatar
aknue committed
268
269
270
    registerParameter("TrackPt", "Track pT cut for object selection (in MeV). Default 0.5 GeV.", "0.5");
    registerParameter("TrackEta", "Absolute Track eta cut for object selection. Default 2.5.", "2.5");
    registerParameter("TrackQuality",
271
272
                      "Track quality cut for object selection. Options are TightPrimary,...",
                      "TightPrimary");
aknue's avatar
aknue committed
273
274


Tomas Dado's avatar
Tomas Dado committed
275
276
277
    registerParameter("RCJetPt", "Reclustered Jet pT cut for object selection (in MeV). Default 100000 MeV.",
                      "100000.");
    registerParameter("RCJetEta", "Reclustered Jet eta cut for object selection. Default 2.0.", "2.0");
278
279
280
281
282
283
    registerParameter("RCInputJetPtMin",
                      "Min Pt cut for RC jet inputs collection. Parameter is shared between RC and VarRC jets. Default 30000. [MeV]",
                      "30000.");
    registerParameter("RCInputJetEtaMax",
                      "Max |Eta| cut for RC jet inputs collection. Parameter is shared between RC and VarRC jets. Default 2.5",
                      "2.5");
Tomas Dado's avatar
Tomas Dado committed
284
285
286
287
    registerParameter("RCJetTrim", "Reclustered Jet trimming cut for object selection. Default 0.05.", "0.05");
    registerParameter("RCJetRadius", "Reclustered Jet radius for object selection. Default 1.0", "1.0");
    registerParameter("UseRCJetSubstructure", "Calculate Reclustered Jet Substructure Variables. Default False",
                      "False");
288
289
290
291
    registerParameter("RCJetSubstructureVariables",
                      R"("List of reclustered jet substructure variables stored in the output separated by commas.
                      Available variables: Tau32_clstr,Tau21_clstr,Tau3_clstr,Tau2_clstr,Tau1_clstr,d12_clstr,d23_clstr,Qw_clstr,nconstituent_clstr,D2_clstr,ECF1_clstr,ECF2_clstr,ECF3_clstr,gECF332_clstr,gECF461_clstr,gECF322_clstr,gECF331_clstr,gECF422_clstr,gECF441_clstr,gECF212_clstr,gECF321_clstr,gECF311_clstr,L1_clstr,L2_clstr,L3_clstr,L4_clstr,L5_clstr,rrcjet_pt,rrcjet_eta,rrcjet_phi,rrcjet_e)",
                      " ");
Tomas Dado's avatar
Tomas Dado committed
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309

    registerParameter("UseRCJets", "Use Reclustered Jets. Default False.", "False");

    registerParameter("VarRCJetPt",
                      "Reclustered Jet (variable-R) pT cut for object selection (in MeV). Default 100000 MeV.",
                      "100000.");
    registerParameter("VarRCJetEta", "Reclustered Jet (variable-R) eta cut for object selection. Default 2.0.", "2.0");
    registerParameter("VarRCJetTrim", "Reclustered Jet (variable-R) trimming cut for object selection. Default 0.05.",
                      "0.05");
    registerParameter("VarRCJetMaxRadius",
                      "Reclustered Jet (variable-R) max. radius cut for object selection. Default 1.0", "1.0");
    registerParameter("VarRCJetRho", "Reclustered Jet (variable-R) list of rho values (). Default 2.", "2");
    registerParameter("VarRCJetMassScale",
                      "Reclustered Jet (variable-R) list of mass scale values (m_w,m_z,m_h,m_t). By default use all.",
                      "m_w,m_z,m_h,m_t");
    registerParameter("UseVarRCJets", "Use Reclustered Jets (Variable-R Jets). Default False.", "False");
    registerParameter("UseVarRCJetSubstructure",
                      "Calculate Variable-R Reclustered Jet Substructure Variables. Default False", "False");
310

Petr Jacka's avatar
Petr Jacka committed
311
    registerParameter("VarRCJetSubstructureVariables",
312
313
314
                      R"(List of variable-R reclustered jet substructure variables stored in the output separated by commas.
                      Available variables: Tau32_clstr,Tau21_clstr,Tau3_clstr,Tau2_clstr,Tau1_clstr,d12_clstr,d23_clstr,Qw_clstr,nconstituent_clstr,D2_clstr,ECF1_clstr,ECF2_clstr,ECF3_clstr,gECF332_clstr,gECF461_clstr,gECF322_clstr,gECF331_clstr,gECF422_clstr,gECF441_clstr,gECF212_clstr,gECF321_clstr,gECF311_clstr,L1_clstr,L2_clstr,L3_clstr,L4_clstr,L5_clstr,rrcjet_pt,rrcjet_eta,rrcjet_phi,rrcjet_e)",
                      " ");
315
316

    registerParameter("TauPt",
Tomas Dado's avatar
Tomas Dado committed
317
318
319
                      "Pt cut applied to both tight and loose taus (in MeV)."
                      "Default 25 GeV.",
                      "25000");
Tanja Holm's avatar
Tanja Holm committed
320
    registerParameter("TauEtaRegions",
321
322
323
                      "Eta regions used for both tight and loose taus."
                      "Default vetoing crack region [0., 1.37, 1.52, 2.5]",
                      "[0., 1.37, 1.52, 2.5]");
324
    registerParameter("TauJetIDWP",
325
326
                      "Tau jet IDWP (None, Loose, Medium, Tight, LooseNotMedium, LooseNotTight, MediumNotTight, NotLoose, RNNLoose, RNNMedium, RNNTight)."
                      "Default RNNMedium.",
327
                      "RNNMedium");
328
    registerParameter("TauJetIDWPLoose",
Tomas Dado's avatar
Tomas Dado committed
329
                      "Loose Tau jet IDWP (None, Loose, Medium, Tight, LooseNotMedium, LooseNotTight, MediumNotTight, NotLoose)."
330
331
                      "Default RNNLoose.",
                      "RNNLoose");
332
    registerParameter("TauEleBDTWP",
333
                      "Tau electron BDT WP (None, Loose, Medium, Tight, OldLoose, OldMedium)."
334
335
336
                      "Default Loose.",
                      "Loose");
    registerParameter("TauEleBDTWPLoose",
337
                      "Loose Tau electron BDT WP (None, Loose, Medium, Tight, OldLoose, OldMedium)."
338
339
340
                      "Default Loose.",
                      "Loose");
    registerParameter("TauEleOLR",
Tomas Dado's avatar
Tomas Dado committed
341
342
343
                      "Apply tau-electron overlap removal (True/False)."
                      "Default False",
                      "False");
344
    registerParameter("TauEleOLRLoose",
Tomas Dado's avatar
Tomas Dado committed
345
346
347
                      "Apply loose tau-electron overlap removal (True/False)."
                      "Default False",
                      "False");
348
    registerParameter("TauJetConfigFile",
Tomas Dado's avatar
Tomas Dado committed
349
350
351
352
353
                      "Config file to configure tau selection. "
                      "If anything other than 'Default'"
                      "then all cuts are taken from the "
                      "config file rather than other options.",
                      "Default");
354
    registerParameter("TauJetConfigFileLoose",
Tomas Dado's avatar
Tomas Dado committed
355
356
357
358
359
                      "Config file to configure loose tau selection. "
                      "If anything other than 'Default'"
                      "then all cuts are taken from the "
                      "config file rather than other options.",
                      "Default");
360
    registerParameter("ApplyTauMVATES",
361
362
                      "Apply new Tau energy calibration based on substructure information and regression. Must be True. Deprecated.",
                      "True");
363
364
365
366
367
368
    registerParameter("TauSFDoRNNID",
                      "Save SF for RNN tau ID True/False",
                      "True");
    registerParameter("TauSFDoBDTID",
                      "Save SF for BDT tau ID True/False",
                      "False");
369

Tomas Dado's avatar
Tomas Dado committed
370
    registerParameter("Systematics", "What to run? Nominal (just the nominal), All(do all systematics) ", "Nominal");
371
372

    registerParameter("LibraryNames", "Names of any libraries that need loading");
373
    registerParameter("UseAodMetaData", "Whether to read xAOD meta-data from input files (default: True)", "True");
Tomas Dado's avatar
Tomas Dado committed
374
375
    registerParameter("WriteTrackingData", "Whether to generate and store analysis-tracking data (default: True)",
                      "True");
376
377
    registerParameter("ObjectSelectionName", "Code used to define objects, e.g. ObjectLoaderStandardCuts");
    registerParameter("OutputFormat", "Format, can be user defined, e.g. top::EventSaverFlatNtuple");
Tomas Dado's avatar
Tomas Dado committed
378
379
    registerParameter("OutputEvents",
                      "AllEvents (saves all events + decison bits), SelectedEvents (saves only the events passing your cuts)");
380
    registerParameter("OutputFilename", "The file that will contain the output histograms and trees");
Tomas Dado's avatar
Tomas Dado committed
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
    registerParameter("OutputFileSetAutoFlushZero",
                      "setAutoFlush(0) on EventSaverFlatNtuple for ANALYSISTO-44 workaround. (default: False)",
                      "False");
    registerParameter("OutputFileNEventAutoFlush",
                      "Set the number of events after which the TTree cache is optimised, ie setAutoFlush(nEvents). (default: 1000)",
                      "1000");
    registerParameter("OutputFileBasketSizePrimitive",
                      "Set the TTree basket size for primitive objects (int, float, ...). (default: 4096)", "4096");
    registerParameter("OutputFileBasketSizeVector", "Set the TTree basket size for vector objects. (default: 40960)",
                      "40960");
    registerParameter("RecomputeCPVariables",
                      "Run the CP tools to force computation of variables that may already exist in derivations? (default: True)",
                      "True");
    registerParameter("EventVariableSaveList", "The list of event variables to save (EventSaverxAODNext only).",
                      "runNumber.eventNumber.eventTypeBitmask.averageInteractionsPerCrossing");
    registerParameter("PhotonVariableSaveList", "The list of photon variables to save (EventSaverxAODNext only).",
                      "pt.eta.phi.m.charge.ptvarcone20.topoetcone20.passPreORSelection");
    registerParameter("ElectronVariableSaveList", "The list of electron variables to save (EventSaverxAODNext only).",
                      "pt.eta.phi.m.charge.ptvarcone20.topoetcone20.passPreORSelection");
    registerParameter("MuonVariableSaveList", "The list of muon variables to save (EventSaverxAODNext only).",
                      "pt.eta.phi.m.author.charge.ptvarcone30.topoetcone20.muonType.passPreORSelection");
    registerParameter("TauVariableSaveList", "The list of tau variables to save (EventSaverxAODNext only).",
                      "pt.eta.phi.m.charge.passPreORSelection");
    registerParameter("JetVariableSaveList", "The list of jet variables to save (EventSaverxAODNext only).",
                      "pt.eta.phi.m.passPreORSelection.btaggingLink.HadronConeExclTruthLabelID");
    registerParameter("BTagVariableSaveList", "The list of b-tag variables to save (EventSaverxAODNext only).",
                      "MV2c20_discriminant");

    registerParameter("NEvents",
                      "The number of events that you want to run on (for testing). If 0 then all events are run.", "0");
    registerParameter("FirstEvent",
                      "The number of events that you want to skip (for testing). If 0 then no events are skipped.",
                      "0");
    registerParameter("PerfStats", " I/O Performance printouts. None, Summary or Full", "None");
415
    registerParameter("IsAFII", "Define if you are running over a fastsim sample: True or False", " ");
416
    registerParameter("IsDataOverlay", "Define if you are running over a data overlay MC sample: True or False", " ");
Tomas Dado's avatar
Tomas Dado committed
417
418
    registerParameter("FilterBranches",
                      "Comma separated list of names of the branches that will be removed from the output", " ");
419
    registerParameter("FilterPartonLevelBranches",
420
421
                      "Comma separated list of names of the parton-level branches that will be removed from the output",
                      " ");
422
    registerParameter("FilterParticleLevelBranches",
423
424
                      "Comma separated list of names of the particle-level branches that will be removed from the output",
                      " ");
425
    registerParameter("FilterNominalLooseBranches",
426
427
                      "Comma separated list of names of the nominal_Loose tree branches that will be removed from the output",
                      " ");
428
429
    registerParameter("FilterTrees",
                      "Comma separated list of names of the trees that will be removed from the output", " ");
430

Tomas Dado's avatar
Tomas Dado committed
431
432
433
    registerParameter("FakesMMWeightsIFF",
                      "Calculate matrix-method weights for fake leptons estimate using FakeBkgTools from IFF: True (calculate weights), False (does nothing)",
                      "False");
434
    registerParameter("FakesMMConfigIFF",
Tomas Dado's avatar
Tomas Dado committed
435
436
437
438
439
                      "Configurations for fake leptons estimate using FakeBkgTools from IFF: - default is $ROOTCOREBIN/data/TopFakes/efficiencies.xml:1T:1F[T]. Use as \n <ROOT/XML FILE>:<DEFNINITION>:<PROCESS>;<ROOT/XML FILE 2>:<DEFNINITION 2>:<PROCESS 2>; ...",
                      "$ROOTCOREBIN/data/TopFakes/efficiencies.xml:1T:1F[T]");
    registerParameter("FakesMMIFFDebug",
                      "Enables debug mode for matrix-method weight calculation using FakeBkgTools from IFF: True, False (default)",
                      "False");
440

Tomas Dado's avatar
Tomas Dado committed
441
442
443
444
    registerParameter("DoTight", "Dumps the normal non-\"*_Loose\" trees : Data, MC, Both (default), False", "Both");
    registerParameter("DoLoose", "Run Loose selection and dumps the Loose trees : Data (default), MC, Both, False",
                      "Data");
    registerParameter("DoSysts", "Run systematics on given selection: Both (default), Tight, Loose", "Both");
445
446
447
448
449
450
451
452
453
454
455

    registerParameter("UseLooseObjectsInMETInLooseTree",
                      "Experimental: use loose objects when rebuilding the MET for the loose tree : True or False (default = False)",
                      "False");
    registerParameter("UseLooseObjectsInMETInNominalTree",
                      "Experimental: use loose objects when rebuilding the MET for the nominal tree : True or False (default = False)",
                      "False");

    registerParameter("WriteMETBuiltWithLooseObjects",
                      "Write a separate branch with the met built with loose objects in the output for tests: True or False (default = False)",
                      "False");
456

Tomas Dado's avatar
Tomas Dado committed
457
458
459
460
    registerParameter("OverlapRemovalLeptonDef",
                      "Special: run overlap removal on : Tight (top default) or Loose (not top default) lepton definitions",
                      "Tight");
    registerParameter("ApplyTightSFsInLooseTree",
461
                      "Special: in Loose trees, calculate electron/muon SFs with tight leptons only, and considering they are tight: True or False (default)",
Tomas Dado's avatar
Tomas Dado committed
462
                      "False");
463

Tomas Dado's avatar
Tomas Dado committed
464
465
    registerParameter("ApplyElectronInJetSubtraction",
                      "Subtract electrons close to jets for boosted analysis : True or False(top default)", "False");
466
    registerParameter("TopPartonHistory", "ttbar, tb, Wtb, ttz, ttgamma, tHq, False (default)", "False");
467
    registerParameter("TopPartonLevel", "Perform parton level analysis (stored in truth tree)? True or False", "True");
468
469
470

    registerParameter("TopParticleLevel",
                      "Perform particle level selection (stored in particleLevel tree)? True or False", "False");
471
472
473
474
    registerParameter("DoParticleLevelOverlapRemoval",
                      "Perform overlap removal at particle level? True (default), False, or any combination (comma separated) of MuonJet, ElectronJet, JetPhoton",
                      "True");

Tomas Dado's avatar
Tomas Dado committed
475
476
477
478
479
480
    registerParameter("PDFInfo",
                      "Do you want the PDF info? True (in truth tree), Nominal (save to the nominal tree if passes selection) or False (nothing, default)",
                      "False");
    registerParameter("MCGeneratorWeights",
                      "Do you want the OTF-computed MC generator weights (if available)? True (in truth tree), Nominal (save to the nominal tree if passes selection) or False (nothing, default)",
                      "False");
481
482
    registerParameter("NominalWeightNames",
                      "List of nominal weight names to attempt to retrieve. Attempts are made in the order as specified. If none of the names can be found, we will crash with error message. Use index instead in such case.",
483
                      "\" nominal \",\"nominal\",\"Default\",\"Weight\",\"1001\",\" muR=0.10000E+01 muF=0.10000E+01 \",\"\",\" \",\" dyn=   3 muR=0.10000E+01 muF=0.10000E+01 \",\" mur=1 muf=1 \"");
484
485
486
    registerParameter("NominalWeightFallbackIndex",
                      "Index of nominal weight in MC weights vector. This option is only used in case the MC sample has broken metadata. (Default: -1 means no fallback index specified, rely on metadata and crash if metadata cannot be read)",
                      "-1");
487
488
489
    registerParameter("ForceNominalWeightFallbackIndex",
                      "Force usage of NominalWeightFallbackIndex, even if MC sample metadata is correct. (Default: False)",
                      "False");
490

Tomas Dado's avatar
Tomas Dado committed
491
    registerParameter("TruthBlockInfo", "Do you want to dump the full Truth block info? True or False", "False");
492

Tomas Dado's avatar
Tomas Dado committed
493
494
495
496
497
    registerParameter("TruthElectronPt",
                      "Electron pT cut for [Particle Level / Truth] object selection (in MeV). Default 25 GeV.",
                      "25000");
    registerParameter("TruthElectronEta",
                      "Absolute electron eta cut for [Particle Level / Truth] object selection. Default 2.5.", "2.5");
498

Tomas Dado's avatar
Tomas Dado committed
499
500
501
502
    registerParameter("TruthMuonPt",
                      "Muon pT cut for [Particle Level / Truth] object selection (in MeV). Default 25 GeV.", "25000");
    registerParameter("TruthMuonEta",
                      "Absolute Muon eta cut for [Particle Level / Truth] object selection. Default 2.5.", "2.5");
503

504
    registerParameter("TruthSoftMuonPt",
505
506
                      "Soft Muon pT cut for [Particle Level / Truth] object selection (in MeV). Default 4 GeV.",
                      "4000");
507
508
    registerParameter("TruthSoftMuonEta",
                      "Absolute Soft Muon eta cut for [Particle Level / Truth] object selection. Default 2.5.", "2.5");
509

510
511
512
513
514
    registerParameter("TruthPhotonPt",
                      "Photon pT cut for [Particle Level / Truth] object selection (in MeV). Default 25 GeV.",
                      "25000");
    registerParameter("TruthPhotonEta",
                      "Absolute Photon eta cut for [Particle Level / Truth] object selection. Default 2.5.",
Tomas Dado's avatar
Tomas Dado committed
515
                      "2.5");
516
517
    registerParameter("TruthPhotonOrigin",
                      "Potential origin of [Particle Level / Truth] photons. Comma separated list of particle origin values as given by MCTruthClassifier (string names).",
Tomas Dado's avatar
Tomas Dado committed
518
                      "WBoson,ZBoson,SinglePhot,Higgs,HiggsMSSM,WZMSSM,PromptPhot,SUSY,UndrPhot,FSRPhot");
519
520
521
522
523
    registerParameter("TruthPhotonIsolation",
                      "Configuration option for isolation applied to [Particle Level / Truth] photons. "
                      "This can be False / None (isolation requirement disabled), "
                      "True (use default isolation), "
                      "or a configuration in the format `VAR CUT`, where VAR is one of the isolation variables and CUT is the cut applied as `VAR / pt < CUT`.",
524
                      "ptcone20 0.1");
525
526


Tomas Dado's avatar
Tomas Dado committed
527
528
529
530
    registerParameter("TruthJetPt",
                      "Jet pT cut for [Particle Level / Truth] object selection (in MeV). Default 25 GeV.", "25000");
    registerParameter("TruthJetEta", "Absolute Jet eta cut for [Particle Level / Truth] object selection. Default 2.5.",
                      "2.5");
531

Tomas Dado's avatar
Tomas Dado committed
532
533
534
535
536
537
    registerParameter("TruthLargeRJetPt",
                      "Large R Jet pT cut for [Particle Level / Truth] object selection (in MeV). Default 25 GeV.",
                      "25000");
    registerParameter("TruthLargeRJetEta",
                      "Absolute Large R Jet eta cut for [Particle Level / Truth] object selection. Default 2.5.",
                      "2.5");
538

Tomas Dado's avatar
Tomas Dado committed
539
540
541
    registerParameter("TruthTauPt",
                      "Tau pT cut for [Particle Level / Truth] object selection (in MeV). Default 25 GeV.", "25000");
    registerParameter("TruthTauEta", "Tau eta cut for [Particle Level / Truth] object selection. Default 2.5.", "2.5");
542

Tomas Dado's avatar
Tomas Dado committed
543
544
545
546
547
548
549
550
551
552
    registerParameter("LHAPDFSets",
                      "List of PDF sets to calculate weights for, seperated by spaces, use LHAPDF names e.g CT10nlo NNPDF30_nlo_as_0118 MMHT2014nlo68cl",
                      " ");
    registerParameter("LHAPDFEventWeights",
                      "Save per event weights for all PDF sets/members: True (lots of info in truth tree!), Nominal (save to the nominal tree if passes selection) or False (nothing, default).",
                      "False");
    registerParameter("LHAPDFBaseSet",
                      "Base PDF set used to recalculate XF1,XF2 values if they are zero. Will be added to LHAPDFSets.",
                      " ");
    registerParameter("BTagCDIPath", "Path to the b-tagging CDI file. Default: Using the hardcoded path.", "Default");
553
554

    registerParameter("BTaggingWP",
555
556
557
558
559
560
561
562
563
564
565
566
567
                      "DEPRECATED OPTION, use BTaggingCaloJetWP and BTaggingTrackJetWP for specifying b-tagging WPs for jet collections using calorimeter information and for track jets respectively.",
                      " ");

    registerParameter("BTaggingTrackJetWP",
                      "b-tagging WPs to use for track jet collection in the analysis, separated by commas."
                      " The format should follow the convention of the b-tagging CP group, e.g. FixedCutBEff_60, FlatBEff_77, Continuous, etc."
                      " For fixed-cut WPs, the simpler format 60%, instead of FixedCutBEff_60, is also tolerated."
                      " The specified WPs which are calibrated for all flavours will have scale-factors computed."
                      " By default, no WP is used.",
                      " ");

    registerParameter("BTaggingCaloJetWP",
                      "b-tagging WPs to use for calorimeter jet collection (e.g. EMTopo, EMPFlow) in the analysis, separated by commas."
568
569
570
571
572
                      " The format should follow the convention of the b-tagging CP group, e.g. FixedCutBEff_60, FlatBEff_77, Continuous, etc."
                      " For fixed-cut WPs, the simpler format 60%, instead of FixedCutBEff_60, is also tolerated."
                      " The specified WPs which are calibrated for all flavours will have scale-factors computed."
                      " By default, no WP is used.",
                      " ");
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592

    registerParameter("BTaggingSystExcludedFromEV",
                      "User-defined list of b-tagging systematics to be dextracted from eigenvector decomposition, separated by semi-colons (none by default)",
                      "none");

    registerParameter("BTaggingCalibrationB",
                      "The calibration to use for the b-tagging SFs (B-jets)."
                      " Default 'default'",
                      "default");

    registerParameter("BTaggingCalibrationC",
                      "The calibration to use for the b-tagging SFs (C- and T-jets)."
                      " Default 'default'",
                      "default");

    registerParameter("BTaggingCalibrationLight",
                      "The calibration to use for the b-tagging SFs (Light-jets)."
                      " Default 'default'",
                      "default");

Tomas Dado's avatar
Tomas Dado committed
593
594
595
596
597
598
599
600
601
602
603
604
605
606
    registerParameter("PRWConfigFiles",
                      "List of PU config files, seperated by spaces (nothing by default) - Not compatible with FS/AF options",
                      " ");
    registerParameter("PRWConfigFiles_FS",
                      "List of PU config files only for full sim samples, seperated by spaces (nothing by default)",
                      " ");
    registerParameter("PRWConfigFiles_AF",
                      "List of PU config files only for fast sim samples, seperated by spaces (nothing by default)",
                      " ");
    registerParameter("PRWActualMu_FS",
                      "List of actual mu files for full sim samples, seperated by spaces (nothing by default)", " ");
    registerParameter("PRWActualMu_AF",
                      "List of actual mu files only for fast sim samples, seperated by spaces (nothing by default)",
                      " ");
607
608
609
610
611
612
    registerParameter("PRWLumiCalcFiles", "List of PU lumicalc files, seperated by spaces (nothing by default)", " ");
    registerParameter("PRWUseGRLTool", "Pass the GRL tool to the PU reweighting tool (False by default)", "False");
    registerParameter("PRWMuDependent",
                      "Use mu dependent random run numbers for MC. "
                      "True or False (default True)",
                      "True");
613
614
615
616
617
    registerParameter("PRWCustomScaleFactor",
                      "Specify custom scale-factor and up/down variations, for specific studies."
                      "Format is \'nominal:up:down\'."
                      "If nothing is set, the default values will be used (recommended).",
                      " ");
Tomas Dado's avatar
Tomas Dado committed
618
619
620
621
622
623
    registerParameter("PRWUnrepresentedDataTolerance",
                      "Specify value between 0 and 1 to represent acceptable fraction of unrepresented data in PRW [default: 0.05]",
                      "0.05");
    registerParameter("PRWPeriodAssignments",
                      "Specify period number assignments to run numbers ranges in this form: \"XXX:XXX:XXX\", where XXX are runnumbers, first number is the associated run number, second number is the period block start, the third number is the period block end. You can pass any number of these sets (total number of provided RunNumbers needs to be divisible by 3). Default is used if not specified",
                      " ");
624
625

    registerParameter("MuonTriggerSF", "Muon trigger SFs to calculate", "HLT_mu20_iloose_L1MU15_OR_HLT_mu50");
626

Tomas Dado's avatar
Tomas Dado committed
627
628
629
630
631
632
633
    registerParameter("KLFitterTransferFunctionsPath", "Select the transfer functions to use", "mc12a/akt4_LCtopo_PP6");
    registerParameter("KLFitterOutput", "Select the KLFitter output (FULL, FITTEDTOPS_ONLY, JETPERM_ONLY)", "FULL");
    registerParameter("KLFitterJetSelectionMode",
                      "kLeadingThree , kLeadingFour , kLeadingFive , kLeadingSix , kLeadingSeven , kLeadingEight , kBtagPriorityThreeJets , kBtagPriorityFourJets , kBtagPriorityFiveJets, kBtagPrioritySixJets , kBtagPrioritySevenJets , kBtagPriorityEightJets",
                      "kBtagPriorityFourJets");
    registerParameter("KLFitterBTaggingMethod", "Recommend use kNotag or kVetoNoFit - see KLFitter TWiki", "kNotag");
    registerParameter("KLFitterLH",
634
                      "Select likelihood depending on signal, ttbar, ttbar_JetAngles, ttbar_Angular, ttH, ttZTrilepton, ttbar_AllHadronic, ttbar_BoostedLJets",
Tomas Dado's avatar
Tomas Dado committed
635
636
637
638
639
640
641
                      "ttbar");
    registerParameter("KLFitterTopMassFixed", "Fix the mass of the top quark? True or False", "True");
    registerParameter("KLFitterSaveAllPermutations",
                      "Save All permutations to the output file (False will save only the best)", "False");
    registerParameter("KLFitterFailOnLessThanXJets",
                      "Fail if kLeadingX or kBtagPriorityXJets is set and the number of jets in the event is less than X (Default is False)",
                      "False");
642
643
644
645

    registerParameter("DynamicKeys", "Additional dynamic key list seperated by ,", "");

    registerParameter("OverlapRemovalProcedure", "Overlap removal procedure to be used. Options include:"
Tomas Dado's avatar
Tomas Dado committed
646
                                                 " recommended [default], jetmuApplyRelPt, harmonized,"
647
648
                                                 " Boosted, BoostedSlidingDREl, BoostedSlidingDRMu, BoostedSlidingDRElMu, noTauJetOLR, "
                                                 " noPhotonMuOR, noPhotonMuOrJetOR",
649
                      "recommended"
Tomas Dado's avatar
Tomas Dado committed
650
                      );
651

Tomas Dado's avatar
Tomas Dado committed
652
653
654
655
    registerParameter("OverlapRemovalSlidingInnerDRel",
                      "Overlap removal inner radius to be used for electron SlidingDR ,", "0.2");
    registerParameter("OverlapRemovalSlidingInnerDRmu", "Overlap removal inner radius to be used for muon SlidingDR ,",
                      "0.2");
656

Tomas Dado's avatar
Tomas Dado committed
657
658
    registerParameter("LargeJetOverlapRemoval",
                      "Perform overlap removal including large-R jets. True or False (default: False).", "False");
659
660

    registerParameter("HLLHC",
Tomas Dado's avatar
Tomas Dado committed
661
662
663
                      "Set to run HL-LHC studies,"
                      "True or False (default False)",
                      "False");
664

665
666
667
668
669
    registerParameter("HLLHCFakes",
                      "Set to enable Fakes HL-LHC studies,"
                      "True or False (default False)",
                      "False");

670
    registerParameter("SaveBootstrapWeights", "Set to true in order to save Poisson bootstrap weights,"
Tomas Dado's avatar
Tomas Dado committed
671
                                              "True or False (default False)", "False");
672

673
    registerParameter("NumberOfBootstrapReplicas", "Define integer number of replicas to be stored with bootstrapping, "
Tomas Dado's avatar
Tomas Dado committed
674
                                                   "Default 100", "100");
675

676
    registerParameter("UseBadBatmanCleaning", "Switch to turn on BadBatman cleanig.", "False");
Tomas Dado's avatar
Tomas Dado committed
677
678
679
680
681
682
    registerParameter("BadBatmanCleaningRange",
                      "Set a range of RunNumbers where the cleaning is applied in the form of XXXXX:YYYYY",
                      "276262:311481");
    registerParameter("UseEventLevelJetCleaningTool",
                      "Switch to turn on event-level jet cleaning tool (for testing), True or False (default False)",
                      "False");
683

Tomas Dado's avatar
Tomas Dado committed
684
685
686
687
688
689
690
691
692
693
694
695
696
    registerParameter("UseGlobalLeptonTriggerSF",
                      "Switch to activate event-level trigger scale factors allowing multiple OR of single-, di-, tri- lepton triggers, True or False (default False)",
                      "False");
    registerParameter("GlobalTriggers",
                      "Trigger list for GlobalLeptonTriggerSF - Format as 2015@trig1,trig2 2016@trig3,trig4 : Separate periods defined with @ using whitespace, triggers with comma (default: None)",
                      "None");
    registerParameter("GlobalTriggersLoose",
                      "Trigger list for GlobalLeptonTriggerSF - Format as 2015@trig1,trig2 2016@trig3,trig4 : Separate periods defined with @ using whitespace, triggers with comma (default: None)",
                      "None");
    registerParameter("ElectronTriggers", "Deprecated, use GlobalTriggers instead.", "None");
    registerParameter("ElectronTriggersLoose", "Deprecated, use GlobalTriggersLoose instead.", "None");
    registerParameter("MuonTriggers", "Deprecated, use GlobalTriggers instead.", "None");
    registerParameter("MuonTriggersLoose", "Deprecated, use GlobalTriggersLoose instead.", "None");
697

698
699
700
    registerParameter("DemandPrimaryVertex",
                      "Wether at least one primary vertex in event is required. Default True. For debugging purposes only!",
                      "True");
701

702
    registerParameter("KillExperimental", "Disable some specific experimental feature.", " ");
703
704
705
    registerParameter("RedefineMCMCMap",
                      "Dictionary for translating the shower names from TopDataPreparation. Format: \"shower1:shower2,shower3:shower4\".",
                      " ");
Tomas Dado's avatar
Tomas Dado committed
706
  }
707

Tomas Dado's avatar
Tomas Dado committed
708
709
  ConfigurationSettings* ConfigurationSettings::get() {
    if (!m_instance) m_instance = new ConfigurationSettings();
710
711

    return m_instance;
Tomas Dado's avatar
Tomas Dado committed
712
  }
713

Tomas Dado's avatar
Tomas Dado committed
714
  void ConfigurationSettings::loadFromFile(const std::string& filename) {
715
716
717
    std::ifstream input(filename.c_str());

    if (!input) {
718
      throw std::runtime_error("Configuration file does not exist: " + filename);
719
720
721
    }

    struct SelectionData {
Tomas Dado's avatar
Tomas Dado committed
722
723
724
      std::string name;
      bool isSub;
      std::vector<std::string> cuts;
725
726
727
728
729
    };
    std::string line;
    std::vector<SelectionData> selections;

    //for the key-value pairs
Tomas Dado's avatar
Tomas Dado committed
730
731
732
    while (std::getline(input, line)) {
      std::string newstring(line);

733
734
735
736
737
738
      // search for '#' character to discard commented-out part of line
      // however ignore '\#' -- used to be able to type # in our config
      // and not be recognized as commenting character
      size_t commentpos = size_t(-1);
      while (true) {
        // find next occurence of '#' -- after the already scanned chars
739
740
        commentpos = newstring.find("#", commentpos + 1);
        if (commentpos == std::string::npos) break;
741
742
743
744
745
        if (commentpos == 0) { // the whole line is a comment, to be ignored
          newstring = "";
          break;
        }
        // if it's '\#', then do not erase this part, but remove the '\'
746
747
748
749
        if (newstring.compare(commentpos - 1, 1, "\\") == 0) {
          newstring.erase(commentpos - 1, 1);
          --commentpos; // the position of the '#' shifted after removing '\'
          continue;
750
751
752
753
754
        } else {
          newstring = newstring.substr(0, commentpos);
          break;
        }
      }
Tomas Dado's avatar
Tomas Dado committed
755
756

      // remove (multiple) spaces hanging around relevant information
yili's avatar
yili committed
757
      // if a pair of "" appears, the spaces in "" won't be touched
758
      bool hasquote = (newstring.find("\"", 0) != std::string::npos);
yili's avatar
yili committed
759
      if (!hasquote) boost::algorithm::trim_all(newstring);
760
      else {
yili's avatar
yili committed
761
762
763
764
765
        //split the string into segments, separated by pairs of quotes
        //e.g. the string "abc \"def\" ghi"
        //     becomes a vector of 3 strings: "abc", "\"def\"", "ghi"
        std::vector<std::string> segments;
        std::vector<bool> segments_isquote;
yili's avatar
yili committed
766
767
        std::size_t strsize = newstring.size();
        std::size_t tmppos = 0;
yili's avatar
yili committed
768
        bool leftquote = true;
769
        while (tmppos <= strsize - 1) {
yili's avatar
yili committed
770
          // find the position of the 1st quote after newstring[tmppos]
771
772
773
774
775
776
777
          std::size_t tmppos2 = newstring.find_first_of("\"", tmppos);

          // when the quote found has \ ahead of it, jump over and update tmppos2
          std::size_t tmppos3 = newstring.find_first_of("\\\"", tmppos);
          while (tmppos2 == tmppos3 + 1) {
            tmppos3 = newstring.find_first_of("\\\"", tmppos2 + 1);
            tmppos2 = newstring.find_first_of("\"", tmppos2 + 1);
yili's avatar
yili committed
778
779
780
781
          }

          // when no more quote found, save the segment from the last rightquote to the end, then quit the loop
          if (tmppos2 == std::string::npos) {
782
            segments.push_back(newstring.substr(tmppos, strsize - tmppos));
yili's avatar
yili committed
783
784
785
786
787
788
            segments_isquote.push_back(false);
            break;
          }

          // check it's a left quote or right quote
          if (leftquote) {
789
            segments.push_back(newstring.substr(tmppos, tmppos2 - tmppos));
yili's avatar
yili committed
790
791
792
            segments_isquote.push_back(false);

            // update the position indicator and leftquote flag
793
            tmppos = tmppos2 + 1;
yili's avatar
yili committed
794
795
            leftquote = false;
          } else {
796
797
798
            segments.push_back(newstring.substr(tmppos - 1, tmppos2 - (tmppos - 1) + 1)); // have to include the two
                                                                                          // quotes, which is why +/-1
                                                                                          // adjustment is introduced
yili's avatar
yili committed
799
800
801
            segments_isquote.push_back(true);

            // update the position indicator and leftquote flag
802
            tmppos = tmppos2 + 1;
yili's avatar
yili committed
803
804
805
806
            leftquote = true;
          }
        }

807
808
        // sanity check: if leftquote = false after the loop, it means a left quote is found but not its associated
        // rightquote
yili's avatar
yili committed
809
810
        // in this case, crash the code
        if (!leftquote) {
yili's avatar
yili committed
811
812
813
          std::string message = "Problematic configuration line\n";
          message.append(newstring.c_str());
          throw std::invalid_argument(message);
yili's avatar
yili committed
814
        }
yili's avatar
yili committed
815

yili's avatar
yili committed
816
        //run the original trim_all for each segment that is NOT a quote
yili's avatar
yili committed
817
        for (uint i = 0; i < segments.size(); i++) {
yili's avatar
yili committed
818
819
820
821
822
823
          std::string seg = segments.at(i);
          if (seg.size() == 0) continue;
          if (segments_isquote.at(i)) continue;
          boost::algorithm::trim_all(seg);

          // if the segment has a space in the end and it's not the last segment, add the space back
824
825
          if (i + 1 != segments.size()) {
            if (segments.at(i).at(segments.at(i).size() - 1) == ' ') {
yili's avatar
yili committed
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
              seg += " ";
            }
          }
          // if the segment has a space in the head and it's not the first segment, add the space back
          if (i != 0) {
            if (segments.at(i).at(0) == ' ') {
              seg = " " + seg;
            }
          }

          // update the segment
          segments.at(i) = seg;
        }

        // combine the segments back to newstring
        newstring = "";
yili's avatar
yili committed
842
        for (uint i = 0; i < segments.size(); i++) {
yili's avatar
yili committed
843
844
          newstring += segments.at(i);
        }
yili's avatar
yili committed
845
846
      }

Tomas Dado's avatar
Tomas Dado committed
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
      if (newstring.empty()) continue;

      // handle start of a (sub)selection (implies end of key-value section)
      if (boost::algorithm::starts_with(newstring, "SELECTION ")) {
        selections.push_back({newstring.substr(10), false, {}});
        continue;
      }
      if (boost::algorithm::starts_with(newstring, "SUB ")) {
        selections.push_back({newstring.substr(4), true, {}});
        continue;
      }

      if (!selections.empty()) {
        // read body of (sub)selection
        auto& sel = selections.back();
        if (boost::algorithm::starts_with(newstring, ". ")) {
          // source another (sub)selection here
          auto subselName = newstring.substr(2);
          auto subselIt = std::find_if(selections.rbegin(), selections.rend(),
                                       [subselName](SelectionData const& sel) {
            return(subselName == sel.name);
          });
          if (subselIt == selections.rend()) throw std::invalid_argument(
                    "ConfigurationSettings: unknown selection: " + subselName);
          sel.cuts.insert(sel.cuts.end(), subselIt->cuts.begin(), subselIt->cuts.end());
        } else {
          sel.cuts.push_back(newstring);
874
        }
Tomas Dado's avatar
Tomas Dado committed
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
        continue;
      }

      // parse key-value pair
      std::istringstream liness(newstring);
      std::string key;
      std::string value;

      std::getline(liness, key, ' '); //to the space
      std::getline(liness, value); //to the end of the line

      auto its = strings_.find(key);
      if (its != strings_.end()) {
        its->second.m_data = value;
        its->second.m_set = true;
      }

      //// add dynamic keys
      if ("DynamicKeys" == key) {
        std::vector<std::string> listofkeys;
        std::string separator = ",";
        std::string::size_type start = 0, end = 0;
        while ((end = value.find(separator, start)) != std::string::npos) {
          std::string token = value.substr(start, end - start);
          if (token.size()) listofkeys.push_back(token);
          start = end + 1;
901
902
        }

Tomas Dado's avatar
Tomas Dado committed
903
904
        std::string lasttoken = value.substr(start);
        if (lasttoken.size()) listofkeys.push_back(lasttoken);
905

Tomas Dado's avatar
Tomas Dado committed
906
907
        for (auto par : listofkeys) {
          registerParameter(par, "Dynamic parameter", "");
908
        }
Tomas Dado's avatar
Tomas Dado committed
909
      }
910
911
    }

Tomas Dado's avatar
Tomas Dado committed
912
913
914
    for (auto& sel : selections) {
      if (sel.isSub) continue;
      m_selections.push_back({sel.name, sel.cuts});
915
916
    }

917
    {
Tomas Dado's avatar
Tomas Dado committed
918
919
920
921
922
923
924
      auto const& it = strings_.find("KillExperimental");
      m_killedFeatures.clear();
      if (it != strings_.end() && it->second.m_set) {
        std::string strValue(it->second.m_data);
        boost::trim(strValue);
        boost::split(m_killedFeatures, strValue, boost::is_any_of(" "));
      }
925
926
    }

927
928
    input.close();
    m_configured = true;
Tomas Dado's avatar
Tomas Dado committed
929
  }
930

Tomas Dado's avatar
Tomas Dado committed
931
932
  void ConfigurationSettings::registerParameter(const std::string& name, const std::string& message,
                                                const std::string& default_val) {
933
    StringData data;
Tomas Dado's avatar
Tomas Dado committed
934

935
936
937
938
    data.m_data = default_val;
    data.m_human_explanation = message;
    data.m_set = (default_val.empty() ? false : true);
    strings_[name] = data;
Tomas Dado's avatar
Tomas Dado committed
939
  }
940

Tomas Dado's avatar
Tomas Dado committed
941
  const std::string& ConfigurationSettings::value(const std::string& key) const {
942
943
    //This class never has loadFromFile called
    if (!m_configured) {
Tomas Dado's avatar
Tomas Dado committed
944
945
946
947
      std::string message = "ConfigurationSettings: Not correctly configured\n";
      message.append("You need to call top::ConfigurationSettings::get()->loadFromFile(filename)\n");
      message.append("Early in your program\n");
      throw std::invalid_argument(message);
948
949
950
951
952
    }

    std::map<std::string, StringData>::const_iterator its = strings_.find(key);
    //The string is not in the map
    if (its == strings_.end()) {
Tomas Dado's avatar
Tomas Dado committed
953
      throw std::invalid_argument("ConfigurationSettings: The variable doesn't exist in the code " + key);
954
955
956
957
    }

    //In the map, but never set to anything
    if (!its->second.m_set) {
Tomas Dado's avatar
Tomas Dado committed
958
      throw std::invalid_argument("ConfigurationSettings: You never set a value for " + key);
959
960
961
    }

    return its->second.m_data;
Tomas Dado's avatar
Tomas Dado committed
962
  }
963

Tomas Dado's avatar
Tomas Dado committed
964
  bool ConfigurationSettings::configured() const {
965
    return m_configured;
Tomas Dado's avatar
Tomas Dado committed
966
  }
967

Tomas Dado's avatar
Tomas Dado committed
968
  const std::map<std::string, StringData>& ConfigurationSettings::stringData() const {
969
    return strings_;
Tomas Dado's avatar
Tomas Dado committed
970
  }
971

Tomas Dado's avatar
Tomas Dado committed
972
  const std::vector<SelectionConfigurationData> ConfigurationSettings::selections() const {
973
    return m_selections;
Tomas Dado's avatar
Tomas Dado committed
974
  }
975

976
  void ConfigurationSettings::retrieve(std::string const& key, bool& value) const {
977
978
979
980
981
    using boost::trim;
    using boost::equals;
    using boost::iequals;
    auto stringValue = ConfigurationSettings::get()->value(key);
    trim(stringValue);
982

Tomas Dado's avatar
Tomas Dado committed
983
984
985
986
    if (iequals(stringValue, "false") or iequals(stringValue, "0") or iequals(stringValue, "n") or iequals(stringValue,
                                                                                                           "no") or
        iequals(stringValue, "off")) {
      value = false;
987
      return;
988
    }
Tomas Dado's avatar
Tomas Dado committed
989
990
991
992
    if (iequals(stringValue, "true") or iequals(stringValue, "1") or iequals(stringValue, "y") or iequals(stringValue,
                                                                                                          "yes") or
        iequals(stringValue, "on")) {
      value = true;
993
      return;
994
995
    }
    throw std::invalid_argument(std::string("expected boolean value for configuration setting ") + key);
Tomas Dado's avatar
Tomas Dado committed
996
  }
997

998
  bool ConfigurationSettings::retrieve(std::string const& key) const {
999
1000
    bool result = false;