AmpTools
Public Member Functions | List of all members
CoherentSumInfo Class Reference
IUAmpTools

#include <ConfigurationInfo.h>

Public Member Functions

 CoherentSumInfo (const string &reactionName, const string &sumName)
 
string reactionName () const
 
string sumName () const
 
string fullName () const
 
void display (string fileName="", bool append=true)
 
void clear ()
 

Detailed Description

This class holds all information for a specific coherent sum inside of a final state. Each coherent sum is defined by the reaction that it is associated with and its name. All sums for a particular reaction must have unique names. In the construction of the intensity for a particular reaction, all amplitudes within a coherent sum are added coherently (with interference) $ \left| \sum_i V_i A_i \right|^2 $ for amplitudes and production parameters $ A_i $ and $ V_i $. The individual coherent sums within a reaction are then added incoherently, e.g. $ \sum_\beta \left| \sum_i V_{i,\beta} A_{i,\beta} \right|^2 $, where $ \beta $ indexes the coherent sums and i indexes the amplitudes.

Definition at line 690 of file ConfigurationInfo.h.

Constructor & Destructor Documentation

◆ CoherentSumInfo()

CoherentSumInfo::CoherentSumInfo ( const string &  reactionName,
const string &  sumName 
)
inline

The constructor for the class

Parameters
[in]reactionNamethe name of the reaction to associate the sum with
[in]sumNamethe name of the sum, must be unique to the reaction

Definition at line 700 of file ConfigurationInfo.h.

Member Function Documentation

◆ clear()

void CoherentSumInfo::clear ( )
inline

Currently does nothing – any future cleanup needed to return a coherent sum to its freshly-created state shoudl be done here.

Definition at line 743 of file ConfigurationInfo.h.

Here is the caller graph for this function:

◆ display()

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

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

Parameters
[in]fileName(optional) name of file to write sum 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 714 of file ConfigurationInfo.cc.

◆ fullName()

string CoherentSumInfo::fullName ( ) const
inline

This returns the "full name" of the sum. It is a string formed by concatenating the reaction name with the sum num name using a double colon: reactionName::sumName

Definition at line 724 of file ConfigurationInfo.h.

Here is the caller graph for this function:

◆ reactionName()

string CoherentSumInfo::reactionName ( ) const
inline

This returns the name of the reaction that the sum is associated with.

Definition at line 711 of file ConfigurationInfo.h.

◆ sumName()

string CoherentSumInfo::sumName ( ) const
inline

This returns the name of the sum.

Definition at line 716 of file ConfigurationInfo.h.

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