ReconstructionAlgorithm Class Reference

#include <ImFusion/CT/ReconstructionAlgorithm.h>

Algorithm for tomographic reconstruction. More...

Inheritance diagram for ReconstructionAlgorithm:

Detailed Description

Algorithm for tomographic reconstruction.

Public Member Functions
	ReconstructionAlgorithm (SharedImageSet &data, SharedImageSet *reconstruction=nullptr)
	Constructor.
	~ReconstructionAlgorithm () override
	Destructor.
void	compute () override
	Execute the algorithm.
bool	survivesDataDeletion (const Data *) const override
	Indicates whether the algorithm can handle (partial) deletion of the specified data, by default this checks whether the data is in the input list.
void	configure (const Properties *p) override
	Set one or multiple properties.
void	configuration (Properties *p) const override
	Retrieve the properties of this object.
OwningDataList	takeOutput () override
	Take reconstruction volume.
SharedImageSet *	reconstruction ()
	Getter for the reconstruction volume.
SharedImageSet *	initReconstruction ()
	Getter for the initial reconstruction volume.
OptimizationProblem *	problem ()
	Getter for the optimization problem.
Solver *	solver ()
	Getter for the solver.
const SharedImageSet &	measurements () const
	Getter for the reconstruction volume.
const ImageDescriptorWorld &	volumeDescriptor ()
void	setVolumeDescriptor (const ImageDescriptorWorld &desc, bool onlyDescriptor=true)
const ImageDescriptorWorld &	outerRegionVolumeDescriptor ()
void	setOuterRegionVolumeDescriptor (const ImageDescriptorWorld &desc, bool onlyDescriptor=true)
Public Member Functions inherited from Algorithm
	Algorithm ()
	Default constructor will registers a single "compute" action that calls compute() and returns status().
virtual void	setProgress (Progress *progress)
	Sets a Progress interface the algorithm can use to notify observers about its computing progress.
Progress *	progress () const
	Returns the progress interface if set.
virtual int	status () const
	Indicates the status of the last call to compute().
const FactoryInfo &	factoryInfo () const
	Returns the record describing how this Algorithm was instantiated by the AlgorithmFactory.
void	setFactoryInfo (const FactoryInfo &value)
	Sets the record describing how this Algorithm was instantiated by the AlgorithmFactory.
Status	runAction (const std::string &id)
	Run the action with name id if it exists.
const std::vector< Action > &	actions ()
	Get a mapping from Action id to Action as registered in this algorithm.
Public Member Functions inherited from Configurable
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

Static Public Member Functions
static bool	createCompatible (const DataList &data, Algorithm **a=nullptr)
	If data is compatible with algorithm return true. If a is not zero, create algorithm with input data.
Static Public Member Functions inherited from Algorithm
static bool	createCompatible (const DataList &data, Algorithm **a=nullptr)
	Factory function to check algorithm compatibility with input data and optionally instantiate it.

Public Attributes
Parameter< std::string >	p_problemMode = {"problem", "none", *this}
	Problem which is supposed to be used.
Parameter< std::string >	p_solverMode = {"solver", "none", *this}
	Solver to be used.
Parameter< bool >	p_regionOfInterestEnabled = {"regionOfInterestEnabled", false, *this}
	If true ROI reconstruction will be enabled.
Parameter< vec2 >	p_shiftAndScale = {"shiftAndScale", vec2{0.0, 1.0}, *this}
	calibrated shift and scale
Signal	signalReconstructionDomainChanged
	This signal is emitted when the shape, dimensions or pose of the reconstruction region change.
Public Attributes inherited from Algorithm
Signal	signalOutputChanged
	Signal should be emitted by Algorithms when their output/result has changed.
Signal	signalParametersChanged
	Signal should be emitted by Algorithms when their parameter configuration has changed.
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Protected Member Functions
void	updateVolume ()
void	updateRegionOfInterestVolume ()
Protected Member Functions inherited from Algorithm
void	loadDefaults ()
void	registerAction (const std::string &id, const std::string &guiName, const std::function< Algorithm::Status(void)> &action)
	Register an action to be run via runAction.
template<typename D>
void	registerAction (const std::string &id, const std::string &guiName, Algorithm::Status(D::*action)(void))
	Template version of runAction that can be used with a pointer to a member function.
void	registerAction (const Action &action)
	Register an action.

Additional Inherited Members
Public Types inherited from Algorithm
enum	Status {   Unknown = -1 , Success = 0 , Error = 1 , InvalidInput ,   IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU ,   UnknownAction , AbortedByUser , User = 1000 }
	Status codes. More...
Protected Attributes inherited from Algorithm
std::string	m_name
	Algorithm name.
Progress *	m_progress = nullptr
	Non-owing pointer to a progress interface. May be a nullptr.
FactoryInfo	m_factoryInfo = {}
	Record describing how this algorithm was instantiated by the AlgorithmFactory.
int	m_status = Status::Unknown
	Algorithm status after last call to compute()
std::vector< Action >	m_actions
	Map of key given by the id of the action, of the available actions of this algorithm.
Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Constructor & Destructor Documentation

ReconstructionAlgorithm()

ReconstructionAlgorithm	(	SharedImageSet &	data,
		SharedImageSet *	reconstruction = nullptr )

Constructor.

The passed reconstruction volume should have a lifetime longer than the lifetime of this algorithm

Member Function Documentation

compute()

void compute ( )

overridevirtual

Execute the algorithm.

Implements Algorithm.

survivesDataDeletion()

bool survivesDataDeletion ( const Data * ) const

overridevirtual

Indicates whether the algorithm can handle (partial) deletion of the specified data, by default this checks whether the data is in the input list.

Reimplemented from Algorithm.

configure()

void configure ( const Properties * p )

overridevirtual

Set one or multiple properties.

Reimplemented from Configurable.

configuration()

void configuration ( Properties * p ) const

overridevirtual

Retrieve the properties of this object.

Reimplemented from Configurable.

takeOutput()

OwningDataList takeOutput ( )

overridevirtual

Take reconstruction volume.

Reimplemented from Algorithm.

Member Data Documentation

p_solverMode

Parameter<std::string> p_solverMode = {"solver", "none", *this}

Solver to be used.

Warning

if this is not compatible with the problem, then the solver is reset to a compatible solver on changes to the problem. When switching between different problem/solver combinations first set the problem, then the solver. While setting the problem/solver via configure(), do not listen to p_solverMode.signalValueChanged. If incompatible problem/solver combinations occur, p_solverMode.signalValueChanged will be triggered multiple times, and in general the last time it is triggered may not contain the chosen solver.

---

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

• ImFusion/CT/ReconstructionAlgorithm.h