group Metadata

Metadata #

More…

Functions ##

Detailed Description ##

Metadata is used for querying from the command line and also for building web pages and the analysis pages in the Rivet manual.

Functions Documentation ##

function info ##

inline const AnalysisInfo & info() const

Get the actual AnalysisInfo object in which all this metadata is stored.

function name ##

inline virtual std::string name() const

Get the name of the analysis.

Reimplements: Rivet::ProjectionApplier::name

By default this is computed by combining the results of the experiment, year and Spires ID metadata methods and you should only override it if there’s a good reason why those won’t work. If options has been set for this instance, a corresponding string is appended at the end.

function getRefDataName ##

inline virtual std::string getRefDataName() const

Get name of reference data file, which could be different from plugin name.

function setRefDataName ##

inline virtual void setRefDataName(
    const std::string & ref_data =""
)

Set name of reference data file, which could be different from plugin name.

function inspireId ##

inline virtual std::string inspireId() const

Get the Inspire ID code for this analysis.

function spiresId ##

inline virtual std::string spiresId() const

Get the SPIRES ID code for this analysis (~deprecated).

function authors ##

inline virtual std::vector< std::string > authors() const

Names & emails of paper/analysis authors.

Names and email of authors in ‘NAME ’ format. The first name in the list should be the primary contact person.

function summary ##

inline virtual std::string summary() const

Get a short description of the analysis.

Short (one sentence) description used as an index entry. Use description() to provide full descriptive paragraphs of analysis details.

function description ##

inline virtual 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.

function runInfo ##

inline virtual 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)

function experiment ##

inline virtual std::string experiment() const

Experiment which performed and published this analysis.

function collider ##

inline virtual std::string collider() const

Collider on which the experiment ran.

function year ##

inline virtual std::string year() const

When the original experimental analysis was published.

function luminosityfb ##

inline virtual double luminosityfb() const

The integrated luminosity in inverse femtobarn.

function luminosity ##

inline virtual double luminosity() const

The integrated luminosity in inverse picobarn.

function references ##

inline virtual std::vector< std::string > references() const

Journal, and preprint references.

function bibKey ##

inline virtual std::string bibKey() const

BibTeX citation key for this article.

function bibTeX ##

inline virtual std::string bibTeX() const

BibTeX citation entry for this article.

function status ##

inline virtual std::string status() const

Whether this analysis is trusted (in any way!)

function warning ##

inline virtual std::string warning() const

A warning message from the info file, if there is one.

function todos ##

inline virtual std::vector< std::string > todos() const

Any work to be done on this analysis.

function validation ##

inline virtual std::vector< std::string > validation() const

make-style commands for validating this analysis.

function reentrant ##

inline virtual bool reentrant() const

Does this analysis have a reentrant finalize()?

function refFile ##

inline virtual std::string refFile() const

Location of reference data YODA file.

function refMatch ##

inline virtual std::string refMatch() const

Positive filtering regex for ref-data HepData sync.

function refUnmatch ##

inline virtual std::string refUnmatch() const

Negative filtering regex for ref-data HepData sync.

function writerDoublePrecision ##

inline virtual std::string writerDoublePrecision() const

Positive filterin regex for setting double precision in Writer.

function requiredBeams ##

inline virtual const std::vector< PdgIdPair > & requiredBeams() const

Return the allowed pairs of incoming beams required by this analysis.

function setRequiredBeams ##

inline virtual Analysis & setRequiredBeams(
    const std::vector< PdgIdPair > & requiredBeams
)

Declare the allowed pairs of incoming beams required by this analysis.

function requiredEnergies ##

inline virtual const std::vector< std::pair< double, double > > & requiredEnergies() const

Sets of valid beam energy pairs, in GeV.

function keywords ##

inline virtual const std::vector< std::string > & keywords() const

Get vector of analysis keywords.

function setRequiredEnergies ##

inline virtual Analysis & setRequiredEnergies(
    const std::vector< std::pair< double, double > > & requiredEnergies
)

Declare the list of valid beam energy pairs, in GeV.

function info ##

inline AnalysisInfo & info()

Note: For internal use!

Get the actual AnalysisInfo object in which all this metadata is stored (non-const).

Updated on 2022-08-07 at 20:17:18 +0100