ComPWA
Common Partial-Wave-Analysis Framework
ComPWA Namespace Reference

Namespaces

 Data
 
 Estimator
 
 FunctionTree
 
 Optimizer
 
 Physics
 
 Tools
 
 Utils
 

Classes

class  BadConfig
 Config is not complete. More...
 
class  BadIndex
 Index out of range. More...
 
class  BadParameter
 Parameter not existing. More...
 
class  BeyondPhsp
 Data beyond phasespace requested. More...
 
class  CorruptFile
 Input data file is corrupt or incomplete. More...
 
class  Efficiency
 Base class for efficiency description over the phase space. More...
 
struct  Event
 Data structure containing all kinematic information of a physics event. More...
 
struct  EventCollection
 
class  Exception
 ComPWA Exceptions base class. More...
 
struct  FitParameter
 
struct  FitResult
 Data structure which resembles a general fit result. More...
 
class  FourMomentum
 ComPWA four momentum class. More...
 
class  Function
 Interface template for a general Function of the form OutputType Function(InputTypes) The concept closely follows the mathematical definition of a function/mapping. More...
 
class  Kinematics
 The Kinematics interface defines the conversion of Events to a DataSet. More...
 
class  Logging
 Logging class provides an interface for logging all over the framework. More...
 
struct  Parameter
 
class  ParameterFixed
 Parameter cannot be changed. More...
 
class  ParameterOutOfBound
 Parameter out of bound. More...
 
class  ParticleProperties
 
class  PhaseSpaceEventGenerator
 Interface class for PHSP event generators. More...
 
class  ProgressBar
 
class  Resolution
 
class  StdUniformRealGenerator
 
class  TableFormatter
 
class  TreeBuildError
 Error in tree at construction. More...
 
class  UniformRealNumberGenerator
 
class  UnitEfficiency
 Efficiency object with unit efficiency all over the phase space. More...
 
class  WrongParType
 Parameter of wrong type. More...
 
class  WrongVariableID
 Variable not found. More...
 
class  ZeroResolution
 

Typedefs

using FitParameterList = std::vector< FitParameter< double > >
 
using DataMap = std::unordered_map< std::string, std::vector< double > >
 
using Intensity = Function< std::vector< double >, DataMap >
 An Intensity is just a Function that takes a list of data vectors and returns a list of intensities (double) More...
 
typedef int pid
 Particle ID. More...
 
using ParticleList = std::set< ParticleProperties >
 
typedef std::vector< unsigned int > IndexList
 

Functions

std::ostream & operator<< (std::ostream &os, const Event &ev)
 
double calculateInvariantMass (const Event &ev)
 
double getMaximumSampleWeight (const EventCollection &Sample)
 
bool isValid (const FitParameterList &FitParameters, const std::vector< ComPWA::Parameter > &EstimatorParameters)
 
std::string makeFitParameterString (ComPWA::FitParameter< double > p)
 
std::ostream & operator<< (std::ostream &os, const FitResult &Result)
 
FitResult load (std::string filename)
 
void initializeWithFitResult (ComPWA::Intensity &Intens, ComPWA::FitResult Result)
 
void enableDisableLvl (el::Logger *logger, std::array< std::string, 5 > levels)
 Enable or disable levels TRACE, DEBUG, INFO, WARNING, ERROR, FATAL. More...
 
void insertParticles (ParticleList &list, const boost::property_tree::ptree &pt)
 Read list of particles from a boost::property_tree. More...
 
void insertParticles (ParticleList &list, std::stringstream &Stream)
 insert particles from a stringstream into a ParticleList More...
 
void insertParticles (ParticleList &list, std::string FileName)
 insert particles from a xml file into a ParticleList More...
 
ParticleList readParticles (std::stringstream &Stream)
 Read list of particles from a stringstream For some reason the boost xml parser needs a non-const reference. More...
 
ParticleList readParticles (std::string FileName)
 Read list of particles from a xml file. More...
 
ParticleList readParticles (boost::property_tree::ptree &pt)
 Read list of particles from a boost::property_tree::ptree More...
 
std::ostream & operator<< (std::ostream &os, const ParticleList &p)
 
const ParticlePropertiesfindParticle (const ParticleList &list, pid Pid)
 
const ParticlePropertiesfindParticle (const ParticleList &list, std::string refname)
 

Typedef Documentation

◆ DataMap

using ComPWA::DataMap = typedef std::unordered_map<std::string, std::vector<double> >

Definition at line 15 of file Function.hpp.

◆ FitParameterList

using ComPWA::FitParameterList = typedef std::vector<FitParameter<double> >

Definition at line 50 of file FitParameter.hpp.

◆ IndexList

typedef std::vector<unsigned int> ComPWA::IndexList

Definition at line 20 of file SubSystem.hpp.

◆ Intensity

using ComPWA::Intensity = typedef Function<std::vector<double>, DataMap>

An Intensity is just a Function that takes a list of data vectors and returns a list of intensities (double)

Definition at line 40 of file Function.hpp.

◆ ParticleList

using ComPWA::ParticleList = typedef std::set<ParticleProperties>

Definition at line 84 of file Properties.hpp.

◆ pid

typedef int ComPWA::pid

Particle ID.

Usually the PIDs from PDG are used here: http://pdg.lbl.gov/mc_particleId_contents.html

Definition at line 22 of file Properties.hpp.

Function Documentation

◆ calculateInvariantMass()

double ComPWA::calculateInvariantMass ( const Event ev)

Definition at line 20 of file Event.cpp.

◆ enableDisableLvl()

void ComPWA::enableDisableLvl ( el::Logger *  logger,
std::array< std::string, 5 >  levels 
)

Enable or disable levels TRACE, DEBUG, INFO, WARNING, ERROR, FATAL.

An array of strings is passed. E.g {"0","1","1","1","1","1"} to disable TRACE and enable all other levels.

Definition at line 46 of file Logging.cpp.

◆ findParticle() [1/2]

const ParticleProperties& ComPWA::findParticle ( const ParticleList list,
pid  Pid 
)
inline

Definition at line 93 of file Properties.hpp.

◆ findParticle() [2/2]

const ParticleProperties& ComPWA::findParticle ( const ParticleList list,
std::string  refname 
)
inline

Definition at line 104 of file Properties.hpp.

◆ getMaximumSampleWeight()

double ComPWA::getMaximumSampleWeight ( const EventCollection Sample)

Definition at line 27 of file Event.cpp.

◆ initializeWithFitResult()

void ComPWA::initializeWithFitResult ( ComPWA::Intensity Intens,
ComPWA::FitResult  Result 
)

Definition at line 166 of file FitResult.cpp.

◆ insertParticles() [1/3]

void ComPWA::insertParticles ( ParticleList list,
const boost::property_tree::ptree &  pt 
)

Read list of particles from a boost::property_tree.

insert particles from a boost::property_tree into a ParticleList

Definition at line 95 of file Properties.cpp.

◆ insertParticles() [2/3]

void ComPWA::insertParticles ( ParticleList list,
std::stringstream &  Stream 
)

insert particles from a stringstream into a ParticleList

Definition at line 139 of file Properties.cpp.

◆ insertParticles() [3/3]

void ComPWA::insertParticles ( ParticleList list,
std::string  FileName 
)

insert particles from a xml file into a ParticleList

Definition at line 145 of file Properties.cpp.

◆ isValid()

bool ComPWA::isValid ( const FitParameterList FitParameters,
const std::vector< ComPWA::Parameter > &  EstimatorParameters 
)
inline

Definition at line 52 of file FitParameter.hpp.

◆ load()

FitResult ComPWA::load ( std::string  filename)

Definition at line 157 of file FitResult.cpp.

◆ makeFitParameterString()

std::string ComPWA::makeFitParameterString ( ComPWA::FitParameter< double >  p)

Definition at line 20 of file FitResult.cpp.

◆ operator<<() [1/3]

std::ostream & ComPWA::operator<< ( std::ostream &  os,
const Event ev 
)

Definition at line 11 of file Event.cpp.

◆ operator<<() [2/3]

std::ostream& ComPWA::operator<< ( std::ostream &  os,
const FitResult Result 
)

Definition at line 35 of file FitResult.cpp.

◆ operator<<() [3/3]

std::ostream& ComPWA::operator<< ( std::ostream &  os,
const ParticleList p 
)
inline

Definition at line 86 of file Properties.hpp.

◆ readParticles() [1/3]

ParticleList ComPWA::readParticles ( std::stringstream &  Stream)

Read list of particles from a stringstream For some reason the boost xml parser needs a non-const reference.

Definition at line 151 of file Properties.cpp.

◆ readParticles() [2/3]

ParticleList ComPWA::readParticles ( std::string  FileName)

Read list of particles from a xml file.

Definition at line 157 of file Properties.cpp.

◆ readParticles() [3/3]

ParticleList ComPWA::readParticles ( boost::property_tree::ptree &  tree)

Read list of particles from a boost::property_tree::ptree

Definition at line 163 of file Properties.cpp.