Thermal-FIST 1.5
Package for hadron resonance gas model applications
Loading...
Searching...
No Matches
thermalfist::FittedQuantity Struct Reference

Structure describing the measurement to be fitted or compared to model. More...

#include <ThermalModelFitQuantities.h>

Public Types

enum  FittedQuantityType { Multiplicity = 0 , Ratio = 1 }
 Yield (multiplicity) or ratio. More...
 

Public Member Functions

 FittedQuantity ()
 Default constructor.
 
 FittedQuantity (const ExperimentMultiplicity &op)
 
 FittedQuantity (const ExperimentRatio &op)
 
double Value () const
 Value of the measurement.
 
double ValueError () const
 Error of the measurement.
 

Public Attributes

FittedQuantityType type
 Whether it is a yield (multiplicity) or a ratio.
 
bool toFit
 Whether this quantity contributes to the \( \chi^2 \) of a fit.
 
ExperimentMultiplicity mult
 The yield data. Used if type is FittedQuantityType::Multiplicity.
 
ExperimentRatio ratio
 The ratio data. Used if type is FittedQuantityType::Ratio.
 

Detailed Description

Structure describing the measurement to be fitted or compared to model.

Definition at line 122 of file ThermalModelFitQuantities.h.

Member Enumeration Documentation

◆ FittedQuantityType

Yield (multiplicity) or ratio.

Enumerator
Multiplicity 
Ratio 

Definition at line 124 of file ThermalModelFitQuantities.h.

Constructor & Destructor Documentation

◆ FittedQuantity() [1/3]

thermalfist::FittedQuantity::FittedQuantity ( )
inline

Default constructor.

Definition at line 142 of file ThermalModelFitQuantities.h.

◆ FittedQuantity() [2/3]

thermalfist::FittedQuantity::FittedQuantity ( const ExperimentMultiplicity & op)
inline

Constructs a yield measurement

Parameters
[in]opYield measurement data

Definition at line 150 of file ThermalModelFitQuantities.h.

◆ FittedQuantity() [3/3]

thermalfist::FittedQuantity::FittedQuantity ( const ExperimentRatio & op)
inline

Constructs a yield ratio measurement

Parameters
[in]opYield ratio measurement data

Definition at line 158 of file ThermalModelFitQuantities.h.

Member Function Documentation

◆ Value()

double thermalfist::FittedQuantity::Value ( ) const
inline

Value of the measurement.

Definition at line 165 of file ThermalModelFitQuantities.h.

◆ ValueError()

double thermalfist::FittedQuantity::ValueError ( ) const
inline

Error of the measurement.

Definition at line 173 of file ThermalModelFitQuantities.h.

Member Data Documentation

◆ mult

ExperimentMultiplicity thermalfist::FittedQuantity::mult

The yield data. Used if type is FittedQuantityType::Multiplicity.

Definition at line 136 of file ThermalModelFitQuantities.h.

◆ ratio

ExperimentRatio thermalfist::FittedQuantity::ratio

The ratio data. Used if type is FittedQuantityType::Ratio.

Definition at line 139 of file ThermalModelFitQuantities.h.

◆ toFit

bool thermalfist::FittedQuantity::toFit

Whether this quantity contributes to the \( \chi^2 \) of a fit.

Definition at line 133 of file ThermalModelFitQuantities.h.

◆ type

FittedQuantityType thermalfist::FittedQuantity::type

Whether it is a yield (multiplicity) or a ratio.

Definition at line 130 of file ThermalModelFitQuantities.h.


The documentation for this struct was generated from the following file: