AmpTools
ReactionInfo Class Reference

#include <ConfigurationInfo.h>

Public Member Functions

 ReactionInfo (const string &reactionName, const vector< string > &particleList)
 
string reactionName () const
 
const vector< string > & particleList () const
 
const pair< string, vector< string > > & data () const
 
const pair< string, vector< string > > & bkgnd () const
 
const pair< string, vector< string > > & genMC () const
 
const pair< string, vector< string > > & accMC () const
 
string normIntFile () const
 
bool normIntFileInput () const
 
void display (string fileName="", bool append=true)
 
void clear ()
 
void setParticleList (const vector< string > &particleList)
 
void setData (const string &classname, const vector< string > &args)
 
void setBkgnd (const string &classname, const vector< string > &args)
 
void setGenMC (const string &classname, const vector< string > &args)
 
void setAccMC (const string &classname, const vector< string > &args)
 
void setNormIntFile (const string &normIntFile, bool input=false)
 

Detailed Description

The reaction info holds all information that is specific to a particular reaction or final state. It is typically characterized by a set of unique observable particles in the detector. In order to create a reaction it must be given a name that is unique in the fit and also a list of strings that identify the particles.

Definition at line 489 of file ConfigurationInfo.h.

Constructor & Destructor Documentation

◆ ReactionInfo()

ReactionInfo::ReactionInfo ( const string &  reactionName,
const vector< string > &  particleList 
)
inline

The constructor.

Parameters
[in]reactionNamea unique name to identify this reaction
[in]particleLista list of particles that define the reaction

Definition at line 499 of file ConfigurationInfo.h.

Member Function Documentation

◆ accMC()

const pair< string, vector<string> >& ReactionInfo::accMC ( ) const
inline

Returns the name of a DataReader and a vector of arguments (e.g. file names) to that DataReader for ACCEPTED MC associated with this reaction.

See also
setAccMC

Definition at line 552 of file ConfigurationInfo.h.

Here is the caller graph for this function:

◆ bkgnd()

const pair< string, vector<string> >& ReactionInfo::bkgnd ( ) const
inline

Returns the name of a DataReader and a vector of arguments (e.g. file names) to that DataReader for BACKGROUND associated with this reaction.

See also
setBkgnd

Definition at line 536 of file ConfigurationInfo.h.

Here is the caller graph for this function:

◆ clear()

void ReactionInfo::clear ( )

Clears all internal data for this reaction

Definition at line 914 of file ConfigurationInfo.cc.

Here is the caller graph for this function:

◆ data()

const pair< string, vector<string> >& ReactionInfo::data ( ) const
inline

Returns the name of a DataReader and a vector of arguments (e.g. file names) to that DataReader for DATA associated with this reaction.

See also
setData

Definition at line 528 of file ConfigurationInfo.h.

Here is the caller graph for this function:

◆ display()

void ReactionInfo::display ( string  fileName = "",
bool  append = true 
)

Displays information about this reaction to the screen or writes it to file if a file name is passed in.

Parameters
[in]fileName(optional) name of file to write reaction info to
[in]append(optional) if true (default) information will be appended to the file, if false is passed in the file will be overwritten

Definition at line 661 of file ConfigurationInfo.cc.

◆ genMC()

const pair< string, vector<string> >& ReactionInfo::genMC ( ) const
inline

Returns the name of a DataReader and a vector of arguments (e.g. file names) to that DataReader for GENERATED MC associated with this reaction.

See also
setGenMC

Definition at line 544 of file ConfigurationInfo.h.

Here is the caller graph for this function:

◆ normIntFile()

string ReactionInfo::normIntFile ( ) const
inline

Returns the name of the file that the normalization integral cache is written out to.

See also
setNormIntFile

Definition at line 560 of file ConfigurationInfo.h.

Here is the caller graph for this function:

◆ normIntFileInput()

bool ReactionInfo::normIntFileInput ( ) const
inline

Returns a boolean that indicates whether this normIntFile should be used as input (true) or not (false).

See also
setNormIntFile

Definition at line 568 of file ConfigurationInfo.h.

Here is the caller graph for this function:

◆ particleList()

const vector<string>& ReactionInfo::particleList ( ) const
inline

This returns the list of particles that characterize the reaction.

See also
setParticleList

Definition at line 517 of file ConfigurationInfo.h.

Here is the caller graph for this function:

◆ reactionName()

string ReactionInfo::reactionName ( ) const
inline

This returns the unique name of the reaction.

Definition at line 510 of file ConfigurationInfo.h.

Here is the caller graph for this function:

◆ setAccMC()

void ReactionInfo::setAccMC ( const string &  classname,
const vector< string > &  args 
)
inline

Sets the name of a DataReader and a vector of arguments (e.g. file names) to that DataReader for ACCEPTED MC associated with this reaction.

Parameters
[in]classnamethe name of the DataReader that will read ACCEPTED MC
[in]argsarguments to the DataReader
See also
accMC

Definition at line 645 of file ConfigurationInfo.h.

◆ setBkgnd()

void ReactionInfo::setBkgnd ( const string &  classname,
const vector< string > &  args 
)
inline

Sets the name of a DataReader and a vector of arguments (e.g. file names) to that DataReader for BACKGROUND associated with this reaction.

Parameters
[in]classnamethe name of the DataReader that will read DATA
[in]argsarguments to the DataReader
See also
data

Definition at line 621 of file ConfigurationInfo.h.

◆ setData()

void ReactionInfo::setData ( const string &  classname,
const vector< string > &  args 
)
inline

Sets the name of a DataReader and a vector of arguments (e.g. file names) to that DataReader for DATA associated with this reaction.

Parameters
[in]classnamethe name of the DataReader that will read DATA
[in]argsarguments to the DataReader
See also
data

Definition at line 609 of file ConfigurationInfo.h.

◆ setGenMC()

void ReactionInfo::setGenMC ( const string &  classname,
const vector< string > &  args 
)
inline

Sets the name of a DataReader and a vector of arguments (e.g. file names) to that DataReader for GENERATED MC associated with this reaction.

Parameters
[in]classnamethe name of the DataReader that will read GENERATED MC
[in]argsarguments to the DataReader
See also
genMC

Definition at line 633 of file ConfigurationInfo.h.

◆ setNormIntFile()

void ReactionInfo::setNormIntFile ( const string &  normIntFile,
bool  input = false 
)
inline

Sets the name of the file to use as the normalization integral cache

Parameters
[in]normIntFilename of the normalization integral file
[in]inputuse this normIntFile as input
See also
normIntFile

Definition at line 656 of file ConfigurationInfo.h.

Here is the caller graph for this function:

◆ setParticleList()

void ReactionInfo::setParticleList ( const vector< string > &  particleList)
inline

Sets the vector of strings that provides the names of the final state particles.

Parameters
[in]particleListvector of strings of final state particles
See also
particleList

Definition at line 598 of file ConfigurationInfo.h.

Here is the caller graph for this function:

The documentation for this class was generated from the following files: