ChiModuleWrapper Class Reference

Metric wrapper for back-compaptibility with old scripts. More...

Inheritance diagram for ChiModuleWrapper:

Collaboration diagram for ChiModuleWrapper:

Public Member Functions
	ChiModuleWrapper (std::unique_ptr< IChiSquaredModule > module)
double	compute (const std::vector< SimDataPair > &fit_objects, size_t n_pars) const override

Private Attributes
std::unique_ptr< IChiSquaredModule >	m_module

Detailed Description

Metric wrapper for back-compaptibility with old scripts.

Definition at line 31 of file FitObjective.cpp.

Constructor & Destructor Documentation

ChiModuleWrapper()

ChiModuleWrapper::ChiModuleWrapper ( std::unique_ptr< IChiSquaredModule >  module )

explicit

Definition at line 318 of file FitObjective.cpp.

    : IMetricWrapper(), m_module(std::move(module))
{
    if (!m_module)
        throw std::runtime_error("Error in ChiModuleWrapper: empty chi square module passed");
}

References m_module.

Member Function Documentation

compute()

double ChiModuleWrapper::compute ( const std::vector< SimDataPair > &  fit_objects, size_t  n_pars  ) const

overridevirtual

Implements IMetricWrapper.

Definition at line 325 of file FitObjective.cpp.

{
    size_t n_points = 0;
    double result = 0.0;
    for (auto& obj : fit_objects) {
        const auto sim_array = obj.simulation_array();
        const auto exp_array = obj.experimental_array();
        const auto weights = obj.user_weights_array();
        const size_t n_elements = sim_array.size();
        for (size_t i = 0; i < n_elements; ++i) {
            double value = m_module->residual(sim_array[i], exp_array[i], weights[i]);
            result += value * value;
        }
        n_points += n_elements;
    }
 
    int fnorm = static_cast<int>(n_points) - static_cast<int>(n_pars);
    if (fnorm <= 0)
        throw std::runtime_error("Error in ChiModuleWrapper: Normalization shall be positive");
 
    return result / fnorm;
}

References m_module.

Member Data Documentation

m_module

std::unique_ptr<IChiSquaredModule> ChiModuleWrapper::m_module

private

Definition at line 37 of file FitObjective.cpp.

Referenced by ChiModuleWrapper(), and compute().

---

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

• /home/www/ba/Core/Fitting/FitObjective.cpp