FitObjective Class Reference

Description

Holds vector of SimDataPairs (experimental data and simulation results) for use in fitting. Thereby supports simultaneous fitting of several data sets and model functions, as demonstrated in example fit52/multiple_datasets.

Definition at line 42 of file FitObjective.h.

Collaboration diagram for FitObjective:

Public Member Functions
	FitObjective ()
virtual	~FitObjective ()
SimulationResult	absoluteDifference (size_t i_item=0) const
	Returns absolute value of difference between simulation and experimental data in the form of SimulationResult. More...
void	addSimulationAndData (const PyBuilderCallback &callback, const std::vector< double > &data, const std::vector< double > &stdv, double weight=1.0)
void	addSimulationAndData (const PyBuilderCallback &callback, const std::vector< double > &data, double weight=1.0)
void	addSimulationAndData (const PyBuilderCallback &callback, const std::vector< std::vector< double >> &data, const std::vector< std::vector< double >> &stdv, double weight=1.0)
	Constructs simulation/data pair for later fit. More...
void	addSimulationAndData (const PyBuilderCallback &callback, const std::vector< std::vector< double >> &data, double weight=1.0)
	Constructs simulation/data pair for later fit. More...
bool	allPairsHaveUncertainties () const
	Returns true if all the data pairs in FitObjective instance contain uncertainties. More...
bool	containsUncertainties (size_t i_item) const
	Returns true if the specified DataPair element contains uncertainties. More...
const SimDataPair &	dataPair (size_t i_item=0) const
	Returns a reference to i-th SimDataPair. More...
virtual double	evaluate (const mumufit::Parameters &params)
virtual std::vector< double >	evaluate_residuals (const mumufit::Parameters &params)
void	execAddSimulationAndData (const simulation_builder_t &builder, const Datafield &data, std::unique_ptr< Datafield > &&stdv, double weight=1.0)
	Constructs simulation/data pair for later fit. More...
void	execSimulations (const mumufit::Parameters &params)
std::vector< double >	experimental_array () const
	Returns one-dimensional array representing merged experimental data. The area outside of the region of interest is not included, masked data is nullified. More...
SimulationResult	experimentalData (size_t i_item=0) const
	Returns experimental data in the form of SimulationResult. More...
void	finalize (const mumufit::MinimizerResult &result)
	Should be explicitly called on last iteration to notify all observers. More...
unsigned	fitObjectCount () const
void	initPlot (int every_nth, fit_observer_t &&observer)
void	initPlot (int every_nth, PyObserverCallback &callback)
	Initializes observer callback to be called on every_nth fit iteration. More...
void	initPrint (int every_nth)
	Initializes printing to standard output on every_nth fit iteration. More...
void	interruptFitting ()
bool	isCompleted () const
bool	isFirstIteration () const
bool	isInterrupted () const
IterationInfo	iterationInfo () const
mumufit::MinimizerResult	minimizerResult () const
SimulationResult	relativeDifference (size_t i_item=0) const
	Returns relative difference between simulation and experimental data in the form of SimulationResult. More...
void	setChiSquaredModule (const IChiSquaredModule &module)
void	setObjectiveMetric (const std::string &metric)
void	setObjectiveMetric (const std::string &metric, const std::string &norm)
	Sets objective metric to the FitObjective. More...
void	setObjectiveMetric (std::unique_ptr< ObjectiveMetric > metric)
std::vector< double >	simulation_array () const
	Returns one-dimensional array representing merged simulated intensities data. The area outside of the region of interest is not included, masked data is nullified. More...
SimulationResult	simulationResult (size_t i_item=0) const
	Returns simulation result in the form of SimulationResult. More...
std::vector< double >	uncertainties () const
	Returns one-dimensional array representing merged data uncertainties. The area outside of the region of interest is not included, masked data is nullified. More...
SimulationResult	uncertaintyData (size_t i_item=0) const
	Returns experimental data uncertainties in the form of SimulationResult. More...
std::vector< double >	weights_array () const
	Returns one-dimensional array representing merged user weights. The area outside of the region of interest is not included, masked data is nullified. More...

Static Public Member Functions
static std::string	availableMetricOptions ()
	Returns available metrics and norms. More...

Private Types
using	DataPairAccessor = std::vector< double >(SimDataPair::*)() const

Private Member Functions
std::vector< double >	composeArray (DataPairAccessor getter) const

Private Attributes
std::vector< SimDataPair >	m_fit_objects
std::unique_ptr< FitStatus >	m_fit_status
std::unique_ptr< IMetricWrapper >	m_metric_module

Member Typedef Documentation

DataPairAccessor

using FitObjective::DataPairAccessor = std::vector<double> (SimDataPair::*)() const

private

Definition at line 136 of file FitObjective.h.

Constructor & Destructor Documentation

FitObjective()

FitObjective::FitObjective

(

)

Definition at line 125 of file FitObjective.cpp.

    : m_metric_module(
        std::make_unique<ObjectiveMetricWrapper>(std::make_unique<PoissonLikeMetric>()))
    , m_fit_status(std::make_unique<FitStatus>(this))
{
}

~FitObjective()

FitObjective::~FitObjective ( )

virtualdefault

Member Function Documentation

absoluteDifference()

SimulationResult FitObjective::absoluteDifference

(

size_t

i_item = 0

)

const

Returns absolute value of difference between simulation and experimental data in the form of SimulationResult.

Definition at line 224 of file FitObjective.cpp.

{
    return dataPair(i_item).absoluteDifference();
}

References SimDataPair::absoluteDifference(), and dataPair().

Here is the call graph for this function:

addSimulationAndData() [1/4]

void FitObjective::addSimulationAndData	(	const PyBuilderCallback &	callback,
		const std::vector< double > &	data,
		const std::vector< double > &	stdv,
		double	weight = 1.0
	)

Definition at line 170 of file FitObjective.cpp.

{
    execAddSimulationAndData(simulationBuilder(callback), *DataUtils::Array::createPField1D(data),
                             DataUtils::Array::createPField1D(stdv), weight);
}

References DataUtils::Array::createPField1D(), and execAddSimulationAndData().

Here is the call graph for this function:

addSimulationAndData() [2/4]

void FitObjective::addSimulationAndData	(	const PyBuilderCallback &	callback,
		const std::vector< double > &	data,
		double	weight = 1.0
	)

Definition at line 155 of file FitObjective.cpp.

{
    execAddSimulationAndData(simulationBuilder(callback), *DataUtils::Array::createPField1D(data),
                             nullptr, weight);
}

References DataUtils::Array::createPField1D(), and execAddSimulationAndData().

Here is the call graph for this function:

addSimulationAndData() [3/4]

void FitObjective::addSimulationAndData	(	const PyBuilderCallback &	callback,
		const std::vector< std::vector< double >> &	data,
		const std::vector< std::vector< double >> &	stdv,
		double	weight = 1.0
	)

Constructs simulation/data pair for later fit.

Parameters

callback	simulation builder capable of producing simulations
data	experimental data array
stdv	data uncertainties array
weight	weight of dataset in metric calculations

Definition at line 162 of file FitObjective.cpp.

{
    execAddSimulationAndData(simulationBuilder(callback), *DataUtils::Array::createPField2D(data),
                             DataUtils::Array::createPField2D(stdv), weight);
}

References DataUtils::Array::createPField2D(), and execAddSimulationAndData().

Here is the call graph for this function:

addSimulationAndData() [4/4]

void FitObjective::addSimulationAndData	(	const PyBuilderCallback &	callback,
		const std::vector< std::vector< double >> &	data,
		double	weight = 1.0
	)

Constructs simulation/data pair for later fit.

Parameters

callback	simulation builder capable of producing simulations
data	experimental data array
weight	weight of dataset in metric calculations

Definition at line 148 of file FitObjective.cpp.

{
    execAddSimulationAndData(simulationBuilder(callback), *DataUtils::Array::createPField2D(data),
                             nullptr, weight);
}

References DataUtils::Array::createPField2D(), and execAddSimulationAndData().

Here is the call graph for this function:

allPairsHaveUncertainties()

bool FitObjective::allPairsHaveUncertainties

(

)

const

Returns true if all the data pairs in FitObjective instance contain uncertainties.

Definition at line 366 of file FitObjective.cpp.

{
    bool result = true;
    for (size_t i = 0, size = fitObjectCount(); i < size; ++i)
        result = result && dataPair(i).containsUncertainties();
    return result;
}

References SimDataPair::containsUncertainties(), dataPair(), and fitObjectCount().

Here is the call graph for this function:

availableMetricOptions()

std::string FitObjective::availableMetricOptions ( )

static

Returns available metrics and norms.

Definition at line 375 of file FitObjective.cpp.

{
    return ObjectiveMetricUtils::availableMetricOptions();
}

References ObjectiveMetricUtils::availableMetricOptions().

Here is the call graph for this function:

composeArray()

std::vector< double > FitObjective::composeArray ( DataPairAccessor  getter ) const

private

Definition at line 380 of file FitObjective.cpp.

{
    const size_t n_objs = m_fit_objects.size();
    if (n_objs == 0)
        return {};
    if (n_objs == 1)
        return (m_fit_objects[0].*getter)();
 
    std::vector<double> result;
    for (const auto& pair : m_fit_objects) {
        std::vector<double> array = (pair.*getter)();
        std::move(array.begin(), array.end(), std::back_inserter(result));
    }
    return result;
}

References m_fit_objects.

Referenced by experimental_array(), simulation_array(), uncertainties(), and weights_array().

containsUncertainties()

bool FitObjective::containsUncertainties

(

size_t

i_item

)

const

Returns true if the specified DataPair element contains uncertainties.

Definition at line 360 of file FitObjective.cpp.

{
    return dataPair(i_item).containsUncertainties();
}

References SimDataPair::containsUncertainties(), and dataPair().

Here is the call graph for this function:

dataPair()

const SimDataPair & FitObjective::dataPair

(

size_t

i_item = 0

)

const

Returns a reference to i-th SimDataPair.

Definition at line 257 of file FitObjective.cpp.

{
    return m_fit_objects.at(i_item);
}

References m_fit_objects.

Referenced by absoluteDifference(), allPairsHaveUncertainties(), containsUncertainties(), experimentalData(), relativeDifference(), simulationResult(), and uncertaintyData().

evaluate()

double FitObjective::evaluate ( const mumufit::Parameters &  params )

virtual

Definition at line 178 of file FitObjective.cpp.

{
    execSimulations(params);
    const double metric_value = m_metric_module->compute(m_fit_objects, params.size());
    m_fit_status->update(params, metric_value);
    return metric_value;
}

References execSimulations(), m_fit_objects, m_fit_status, m_metric_module, and mumufit::Parameters::size().

Referenced by evaluate_residuals().

Here is the call graph for this function:

evaluate_residuals()

std::vector< double > FitObjective::evaluate_residuals ( const mumufit::Parameters &  params )

virtual

Definition at line 186 of file FitObjective.cpp.

{
    evaluate(params);
 
    std::vector<double> result = experimental_array(); // init result with experimental data values
    const std::vector<double> sim_values = simulation_array();
    std::transform(result.begin(), result.end(), sim_values.begin(), result.begin(),
                   [](double lhs, double rhs) { return lhs - rhs; });
    return result;
}

References evaluate(), experimental_array(), and simulation_array().

Here is the call graph for this function:

execAddSimulationAndData()

void FitObjective::execAddSimulationAndData	(	const simulation_builder_t &	builder,
		const Datafield &	data,
		std::unique_ptr< Datafield > &&	stdv,
		double	weight = 1.0
	)

Constructs simulation/data pair for later fit.

Parameters

builder	simulation builder capable of producing simulations
data	experimental data array
stdv	data uncertainties array
weight	weight of dataset in metric calculations

Should be private, but is used in several tests.

Definition at line 141 of file FitObjective.cpp.

{
    m_fit_objects.emplace_back(builder, data, std::move(stdv), weight);
}

References m_fit_objects.

Referenced by addSimulationAndData().

execSimulations()

void FitObjective::execSimulations

(

const mumufit::Parameters &

params

)

Definition at line 318 of file FitObjective.cpp.

{
    if (m_fit_status->isInterrupted())
        throw std::runtime_error("Fitting was interrupted by the user.");
 
    if (m_fit_objects.empty())
        throw std::runtime_error("FitObjective::execSimulations() -> Error. "
                                 "No simulation/data defined.");
 
    for (auto& obj : m_fit_objects)
        obj.execSimulation(params);
}

References m_fit_objects, and m_fit_status.

Referenced by evaluate().

experimental_array()

std::vector< double > FitObjective::experimental_array

(

)

const

Returns one-dimensional array representing merged experimental data. The area outside of the region of interest is not included, masked data is nullified.

Definition at line 231 of file FitObjective.cpp.

{
    return composeArray(&SimDataPair::experimental_array);
}

References composeArray(), and SimDataPair::experimental_array().

Referenced by evaluate_residuals().

Here is the call graph for this function:

experimentalData()

SimulationResult FitObjective::experimentalData

(

size_t

i_item = 0

)

const

Returns experimental data in the form of SimulationResult.

Definition at line 204 of file FitObjective.cpp.

{
    return dataPair(i_item).experimentalData();
}

References dataPair(), and SimDataPair::experimentalData().

Here is the call graph for this function:

finalize()

void FitObjective::finalize

(

const mumufit::MinimizerResult &

result

)

Should be explicitly called on last iteration to notify all observers.

Definition at line 293 of file FitObjective.cpp.

{
    m_fit_status->finalize(result);
}

References m_fit_status.

fitObjectCount()

unsigned FitObjective::fitObjectCount

(

)

const

Definition at line 298 of file FitObjective.cpp.

{
    return static_cast<unsigned>(m_fit_objects.size());
}

References m_fit_objects.

Referenced by allPairsHaveUncertainties().

initPlot() [1/2]

void FitObjective::initPlot	(	int	every_nth,
		fit_observer_t &&	observer
	)

Definition at line 267 of file FitObjective.cpp.

{
    m_fit_status->addObserver(every_nth, std::move(observer));
}

References m_fit_status.

initPlot() [2/2]

void FitObjective::initPlot	(	int	every_nth,
		PyObserverCallback &	callback
	)

Initializes observer callback to be called on every_nth fit iteration.

Definition at line 272 of file FitObjective.cpp.

{
    fit_observer_t observer = [&](const FitObjective& objective) { callback.update(objective); };
    m_fit_status->addObserver(every_nth, std::move(observer));
}

References m_fit_status, and PyObserverCallback::update().

Here is the call graph for this function:

initPrint()

void FitObjective::initPrint

(

int

every_nth

)

Initializes printing to standard output on every_nth fit iteration.

Definition at line 262 of file FitObjective.cpp.

{
    m_fit_status->initPrint(every_nth);
}

References m_fit_status.

interruptFitting()

void FitObjective::interruptFitting

(

)

Definition at line 303 of file FitObjective.cpp.

{
    m_fit_status->setInterrupted();
}

References m_fit_status.

isCompleted()

bool FitObjective::isCompleted

(

)

const

Definition at line 278 of file FitObjective.cpp.

{
    return m_fit_status->isCompleted();
}

References m_fit_status.

Referenced by FitPrintService::print().

isFirstIteration()

bool FitObjective::isFirstIteration

(

)

const

Definition at line 313 of file FitObjective.cpp.

{
    return iterationInfo().iterationCount() == 1;
}

References IterationInfo::iterationCount(), and iterationInfo().

Referenced by FitPrintService::print().

Here is the call graph for this function:

isInterrupted()

bool FitObjective::isInterrupted

(

)

const

Definition at line 308 of file FitObjective.cpp.

{
    return m_fit_status->isInterrupted();
}

References m_fit_status.

iterationInfo()

IterationInfo FitObjective::iterationInfo

(

)

const

Definition at line 283 of file FitObjective.cpp.

{
    return m_fit_status->iterationInfo();
}

References m_fit_status.

Referenced by isFirstIteration(), FitPrintService::iterationHeaderString(), and FitPrintService::parameterString().

minimizerResult()

mumufit::MinimizerResult FitObjective::minimizerResult

(

)

const

Definition at line 288 of file FitObjective.cpp.

{
    return m_fit_status->minimizerResult();
}

References m_fit_status.

Referenced by FitPrintService::fitResultString().

relativeDifference()

SimulationResult FitObjective::relativeDifference

(

size_t

i_item = 0

)

const

Returns relative difference between simulation and experimental data in the form of SimulationResult.

Definition at line 217 of file FitObjective.cpp.

{
    return dataPair(i_item).relativeDifference();
}

References dataPair(), and SimDataPair::relativeDifference().

Here is the call graph for this function:

setChiSquaredModule()

void FitObjective::setChiSquaredModule

(

const IChiSquaredModule &

module

)

Definition at line 331 of file FitObjective.cpp.

{
    std::cout << "Warning in FitObjective::setChiSquaredModule: setChiSquaredModule is deprecated "
                 "and will be removed in future versions. Please use "
                 "FitObjective::setObjectiveMetric instead."
              << std::endl;
 
    std::unique_ptr<IChiSquaredModule> chi_module(module.clone());
    m_metric_module = std::make_unique<ChiModuleWrapper>(std::move(chi_module));
}

References IChiSquaredModule::clone(), and m_metric_module.

Here is the call graph for this function:

setObjectiveMetric() [1/3]

void FitObjective::setObjectiveMetric

(

const std::string &

metric

)

Definition at line 347 of file FitObjective.cpp.

{
    m_metric_module = std::make_unique<ObjectiveMetricWrapper>(
        ObjectiveMetricUtils::createMetric(metric, ObjectiveMetricUtils::defaultNormName()));
}

References ObjectiveMetricUtils::createMetric(), ObjectiveMetricUtils::defaultNormName(), and m_metric_module.

Here is the call graph for this function:

setObjectiveMetric() [2/3]

void FitObjective::setObjectiveMetric	(	const std::string &	metric,
		const std::string &	norm
	)

Sets objective metric to the FitObjective.

Parameters

metric	metric name
norm	metric norm name (defaults to L2-norm)

Definition at line 353 of file FitObjective.cpp.

{
    m_metric_module =
        std::make_unique<ObjectiveMetricWrapper>(ObjectiveMetricUtils::createMetric(metric, norm));
}

References ObjectiveMetricUtils::createMetric(), and m_metric_module.

Here is the call graph for this function:

setObjectiveMetric() [3/3]

void FitObjective::setObjectiveMetric

(

std::unique_ptr< ObjectiveMetric >

metric

)

Definition at line 342 of file FitObjective.cpp.

{
    m_metric_module = std::make_unique<ObjectiveMetricWrapper>(std::move(metric));
}

References m_metric_module.

simulation_array()

std::vector< double > FitObjective::simulation_array

(

)

const

Returns one-dimensional array representing merged simulated intensities data. The area outside of the region of interest is not included, masked data is nullified.

Definition at line 238 of file FitObjective.cpp.

{
    return composeArray(&SimDataPair::simulation_array);
}

References composeArray(), and SimDataPair::simulation_array().

Referenced by evaluate_residuals().

Here is the call graph for this function:

simulationResult()

SimulationResult FitObjective::simulationResult

(

size_t

i_item = 0

)

const

Returns simulation result in the form of SimulationResult.

Definition at line 198 of file FitObjective.cpp.

{
    return dataPair(i_item).simulationResult();
}

References dataPair(), and SimDataPair::simulationResult().

Here is the call graph for this function:

uncertainties()

std::vector< double > FitObjective::uncertainties

(

)

const

Returns one-dimensional array representing merged data uncertainties. The area outside of the region of interest is not included, masked data is nullified.

Definition at line 245 of file FitObjective.cpp.

{
    return composeArray(&SimDataPair::uncertainties_array);
}

References composeArray(), and SimDataPair::uncertainties_array().

Here is the call graph for this function:

uncertaintyData()

SimulationResult FitObjective::uncertaintyData

(

size_t

i_item = 0

)

const

Returns experimental data uncertainties in the form of SimulationResult.

Definition at line 210 of file FitObjective.cpp.

{
    return dataPair(i_item).uncertainties();
}

References dataPair(), and SimDataPair::uncertainties().

Here is the call graph for this function:

weights_array()

std::vector< double > FitObjective::weights_array

(

)

const

Returns one-dimensional array representing merged user weights. The area outside of the region of interest is not included, masked data is nullified.

Definition at line 252 of file FitObjective.cpp.

{
    return composeArray(&SimDataPair::user_weights_array);
}

References composeArray(), and SimDataPair::user_weights_array().

Here is the call graph for this function:

Member Data Documentation

m_fit_objects

std::vector<SimDataPair> FitObjective::m_fit_objects

private

Definition at line 140 of file FitObjective.h.

Referenced by composeArray(), dataPair(), evaluate(), execAddSimulationAndData(), execSimulations(), and fitObjectCount().

m_fit_status

std::unique_ptr<FitStatus> FitObjective::m_fit_status

private

Definition at line 142 of file FitObjective.h.

Referenced by evaluate(), execSimulations(), finalize(), initPlot(), initPrint(), interruptFitting(), isCompleted(), isInterrupted(), iterationInfo(), and minimizerResult().

m_metric_module

std::unique_ptr<IMetricWrapper> FitObjective::m_metric_module

private

Definition at line 141 of file FitObjective.h.

Referenced by evaluate(), setChiSquaredModule(), and setObjectiveMetric().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sim/Fitting/FitObjective.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sim/Fitting/FitObjective.cpp