Rivet  3.1.0
AnalysisInfo.hh
1 // -*- C++ -*-
2 #ifndef RIVET_AnalysisInfo_HH
3 #define RIVET_AnalysisInfo_HH
4 
5 #include "Rivet/Config/RivetCommon.hh"
6 #include <ostream>
7 
8 namespace Rivet {
9 
10 
12  class AnalysisInfo {
13  public:
14 
16  static unique_ptr<AnalysisInfo> make(const std::string& name);
17 
19 
20 
22  AnalysisInfo() { clear(); }
23 
26 
28 
29 
30  public:
31 
35 
36 
39  std::string name() const {
40  if (!_name.empty()) return _name;
41  if (!experiment().empty() && !year().empty()) {
42  if (!inspireId().empty()) {
43  return experiment() + "_" + year() + "_I" + inspireId();
44  } else if (!spiresId().empty()) {
45  return experiment() + "_" + year() + "_S" + spiresId();
46  }
47  }
48  return "";
49  }
50 
52  void setName(const std::string& name) { _name = name; }
53 
55  std::string getRefDataName() const {
56  if (!_refDataName.empty()) return _refDataName;
57  return name();
58  }
59 
61  void setRefDataName(const std::string& name) { _refDataName = name; }
62 
64  const std::string& inspireId() const { return _inspireId; }
65 
67  void setInspireId(const std::string& inspireId) { _inspireId = inspireId; }
68 
69 
71  const std::string& spiresId() const { return _spiresId; }
72 
74  void setSpiresId(const std::string& spiresId) { _spiresId = spiresId; }
75 
76 
80  const std::vector<std::string>& authors() const { return _authors; }
81 
83  void setAuthors(const std::vector<std::string>& authors) { _authors = authors; }
84 
85 
90  const std::string& summary() const { return _summary; }
91 
93  void setSummary(const std::string& summary) { _summary = summary; }
94 
95 
101  const std::string& description() const { return _description; }
102 
104  void setDescription(const std::string& description) { _description = description; }
105 
106 
111  const std::string& runInfo() const { return _runInfo; }
112 
114  void setRunInfo(const std::string& runInfo) { _runInfo = runInfo; }
115 
116 
118  const std::vector<PdgIdPair>& beams() const { return _beams; }
119 
121  void setBeams(const std::vector<PdgIdPair>& beams) { _beams = beams; }
122 
123 
125  const std::vector<std::pair<double,double> >& energies() const { return _energies; }
126 
128  void setEnergies(const std::vector<std::pair<double, double> >& energies) { _energies = energies; }
129 
130 
132  const std::string& experiment() const { return _experiment; }
133 
135  void setExperiment(const std::string& experiment) { _experiment = experiment; }
136 
137 
139  const std::string& collider() const { return _collider; }
140 
142  void setCollider(const std::string& collider) { _collider = collider; }
143 
144 
148  const std::string& year() const { return _year; }
149 
151  void setYear(const std::string& year) { _year = year; }
152 
154  const double luminosityfb() const { return _luminosityfb; }
156  const double luminosity() const { return 1000*_luminosityfb; }
157 
159  void setLuminosityfb(const double luminosityfb) { _luminosityfb = luminosityfb; }
160 
162  const std::vector<std::string>& references() const { return _references; }
163 
165  void setReferences(const std::vector<std::string>& references) { _references = references; }
166 
168  const std::vector<std::string>& keywords() const { return _keywords; }
169 
171  const std::string& bibKey() const { return _bibKey;}
172 
174  void setBibKey(const std::string& bibKey) { _bibKey = bibKey; }
175 
176 
178  const std::string& bibTeX() const { return _bibTeX; }
179 
181  void setBibTeX(const std::string& bibTeX) { _bibTeX = bibTeX; }
182 
183 
185  const std::string& status() const { return _status; }
186 
188  void setStatus(const std::string& status) { _status = status; }
189 
190 
192  const std::vector<std::string>& todos() const { return _todos; }
193 
195  void setTodos(const std::vector<std::string>& todos) { _todos = todos; }
196 
197 
199  const std::vector<std::string>& options() const { return _options; }
200 
202  bool validOption(std::string key, std::string val) const;
203 
205  void setOptions(const std::vector<std::string>& opts) {
206  _options = opts;
207  buildOptionMap();
208  }
209 
211  void buildOptionMap();
212 
214  const std::vector<std::string> & validation() const {
215  return _validation;
216  }
217 
220  bool needsCrossSection() const { return _needsCrossSection; }
221 
223  bool reentrant() const { return _reentrant; }
224 
226  void setReentrant(bool ree = true) { _reentrant = ree; }
227 
229  bool validated() const {
230  return statuscheck("VALIDATED");
231  }
232 
234  bool preliminary() const {
235  return statuscheck("PRELIMINARY");
236  }
237 
239  bool obsolete() const {
240  return statuscheck("OBSOLETE");
241  }
242 
244  bool unvalidated() const {
245  return statuscheck("UNVALIDATED");
246  }
247 
249  bool random() const {
250  return statuscheck("RANDOM");
251  }
252 
255  bool unphysical() const {
256  return statuscheck("UNPHYSICAL");
257  }
258 
260  bool hepdata() const {
261  return !statuscheck("NOHEPDATA");
262  }
263 
265  bool multiweight() const {
266  return !statuscheck("SINGLEWEIGHT");
267  }
268 
269 
270  bool statuscheck(string word) const {
271  auto pos =_status.find(word);
272  if ( pos == string::npos ) return false;
273  if ( pos > 0 && isalnum(_status[pos - 1]) ) return false;
274  if ( pos + word.length() < _status.length() &&
275  isalnum(_status[pos + word.length()]) ) return false;
276  return true;
277  }
279 
280 
281  private:
282 
283  std::string _name;
284  std::string _refDataName;
285  std::string _spiresId, _inspireId;
286  std::vector<std::string> _authors;
287  std::string _summary;
288  std::string _description;
289  std::string _runInfo;
290  std::string _experiment;
291  std::string _collider;
292  std::vector<std::pair<PdgId, PdgId> > _beams;
293  std::vector<std::pair<double, double> > _energies;
294  std::string _year;
295  double _luminosityfb;
296  std::vector<std::string> _references;
297  std::vector<std::string> _keywords;
298  std::string _bibKey;
299  std::string _bibTeX;
300  //std::string _bibTeXBody; ///< Was thinking of avoiding duplication of BibKey...
301  std::string _status;
302  std::vector<std::string> _todos;
303  bool _needsCrossSection;
304 
305  std::vector<std::string> _options;
306  std::map< std::string, std::set<std::string> > _optionmap;
307 
308  std::vector<std::string> _validation;
309 
310  bool _reentrant;
311 
312  void clear() {
313  _name = "";
314  _refDataName = "";
315  _spiresId = "";
316  _inspireId = "";
317  _authors.clear();
318  _summary = "";
319  _description = "";
320  _runInfo = "";
321  _experiment = "";
322  _collider = "";
323  _beams.clear();
324  _energies.clear();
325  _year = "";
326  _luminosityfb = -1;
327  _references.clear();
328  _keywords.clear();
329  _bibKey = "";
330  _bibTeX = "";
331  //_bibTeXBody = "";
332  _status = "";
333  _todos.clear();
334  _needsCrossSection = false;
335  _options.clear();
336  _optionmap.clear();
337  _validation.clear();
338  _reentrant = false;
339  }
340 
341  };
342 
343 
345  std::string toString(const AnalysisInfo& ai);
346 
348  inline std::ostream& operator<<(std::ostream& os, const AnalysisInfo& ai) {
349  os << toString(ai);
350  return os;
351  }
352 
353 
354 }
355 
356 #endif
Definition: MC_Cent_pPb.hh:10
const std::string & summary() const
Get a short description of the analysis. Short (one sentence) description used as an index entry...
Definition: AnalysisInfo.hh:90
AnalysisInfo()
The default constructor.
Definition: AnalysisInfo.hh:22
void setSpiresId(const std::string &spiresId)
Set the SPIRES ID code for this analysis.
Definition: AnalysisInfo.hh:74
Holder of analysis metadata.
Definition: AnalysisInfo.hh:12
bool preliminary() const
Return true if preliminary.
Definition: AnalysisInfo.hh:234
void setReentrant(bool ree=true)
setReentrant
Definition: AnalysisInfo.hh:226
const std::string & status() const
Whether this analysis is trusted (in any way!)
Definition: AnalysisInfo.hh:185
void setDescription(const std::string &description)
Set the full description for this analysis.
Definition: AnalysisInfo.hh:104
~AnalysisInfo()
The destructor.
Definition: AnalysisInfo.hh:25
static unique_ptr< AnalysisInfo > make(const std::string &name)
Static factory method: returns null pointer if no metadata found.
bool obsolete() const
Return true if obsolete.
Definition: AnalysisInfo.hh:239
void setBibTeX(const std::string &bibTeX)
Set the BibTeX citation entry for this article.
Definition: AnalysisInfo.hh:181
void setRefDataName(const std::string &name)
Set the reference data name of the analysis (if different from plugin name).
Definition: AnalysisInfo.hh:61
const std::string & bibTeX() const
BibTeX citation entry for this article.
Definition: AnalysisInfo.hh:178
const double luminosityfb() const
The integrated data luminosity of the data set in 1/fb.
Definition: AnalysisInfo.hh:154
void setExperiment(const std::string &experiment)
Set the experiment which performed and published this analysis.
Definition: AnalysisInfo.hh:135
void setYear(const std::string &year)
Set the year in which the original experimental analysis was published.
Definition: AnalysisInfo.hh:151
const std::string & bibKey() const
BibTeX citation key for this article.
Definition: AnalysisInfo.hh:171
std::string name() const
Definition: AnalysisInfo.hh:39
bool unphysical() const
Definition: AnalysisInfo.hh:255
bool random() const
Return true if includes random variations.
Definition: AnalysisInfo.hh:249
const std::vector< std::string > & todos() const
Any work to be done on this analysis.
Definition: AnalysisInfo.hh:192
void setRunInfo(const std::string &runInfo)
Set the full description for this analysis.
Definition: AnalysisInfo.hh:114
const std::vector< std::string > & validation() const
List a series of command lines to be used for valdation.
Definition: AnalysisInfo.hh:214
void setTodos(const std::vector< std::string > &todos)
Set the to-do list.
Definition: AnalysisInfo.hh:195
const std::vector< std::string > & authors() const
Names & emails of paper/analysis authors. Names and email of authors in &#39;NAME <EMAIL>&#39; format...
Definition: AnalysisInfo.hh:80
const std::vector< PdgIdPair > & beams() const
Beam particle types.
Definition: AnalysisInfo.hh:118
void setOptions(const std::vector< std::string > &opts)
Set the option list.
Definition: AnalysisInfo.hh:205
const std::vector< std::string > & options() const
Get the option list.
Definition: AnalysisInfo.hh:199
const std::string & experiment() const
Experiment which performed and published this analysis.
Definition: AnalysisInfo.hh:132
bool hepdata() const
Check if refdata comes automatically from Hepdata.
Definition: AnalysisInfo.hh:260
const std::string & spiresId() const
Get the SPIRES ID code for this analysis.
Definition: AnalysisInfo.hh:71
void setLuminosityfb(const double luminosityfb)
Set the integrated data luminosity of the data set.
Definition: AnalysisInfo.hh:159
const std::vector< std::string > & keywords() const
Analysis Keywords for grouping etc.
Definition: AnalysisInfo.hh:168
void setStatus(const std::string &status)
Set the analysis code status.
Definition: AnalysisInfo.hh:188
bool unvalidated() const
Return true if unvalidated.
Definition: AnalysisInfo.hh:244
bool validOption(std::string key, std::string val) const
Check if the given option is valid.
void setReferences(const std::vector< std::string > &references)
Set the journal and preprint reference list.
Definition: AnalysisInfo.hh:165
void setName(const std::string &name)
Set the name of the analysis.
Definition: AnalysisInfo.hh:52
bool reentrant() const
Return true if finalize() can be run multiple times for this analysis.
Definition: AnalysisInfo.hh:223
void buildOptionMap()
Build a map of options to facilitate checking.
bool multiweight() const
Check if This analysis can handle mulltiple weights.
Definition: AnalysisInfo.hh:265
void setInspireId(const std::string &inspireId)
Set the Inspire (SPIRES replacement) ID code for this analysis.
Definition: AnalysisInfo.hh:67
bool validated() const
Return true if validated.
Definition: AnalysisInfo.hh:229
void setCollider(const std::string &collider)
Set the collider on which the experiment ran.
Definition: AnalysisInfo.hh:142
const std::vector< std::string > & references() const
Journal and preprint references.
Definition: AnalysisInfo.hh:162
std::string getRefDataName() const
Get the reference data name of the analysis (if different from plugin name).
Definition: AnalysisInfo.hh:55
std::string toString(const AnalysisInfo &ai)
String representation.
bool needsCrossSection() const
Definition: AnalysisInfo.hh:220
void setBibKey(const std::string &bibKey)
Set the BibTeX citation key for this article.
Definition: AnalysisInfo.hh:174
const std::string & year() const
When the original experimental analysis was published. When the refereed paper on which this is based...
Definition: AnalysisInfo.hh:148
const std::string & description() const
Get a full description of the analysis. Full textual description of this analysis, what it is useful for, what experimental techniques are applied, etc. Should be treated as a chunk of restructuredText (http://docutils.sourceforge.net/rst.html), with equations to be rendered as LaTeX with amsmath operators.
Definition: AnalysisInfo.hh:101
void setSummary(const std::string &summary)
Set the short description for this analysis.
Definition: AnalysisInfo.hh:93
const double luminosity() const
The integrated data luminosity of the data set in 1/pb.
Definition: AnalysisInfo.hh:156
const std::string & runInfo() const
Information about the events needed as input for this analysis. Event types, energies, kinematic cuts, particles to be considered stable, etc. etc. Should be treated as a restructuredText bullet list (http://docutils.sourceforge.net/rst.html)
Definition: AnalysisInfo.hh:111
std::ostream & operator<<(std::ostream &os, const AnalysisInfo &ai)
Stream an AnalysisInfo as a text description.
Definition: AnalysisInfo.hh:348
void setBeams(const std::vector< PdgIdPair > &beams)
Set beam particle types.
Definition: AnalysisInfo.hh:121
const std::string & inspireId() const
Get the Inspire (SPIRES replacement) ID code for this analysis.
Definition: AnalysisInfo.hh:64
const std::string & collider() const
Collider on which the experiment ran.
Definition: AnalysisInfo.hh:139
void setAuthors(const std::vector< std::string > &authors)
Set the author list.
Definition: AnalysisInfo.hh:83
void setEnergies(const std::vector< std::pair< double, double > > &energies)
Set the valid beam energies.
Definition: AnalysisInfo.hh:128
const std::vector< std::pair< double, double > > & energies() const
Sets of valid beam energies.
Definition: AnalysisInfo.hh:125