#include <ImFusion/CT/GeometrySelfCalibration.h>

Auto-calibration algorithm for cone-beam geometry parameters. More...

Inheritance diagram for GeometrySelfCalibration:

Detailed Description

Auto-calibration algorithm for cone-beam geometry parameters.

Optimizes geometry parameters using projection data and optional reference CT volume.

Public Types
enum class	Mode { RESIDUAL_2D = 0 , SHARPNESS_3D = 1 , ISO_TV = 2 , LNCC_2D = 3 , LNCC_3D = 4 , RESIDUAL_3D = 5 }
	Currently supported 6 optimization criterion. More...

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...

Public Member Functions
	GeometrySelfCalibration (SharedImageSet &cbData, SharedImageSet *volume=nullptr)

void	compute () override
	Compute (estimate) geometry parameters via optimizing an objective function (metric) over the parameters.

void	resetGeometry ()
	Reset the geometry to the original ConeBeamData geometry.

double	evaluate (int n, const double x, double dx) override
	Evaluate cost function at intermediate geometry parameters in each optimizing iteration.

void	configure (const Properties *p) override
	Configure this object instance by de-serializing the given Properties.

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

Public Member Functions inherited from AlgorithmReconstructionDecorator< OptimizingAlgorithm >
	AlgorithmReconstructionDecorator (SharedImageSet &cbData)
	Constructor with reference to cone-beam data.

	AlgorithmReconstructionDecorator (std::unique_ptr< SharedImageSet > cbData)
	Constructor taking ownership of cone-beam data.

virtual	~AlgorithmReconstructionDecorator () override=0
	Virtual destructor.

void	setProgress (Progress *progress) override

bool	survivesDataDeletion (const Data *) const override
	Check if data is not in the input list but is using by the algorithm.

ReconstructionAlgorithm *	getReconAlgorithm () override

Public Member Functions inherited from OptimizingAlgorithm
void	setOptimizer (std::shared_ptr< Optimizer > opt)
	Set an optimizer from outside.

std::shared_ptr< Optimizer >	optimizer ()
	Returns the current optimizer.

void	configure (const Properties *p) override
	Configures the optimizer from a sub-property if available.

void	configuration (Properties *p) const override
	Stores the optimizer configuration into a sub-property.

Public Member Functions inherited from Algorithm
	Algorithm ()
	Default constructor will registers a single "compute" action that calls compute() and returns status().

virtual OwningDataList	takeOutput ()
	Return any new Data that was created by the Algorithm during the last call to compute().

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)

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< bool >	p_debugMode = {"debugMode", false, this}
	Enable/disable debug mode, default to "false".

Parameter< Mode >	p_mode = {"mode", Mode::RESIDUAL_2D, this}
	Metric of the optimization.

Parameter< bool >	p_enableThresholds = {"enableThresholds", false, this}
	Flag to enable/disable intensity threshold for SHARPNESS_3D. Default to false.

Parameter< double >	p_sharpnessMinIntensity = {"sharpnessMinIntensity", 0.0, this}
	Min intensity threshold for MetricSharpness computation of SHARPNESS_3D when p_enableThresholds is true.

Parameter< double >	p_sharpnessMaxIntensity = {"sharpnessMaxIntensity", 1.0, this}
	Max intensity threshold for MetricSharpness computation of SHARPNESS_3D when p_enableThresholds is true.

Parameter< double >	p_sharpnessBorder = {"sharpnessBorder", 0.0, *this}
	Texture coordinate border to compute sharpness, set to 0.0 for entire texture coordinate [0,1].

Public Attributes inherited from AlgorithmReconstructionDecorator< OptimizingAlgorithm >
SubProperty< std::unique_ptr< ReconstructionAlgorithm > >	p_reconAlgorithm
	Reconstruction algorithm for computing the intermediate CT volume.

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.

Additional Inherited Members
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.

Protected Attributes inherited from AlgorithmReconstructionDecorator< OptimizingAlgorithm >
SharedImageSet &	m_cbData
	ConeBeamData instance, storing projection data.

std::unique_ptr< SharedImageSet >	m_cbDataOwn
	Owning ConeBeamData, storing projection data.

Protected Attributes inherited from OptimizingAlgorithm
std::shared_ptr< Optimizer >	m_opt
	The optimizer instance.

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.

Member Enumeration Documentation

◆ Mode

enum class Mode

strong

Currently supported 6 optimization criterion.

Mode::RESIDUAL_3D, Mode::LNCC_3D are computed using the reference volume provided upon construction of the ConeBeamGeometrySelfCalibration instance. Other metrics are computed using ConeBeamData and on-the-fly CT reconstruction.

Enumerator
RESIDUAL_2D	Projection residual error of selected projections.
SHARPNESS_3D	3D Tenengrad sharpness.
ISO_TV	Isotropic total variation.
LNCC_2D	Local Normalized Cross Correlation, patch-based measure, 2D.
LNCC_3D	Local Normalized Cross Correlation, patch-based measure, 3D.
RESIDUAL_3D	Volumetric residual with respect to a reference volume.

Constructor & Destructor Documentation

◆ GeometrySelfCalibration()

GeometrySelfCalibration	(	SharedImageSet &	cbData,
		SharedImageSet *	volume = nullptr )

explicit

Parameters

cbData	ConeBeamData instance storing projection data and initial geometry for calibration.
volume	reference CT volume (optional), used in the metric mode RESIDUAL_3D and LNCC_3D.

Member Function Documentation

◆ compute()

void compute ( )

overridevirtual

Compute (estimate) geometry parameters via optimizing an objective function (metric) over the parameters.

Implements Algorithm.

◆ evaluate()

double evaluate	(	int	n,
		const double *	x,
		double *	dx )

overridevirtual

Evaluate cost function at intermediate geometry parameters in each optimizing iteration.

Return evaluated value of the cost function.

Implements CostFunction.

◆ configure()

void configure ( const Properties * p )

overridevirtual

Configure this object instance by de-serializing the given Properties.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also: configuration() for the inverse functionality

Reimplemented from AlgorithmReconstructionDecorator< OptimizingAlgorithm >.

◆ configuration()

void configuration ( Properties * p ) const

overridevirtual

Serialize the current object configuration into the given Properties object.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also: configure() for the inverse functionality

Reimplemented from AlgorithmReconstructionDecorator< OptimizingAlgorithm >.

Member Data Documentation

◆ p_debugMode

Parameter<bool> p_debugMode = {"debugMode", false, this}

Enable/disable debug mode, default to "false".

Debug mode logs metric image(s) to the DataModel.

◆ p_sharpnessMinIntensity

Parameter<double> p_sharpnessMinIntensity = {"sharpnessMinIntensity", 0.0, this}

Min intensity threshold for MetricSharpness computation of SHARPNESS_3D when p_enableThresholds is true.

Default to 0.0.

◆ p_sharpnessMaxIntensity

Parameter<double> p_sharpnessMaxIntensity = {"sharpnessMaxIntensity", 1.0, this}

Max intensity threshold for MetricSharpness computation of SHARPNESS_3D when p_enableThresholds is true.

Default to 1.0.

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

ImFusion/CT/GeometrySelfCalibration.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ Mode

Constructor & Destructor Documentation

◆ GeometrySelfCalibration()

Member Function Documentation

◆ compute()

◆ evaluate()

◆ configure()

◆ configuration()

Member Data Documentation

◆ p_debugMode

◆ p_sharpnessMinIntensity

◆ p_sharpnessMaxIntensity