Rivet API documentation
![]() |
Rivet 4.1.3
|
AnalysisInfo.hh
static unique_ptr< AnalysisInfo > make(const std::string &name)
Static factory method: returns null pointer if no metadata found.
std::string refFile() const
Find the path to the reference-data file for this analysis.
const std::vector< std::string > & validation() const
List a series of command lines to be used for valdation.
Definition AnalysisInfo.hh:377
void setCollider(const std::string &collider)
Set the collider on which the experiment ran.
Definition AnalysisInfo.hh:168
void setTodos(const std::vector< std::string > &todos)
Set the to-do list.
Definition AnalysisInfo.hh:270
const std::string & refUnmatch() const
Negative filtering regex for ref-data HepData sync.
Definition AnalysisInfo.hh:232
void setBeamIDs(const std::vector< PdgIdPair > &beamids)
Set beam particle types.
Definition AnalysisInfo.hh:141
void setYear(const std::string &year)
Set the year in which the original experimental analysis was published.
Definition AnalysisInfo.hh:180
const std::string & description() const
Get a full description of the analysis.
Definition AnalysisInfo.hh:114
const std::string & warning() const
Any warning message.
Definition AnalysisInfo.hh:216
const std::string & bibKey() const
BibTeX citation key for this article.
Definition AnalysisInfo.hh:248
void setRefDataName(const std::string &name)
Set the reference data name of the analysis (if different from plugin name).
Definition AnalysisInfo.hh:59
void setBibTeX(const std::string &bibTeX)
Set the BibTeX citation entry for this article.
Definition AnalysisInfo.hh:261
const std::vector< std::string > & todos() const
Any work to be done on this analysis.
Definition AnalysisInfo.hh:266
const std::string & collider() const
Collider on which the experiment ran.
Definition AnalysisInfo.hh:164
void setRunInfo(const std::string &runInfo)
Set the full description for this analysis.
Definition AnalysisInfo.hh:131
const std::string & inspireID() const
Get the Inspire (SPIRES replacement) ID code for this analysis.
Definition AnalysisInfo.hh:64
const std::string & bibTeX() const
BibTeX citation entry for this article.
Definition AnalysisInfo.hh:257
const std::vector< PdgIdPair > & beamIDs() const
Beam particle types.
Definition AnalysisInfo.hh:136
const std::vector< std::string > & references() const
Journal and preprint references.
Definition AnalysisInfo.hh:199
void setExperiment(const std::string &experiment)
Set the experiment which performed and published this analysis.
Definition AnalysisInfo.hh:159
void setInspireID(const std::string &inspireID)
Set the Inspire (SPIRES replacement) ID code for this analysis.
Definition AnalysisInfo.hh:69
void setSummary(const std::string &summary)
Set the short description for this analysis.
Definition AnalysisInfo.hh:104
void setLuminosityfb(const double luminosityfb)
Set the integrated data luminosity of the data set.
Definition AnalysisInfo.hh:194
const std::string & summary() const
Get a short description of the analysis.
Definition AnalysisInfo.hh:100
const std::vector< std::pair< double, double > > & energies() const
Sets of valid beam energies.
Definition AnalysisInfo.hh:146
const std::string & refMatch() const
Positive filtering regex for ref-data HepData sync.
Definition AnalysisInfo.hh:224
void setEnergies(const std::vector< std::pair< double, double > > &energies)
Set the valid beam energies.
Definition AnalysisInfo.hh:150
const std::string & spiresID() const
Get the SPIRES ID code for this analysis.
Definition AnalysisInfo.hh:74
double luminosity() const
The integrated data luminosity of the data set in 1/pb.
Definition AnalysisInfo.hh:189
const std::vector< std::string > & keywords() const
Analysis keywords, for grouping etc.
Definition AnalysisInfo.hh:208
const std::string & runInfo() const
Information about the events needed as input for this analysis.
Definition AnalysisInfo.hh:127
void setBibKey(const std::string &bibKey)
Set the BibTeX citation key for this article.
Definition AnalysisInfo.hh:252
const std::vector< std::string > & authors() const
Names & emails of paper/analysis authors.
Definition AnalysisInfo.hh:87
std::string getRefDataName() const
Get the reference data name of the analysis (if different from plugin name).
Definition AnalysisInfo.hh:54
const std::string & year() const
When the original experimental analysis was published.
Definition AnalysisInfo.hh:175
const std::string & writerDoublePrecision() const
Positive filtering regex for setting double precision in Writer.
Definition AnalysisInfo.hh:240
void setReferences(const std::vector< std::string > &references)
Set the journal and preprint reference list.
Definition AnalysisInfo.hh:203
void setAuthors(const std::vector< std::string > &authors)
Set the author list.
Definition AnalysisInfo.hh:91
void setDescription(const std::string &description)
Set the full description for this analysis.
Definition AnalysisInfo.hh:118
double luminosityfb() const
The integrated data luminosity of the data set in 1/fb.
Definition AnalysisInfo.hh:185
void setName(const std::string &name)
Set the name of the analysis.
Definition AnalysisInfo.hh:49
const std::string & experiment() const
Experiment which performed and published this analysis.
Definition AnalysisInfo.hh:155
void setSpiresID(const std::string &spiresID)
Set the SPIRES ID code for this analysis.
Definition AnalysisInfo.hh:79
const std::vector< std::string > & options() const
Get the option list.
Definition AnalysisInfo.hh:281
void buildOptionMap()
Build a map of options to facilitate checking.
bool validOption(std::string key, std::string val) const
Check if the given option is valid.
void setOptions(const std::vector< std::string > &opts)
Set the option list.
Definition AnalysisInfo.hh:289
bool statuscheck(const string &word) const
Helper function for checking status-string contents.
Definition AnalysisInfo.hh:362
bool preliminary() const
Return true if preliminary.
Definition AnalysisInfo.hh:327
bool validated() const
Return true if validated.
Definition AnalysisInfo.hh:322
void setStatus(const std::string &status)
Set the analysis code status.
Definition AnalysisInfo.hh:308
bool random() const
Return true if includes random variations.
Definition AnalysisInfo.hh:342
bool unphysical() const
Return true if the analysis uses generator-dependent information.
Definition AnalysisInfo.hh:347
const std::string & status() const
Whether this analysis is trusted (in any way!).
Definition AnalysisInfo.hh:304
void setReentrant(bool ree=true)
Set re-entrant status.
Definition AnalysisInfo.hh:317
bool unvalidated() const
Return true if unvalidated.
Definition AnalysisInfo.hh:337
bool hepdata() const
Check if refdata comes automatically from Hepdata.
Definition AnalysisInfo.hh:352
bool obsolete() const
Return true if obsolete.
Definition AnalysisInfo.hh:332
bool reentrant() const
Return true if finalize() can be run multiple times for this analysis.
Definition AnalysisInfo.hh:313
bool multiweight() const
Check if this analysis can handle multiple weights.
Definition AnalysisInfo.hh:357
Definition LHCbCommon.hh:9
std::ostream & operator<<(std::ostream &os, const AnalysisInfo &ai)
Stream an AnalysisInfo as a text description.
Definition AnalysisInfo.hh:463
Generated on for Rivet by
