class Rivet::AnalysisInfo

Rivet::AnalysisInfo #

Holder of analysis metadata.

#include <AnalysisInfo.hh>

Public Functions ##

Public Functions Documentation ##

function make ##

static unique_ptr< AnalysisInfo > make(
    const std::string & name
)

Static factory method: returns null pointer if no metadata found.

function AnalysisInfo ##

inline AnalysisInfo()

Default constructor.

function ~AnalysisInfo ##

inline ~AnalysisInfo()

function name ##

inline std::string name() const

Get the name of the analysis. By default this is computed using the experiment, year and Inspire/Spires ID metadata methods.

function setName ##

inline void setName(
    const std::string & name
)

Set the name of the analysis.

function getRefDataName ##

inline std::string getRefDataName() const

Get the reference data name of the analysis (if different from plugin name).

function setRefDataName ##

inline void setRefDataName(
    const std::string & name
)

Set the reference data name of the analysis (if different from plugin name).

function inspireId ##

inline const std::string & inspireId() const

Get the Inspire (SPIRES replacement) ID code for this analysis.

function setInspireId ##

inline void setInspireId(
    const std::string & inspireId
)

Set the Inspire (SPIRES replacement) ID code for this analysis.

function spiresId ##

inline const std::string & spiresId() const

Deprecated:

SPIRES itself is gone. Remove when all analyses migrated to I-names.

Get the SPIRES ID code for this analysis.

function setSpiresId ##

inline void setSpiresId(
    const std::string & spiresId
)

Deprecated:

SPIRES itself is gone. Remove when all analyses migrated to I-names.

Set the SPIRES ID code for this analysis.

function authors ##

inline const 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 setAuthors ##

inline void setAuthors(
    const std::vector< std::string > & authors
)

Set the author list.

function summary ##

inline const 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 setSummary ##

inline void setSummary(
    const std::string & summary
)

Set the short description for this analysis.

function description ##

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

function setDescription ##

inline void setDescription(
    const std::string & description
)

Set the full description for this analysis.

function runInfo ##

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

function setRunInfo ##

inline void setRunInfo(
    const std::string & runInfo
)

Set the full description for this analysis.

function beams ##

inline const std::vector< PdgIdPair > & beams() const

Beam particle types.

function setBeams ##

inline void setBeams(
    const std::vector< PdgIdPair > & beams
)

Set beam particle types.

function energies ##

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

Sets of valid beam energies.

function setEnergies ##

inline void setEnergies(
    const std::vector< std::pair< double, double > > & energies
)

Set the valid beam energies.

function experiment ##

inline const std::string & experiment() const

Experiment which performed and published this analysis.

function setExperiment ##

inline void setExperiment(
    const std::string & experiment
)

Set the experiment which performed and published this analysis.

function collider ##

inline const std::string & collider() const

Collider on which the experiment ran.

function setCollider ##

inline void setCollider(
    const std::string & collider
)

Set the collider on which the experiment ran.

function year ##

inline const std::string & year() const

When the original experimental analysis was published.

When the refereed paper on which this is based was published, according to Inspire-HEP.

function setYear ##

inline void setYear(
    const std::string & year
)

Set the year in which the original experimental analysis was published.

function luminosityfb ##

inline double luminosityfb() const

The integrated data luminosity of the data set in 1/fb.

function luminosity ##

inline double luminosity() const

The integrated data luminosity of the data set in 1/pb.

function setLuminosityfb ##

inline void setLuminosityfb(
    const double luminosityfb
)

Set the integrated data luminosity of the data set.

function references ##

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

Journal and preprint references.

function setReferences ##

inline void setReferences(
    const std::vector< std::string > & references
)

Set the journal and preprint reference list.

function keywords ##

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

Analysis keywords, for grouping etc.

function setKeywords ##

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

function warning ##

inline const std::string & warning() const

Any warning message.

function setWarning ##

inline void setWarning(
    const std::string warning
)

function refMatch ##

inline const std::string & refMatch() const

Positive filtering regex for ref-data HepData sync.

function setRefMatch ##

inline void setRefMatch(
    const std::string refmatch
)

function refUnmatch ##

inline const std::string & refUnmatch() const

Negative filtering regex for ref-data HepData sync.

function setRefUnmatch ##

inline void setRefUnmatch(
    const std::string refunmatch
)

function writerDoublePrecision ##

inline const std::string & writerDoublePrecision() const

Positive filtering regex for setting double precision in Writer.

function setWriterDoublePrecision ##

inline void setWriterDoublePrecision(
    const std::string dp
)

function bibKey ##

inline const std::string & bibKey() const

BibTeX citation key for this article.

function setBibKey ##

inline void setBibKey(
    const std::string & bibKey
)

Set the BibTeX citation key for this article.

function bibTeX ##

inline const std::string & bibTeX() const

BibTeX citation entry for this article.

function setBibTeX ##

inline void setBibTeX(
    const std::string & bibTeX
)

Set the BibTeX citation entry for this article.

function todos ##

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

Any work to be done on this analysis.

function setTodos ##

inline void setTodos(
    const std::vector< std::string > & todos
)

Set the to-do list.

function options ##

inline const std::vector< std::string > & options() const

Get the option list.

function validOption ##

bool validOption(
    std::string key,
    std::string val
) const

Check if the given option is valid.

function setOptions ##

inline void setOptions(
    const std::vector< std::string > & opts
)

Set the option list.

function buildOptionMap ##

void buildOptionMap()

Build a map of options to facilitate checking.

function status ##

inline const std::string & status() const

Whether this analysis is trusted (in any way!)

function setStatus ##

inline void setStatus(
    const std::string & status
)

Set the analysis code status.

function reentrant ##

inline bool reentrant() const

Return true if finalize() can be run multiple times for this analysis.

function setReentrant ##

inline void setReentrant(
    bool ree =true
)

Set re-entrant status.

function validated ##

inline bool validated() const

Return true if validated.

function preliminary ##

inline bool preliminary() const

Return true if preliminary.

function obsolete ##

inline bool obsolete() const

Return true if obsolete.

function unvalidated ##

inline bool unvalidated() const

Return true if unvalidated.

function random ##

inline bool random() const

Return true if includes random variations.

function unphysical ##

inline bool unphysical() const

Return true if the analysis uses generator-dependent information.

function hepdata ##

inline bool hepdata() const

Check if refdata comes automatically from Hepdata.

function multiweight ##

inline bool multiweight() const

Check if this analysis can handle multiple weights.

function statuscheck ##

inline bool statuscheck(
    const string & word
) const

Helper function for checking status-string contents.

function refFile ##

std::string refFile() const

Find the path to the reference-data file for this analysis.

function validation ##

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

List a series of command lines to be used for valdation.

function needsCrossSection ##

inline bool needsCrossSection() const

Deprecated:

Cross-section should now always be available from the HepMC

Return true if this analysis needs to know the process cross-section.

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