GUIFitObserver Class Reference

Description

Serves as observer for FitObjective and saves fit iteration data for later display in GUI widgets.

Definition at line 30 of file GUIFitObserver.h.

Inheritance diagram for GUIFitObserver:

Collaboration diagram for GUIFitObserver:

Public Slots
void	setInterval (int val)

Signals
void	updateReady ()

Public Member Functions
	GUIFitObserver (QObject *parent=nullptr)
	~GUIFitObserver () override
void	finishedPlotting ()
	Informs observer that FitSuiteWidget has finished plotting and is ready for next plot. More...
FitProgressInfo	progressInfo ()
void	update (const FitObjective *subject)

Private Member Functions
bool	is_obligatory_iteration (const FitObjective *fitSuite) const
	Returns true if given iteration should be obligary plotted. More...
bool	is_suitable_iteration (const FitObjective *fitSuite) const
	Returns true if data could be plotted, when there are resources for it. More...

Private Attributes
bool	m_block_update_plots
FitProgressInfo	m_iteration_info
std::condition_variable	m_on_finish_notifier
int	m_update_interval
std::mutex	m_update_plot_mutex

Constructor & Destructor Documentation

GUIFitObserver()

GUIFitObserver::GUIFitObserver

(

QObject *

parent = nullptr

)

Definition at line 22 of file GUIFitObserver.cpp.

    : QObject(parent)
    , m_block_update_plots(false)
    , m_update_interval(1)
{
}

~GUIFitObserver()

GUIFitObserver::~GUIFitObserver ( )

overridedefault

Member Function Documentation

finishedPlotting()

void GUIFitObserver::finishedPlotting

(

)

Informs observer that FitSuiteWidget has finished plotting and is ready for next plot.

Definition at line 83 of file GUIFitObserver.cpp.

{
    std::unique_lock<std::mutex> lock(m_update_plot_mutex);
    m_block_update_plots = false;
    lock.unlock();
    m_on_finish_notifier.notify_one();
}

References m_block_update_plots, m_on_finish_notifier, and m_update_plot_mutex.

is_obligatory_iteration()

bool GUIFitObserver::is_obligatory_iteration ( const FitObjective *  fitSuite ) const

private

Returns true if given iteration should be obligary plotted.

Definition at line 71 of file GUIFitObserver.cpp.

{
    return fitSuite->isCompleted();
}

Referenced by update().

is_suitable_iteration()

bool GUIFitObserver::is_suitable_iteration ( const FitObjective *  fitSuite ) const

private

Returns true if data could be plotted, when there are resources for it.

Definition at line 59 of file GUIFitObserver.cpp.

{
    if (fitSuite->isInterrupted())
        return false;
 
    int n_iter = static_cast<int>(fitSuite->iterationInfo().iterationCount());
    return fitSuite->isFirstIteration() || n_iter % m_update_interval == 0
           || fitSuite->isCompleted();
}

References m_update_interval.

Referenced by update().

progressInfo()

FitProgressInfo GUIFitObserver::progressInfo

(

)

Definition at line 91 of file GUIFitObserver.cpp.

{
    std::unique_lock<std::mutex> lock(m_update_plot_mutex);
    m_block_update_plots = true;
    return m_iteration_info;
}

References m_block_update_plots, m_iteration_info, and m_update_plot_mutex.

setInterval

void GUIFitObserver::setInterval ( int  val )

slot

Definition at line 76 of file GUIFitObserver.cpp.

{
    m_update_interval = val;
}

References m_update_interval.

update()

void GUIFitObserver::update

(

const FitObjective *

subject

)

Definition at line 31 of file GUIFitObserver.cpp.

{
    if (!is_suitable_iteration(subject))
        return;
 
    std::unique_lock<std::mutex> lock(m_update_plot_mutex);
    if (m_block_update_plots && !is_obligatory_iteration(subject))
        return; // plotting still works, will skip iteration
 
    if (m_block_update_plots)
        m_on_finish_notifier.wait(lock, [this]() { return m_block_update_plots; });
 
    FitProgressInfo info;
    info.m_chi2 = subject->iterationInfo().chi2();
    info.m_iteration_count = static_cast<int>(subject->iterationInfo().iterationCount());
    info.m_values = subject->iterationInfo().parameters().values();
 
    if (subject->isCompleted())
        info.m_log_info = subject->minimizerResult().toString();
 
    info.m_sim_values = subject->dataPair().simulationResult().flatVector();
 
    m_iteration_info = info;
    emit updateReady();
}

References is_obligatory_iteration(), is_suitable_iteration(), m_block_update_plots, FitProgressInfo::m_chi2, FitProgressInfo::m_iteration_count, m_iteration_info, FitProgressInfo::m_log_info, m_on_finish_notifier, FitProgressInfo::m_sim_values, m_update_plot_mutex, FitProgressInfo::m_values, and updateReady().

Here is the call graph for this function:

updateReady

void GUIFitObserver::updateReady ( )

signal

Referenced by FitSessionController::FitSessionController(), and update().

Member Data Documentation

m_block_update_plots

bool GUIFitObserver::m_block_update_plots

private

Definition at line 53 of file GUIFitObserver.h.

Referenced by finishedPlotting(), progressInfo(), and update().

m_iteration_info

FitProgressInfo GUIFitObserver::m_iteration_info

private

Definition at line 57 of file GUIFitObserver.h.

Referenced by progressInfo(), and update().

m_on_finish_notifier

std::condition_variable GUIFitObserver::m_on_finish_notifier

private

Definition at line 55 of file GUIFitObserver.h.

Referenced by finishedPlotting(), and update().

m_update_interval

int GUIFitObserver::m_update_interval

private

Definition at line 56 of file GUIFitObserver.h.

Referenced by is_suitable_iteration(), and setInterval().

m_update_plot_mutex

std::mutex GUIFitObserver::m_update_plot_mutex

private

Definition at line 54 of file GUIFitObserver.h.

Referenced by finishedPlotting(), progressInfo(), and update().

---

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

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