FitObjectiveBuilder Class Reference

Description

Definition at line 32 of file FitObjectiveBuilder.h.

Collaboration diagram for FitObjectiveBuilder:

Public Member Functions
	FitObjectiveBuilder (JobItem *jobItem)
	~FitObjectiveBuilder ()
void	attachObserver (std::shared_ptr< GUIFitObserver > observer)
std::unique_ptr< IChiSquaredModule >	createChiSquaredModule () const
std::unique_ptr< FitObjective >	createFitObjective () const
std::unique_ptr< IMinimizer >	createMinimizer () const
mumufit::Parameters	createParameters () const
void	interruptFitting ()
void	runFit ()

Private Member Functions
std::unique_ptr< ISimulation >	buildSimulation (const mumufit::Parameters &params) const
void	update_fit_parameters (const mumufit::Parameters &params) const

Private Attributes
std::unique_ptr< FitObjective >	m_fit_objective
JobItem *	m_jobItem
std::shared_ptr< GUIFitObserver >	m_observer

Constructor & Destructor Documentation

FitObjectiveBuilder()

FitObjectiveBuilder::FitObjectiveBuilder

(

JobItem *

jobItem

)

Definition at line 31 of file FitObjectiveBuilder.cpp.

    : m_jobItem(jobItem)
{
    ASSERT(m_jobItem->fitSuiteItem());
}

References JobItem::fitSuiteItem(), and m_jobItem.

Here is the call graph for this function:

~FitObjectiveBuilder()

FitObjectiveBuilder::~FitObjectiveBuilder ( )

default

Member Function Documentation

attachObserver()

void FitObjectiveBuilder::attachObserver

(

std::shared_ptr< GUIFitObserver >

observer

)

Definition at line 102 of file FitObjectiveBuilder.cpp.

{
    m_observer = observer;
}

References m_observer.

buildSimulation()

std::unique_ptr< ISimulation > FitObjectiveBuilder::buildSimulation ( const mumufit::Parameters &  params ) const

private

Definition at line 113 of file FitObjectiveBuilder.cpp.

{
    static std::mutex build_simulation_mutex;
    std::unique_lock<std::mutex> lock(build_simulation_mutex);
 
    update_fit_parameters(params);
    return GUI::Transform::ToCore::itemsToSimulation(
        m_jobItem->sampleItem(), m_jobItem->instrumentItem(), m_jobItem->simulationOptionsItem());
}

References JobItem::instrumentItem(), GUI::Transform::ToCore::itemsToSimulation(), m_jobItem, JobItem::sampleItem(), JobItem::simulationOptionsItem(), and update_fit_parameters().

Referenced by createFitObjective().

Here is the call graph for this function:

createChiSquaredModule()

std::unique_ptr<IChiSquaredModule> FitObjectiveBuilder::createChiSquaredModule

(

)

const

createFitObjective()

std::unique_ptr< FitObjective > FitObjectiveBuilder::createFitObjective

(

)

const

Definition at line 70 of file FitObjectiveBuilder.cpp.

{
    auto result = std::make_unique<FitObjective>();
 
    simulation_builder_t builder = [&](const mumufit::Parameters& params) {
        return buildSimulation(params);
    };
 
    auto* realDataItem = m_jobItem->realDataItem();
    ASSERT(realDataItem);
 
    const DataItem* intensity_item = realDataItem->dataItem();
    ASSERT(intensity_item);
    ASSERT(intensity_item->getDatafield());
 
    std::unique_ptr<Datafield> data(intensity_item->getDatafield()->clone());
 
    result->execAddSimulationAndData(builder, *data, nullptr, 1.0);
 
    return result;
}

References buildSimulation(), DataItem::getDatafield(), m_jobItem, and JobItem::realDataItem().

Referenced by runFit().

Here is the call graph for this function:

createMinimizer()

std::unique_ptr< IMinimizer > FitObjectiveBuilder::createMinimizer

(

)

const

Definition at line 92 of file FitObjectiveBuilder.cpp.

{
    return m_jobItem->fitSuiteItem()->minimizerContainerItem()->createMinimizer();
}

References MinimizerContainerItem::createMinimizer(), JobItem::fitSuiteItem(), m_jobItem, and FitSuiteItem::minimizerContainerItem().

Referenced by runFit().

Here is the call graph for this function:

createParameters()

mumufit::Parameters FitObjectiveBuilder::createParameters

(

)

const

Definition at line 97 of file FitObjectiveBuilder.cpp.

{
    return m_jobItem->fitSuiteItem()->fitParameterContainerItem()->createParameters();
}

References FitParameterContainerItem::createParameters(), FitSuiteItem::fitParameterContainerItem(), JobItem::fitSuiteItem(), and m_jobItem.

Referenced by runFit().

Here is the call graph for this function:

interruptFitting()

void FitObjectiveBuilder::interruptFitting

(

)

Definition at line 107 of file FitObjectiveBuilder.cpp.

{
    m_fit_objective->interruptFitting();
}

References m_fit_objective.

runFit()

void FitObjectiveBuilder::runFit

(

)

Definition at line 39 of file FitObjectiveBuilder.cpp.

{
    m_fit_objective = createFitObjective();
 
    auto module = m_jobItem->fitSuiteItem()->minimizerContainerItem()->createMetric();
    m_fit_objective->setObjectiveMetric(std::move(module));
 
    if (m_observer) {
        fit_observer_t plot_observer = [&](const FitObjective& obj) { m_observer->update(&obj); };
        m_fit_objective->initPlot(1, std::move(plot_observer));
    }
 
    auto minimizer_impl = createMinimizer();
    const bool requires_residuals = minimizer_impl->requiresResiduals();
 
    mumufit::Minimizer minimizer;
    minimizer.setMinimizer(minimizer_impl.release());
 
    auto result = requires_residuals ? minimizer.minimize(
                      [&](const mumufit::Parameters& params) {
                          return m_fit_objective->evaluate_residuals(params);
                      },
                      createParameters())
                                     : minimizer.minimize(
                                         [&](const mumufit::Parameters& params) {
                                             return m_fit_objective->evaluate(params);
                                         },
                                         createParameters());
    m_fit_objective->finalize(result);
}

References createFitObjective(), MinimizerContainerItem::createMetric(), createMinimizer(), createParameters(), JobItem::fitSuiteItem(), m_fit_objective, m_jobItem, m_observer, and FitSuiteItem::minimizerContainerItem().

Here is the call graph for this function:

update_fit_parameters()

void FitObjectiveBuilder::update_fit_parameters ( const mumufit::Parameters &  params ) const

private

Definition at line 123 of file FitObjectiveBuilder.cpp.

{
    QVector<double> values = QVector<double>::fromStdVector(params.values());
 
    auto* fitParContainer = m_jobItem->fitParameterContainerItem();
    fitParContainer->setValuesInParameterContainer(values, m_jobItem->parameterContainerItem());
}

References JobItem::fitParameterContainerItem(), m_jobItem, JobItem::parameterContainerItem(), and FitParameterContainerItem::setValuesInParameterContainer().

Referenced by buildSimulation().

Here is the call graph for this function:

Member Data Documentation

m_fit_objective

std::unique_ptr<FitObjective> FitObjectiveBuilder::m_fit_objective

private

Definition at line 57 of file FitObjectiveBuilder.h.

Referenced by interruptFitting(), and runFit().

m_jobItem

JobItem* FitObjectiveBuilder::m_jobItem

private

Definition at line 50 of file FitObjectiveBuilder.h.

Referenced by FitObjectiveBuilder(), buildSimulation(), createFitObjective(), createMinimizer(), createParameters(), runFit(), and update_fit_parameters().

m_observer

std::shared_ptr<GUIFitObserver> FitObjectiveBuilder::m_observer

private

Definition at line 56 of file FitObjectiveBuilder.h.

Referenced by attachObserver(), and runFit().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Fit/FitObjectiveBuilder.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Fit/FitObjectiveBuilder.cpp