Detailed Description

EventHandler to log optimization.

Public Member Functions
	LoggingHandler (OptimizationProblem &problem)

std::vector< double > &	loggedData ()

Public Member Functions inherited from EventHandler
void	compute (SharedImageSet &x, Event event, Progress *progress=nullptr, const Selection &sel=Selection())

void	setEnabled (bool enabled)

bool	getEnabled () const

Public Member Functions inherited from Configurable
virtual void	configure (const Properties *p)
	Configure this object instance by de-serializing the given Properties.

virtual void	configuration (Properties *p) const
	Serialize the current object configuration into the given Properties object.

virtual void	configureDefaults ()
	Retrieve the properties of this object, replaces values with their defaults and sets it again.

void	registerParameter (ParameterBase *param)
	Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().

void	unregisterParameter (const ParameterBase *param)
	Remove the given Parameter or SubProperty from the list of registered parameters.

	Configurable (const Configurable &rhs)

	Configurable (Configurable &&rhs) noexcept

Configurable &	operator= (const Configurable &)

Configurable &	operator= (Configurable &&) noexcept

Public Attributes
Parameter< bool >	p_enabled = {"enable logging", false, *this}

Signal	signalLoggedDataChanged
	A signal that is emitted when the logged data changes.

Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' `signalValueChanged` signal was emitted.

Protected Member Functions
void	startImpl (SharedImageSet &x, Event event, Progress *progress) override

void	postSubIterationImpl (SharedImageSet &x, Event event, Progress *progress, const Selection &sel) override

void	postIterationImpl (SharedImageSet &x, Event event, Progress *progress) override

void	endImpl (SharedImageSet &x, Event event, Progress *progress) override

void	log (SharedImageSet &x, Event event, Progress *progress)
	Log the current value of m_problem.eval() to m_loggedData.

Protected Member Functions inherited from EventHandler
virtual void	preIterationImpl (SharedImageSet &x, Event event, Progress *progress)

virtual void	preSubIterationImpl (SharedImageSet &x, Event event, Progress *progress, const Selection &sel)

Additional Inherited Members
Protected Attributes inherited from EventHandler
bool	m_enabled = true

Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Function Documentation

overrideprotectedvirtual

Reimplemented from EventHandler.

overrideprotectedvirtual

Reimplemented from EventHandler.

overrideprotectedvirtual

Reimplemented from EventHandler.

overrideprotectedvirtual

Reimplemented from EventHandler.

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