#include <ImFusion/CT/BeamHardeningCompensation.h>

Inheritance diagram for ImFusion::CT::BeamHardeningCompensation:

Detailed Description

Single material, e.g. for water precorrection: Kachelriess M, Sourbelle K, Kalender WA. Empirical cupping correction: a first-order raw data precorrection for cone-beam computed tomography. Med Phys. 2006;33(5):1269-1274. doi:10.1118/1.2188076

Dual material, e.g. for bone compensation: Kyriakou Y, Meyer E, Prell D, Kachelriess M. Empirical beam hardening correction (EBHC) for CT. Med Phys. 2010;37(10):5179-5187. doi:10.1118/1.3477088

Public Types
enum class	Mode { SingleMaterial , DualMaterial }
Public Types inherited from ImFusion::Algorithm
enum	Status { Unknown = -1 , Success = 0 , Error = 1 , InvalidInput , IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU , UnknownAction , AbortedByUser , User = 1000 }
	Status codes. More...

Public Member Functions
	BeamHardeningCompensation (SharedImageSet &proj)
	Constructor.
	~BeamHardeningCompensation () override
	Destructor.
void	compute () override
	Execute the algorithm.
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.
OwningDataList	takeOutput () override
	Return any new Data that was created by the Algorithm during the last call to compute().
double	evaluate (int n, const double x, double dx=0) override
	Evaluate the cost function.
std::shared_ptr< Optimizer >	createDefaultOptimizer () const override
	Returns a default optimizer suited for this algorithm.
Public Member Functions inherited from ImFusion::CT::AlgorithmReconstructionDecorator< OptimizingAlgorithm >
	AlgorithmReconstructionDecorator (SharedImageSet &cbData)
	Constructor with reference to 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 ImFusion::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 ImFusion::Algorithm
	Algorithm ()
	Default constructor will registers a single "compute" action that calls compute() and returns status().
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 ImFusion::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 ImFusion::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_debugOutput = {"debugOutput", false, this}
	Output debug images.
Parameter< Mode >	p_mode = {"mode", Mode::SingleMaterial, this}
	Correction mode.
Parameter< float >	p_dualMaterialLowerThreshold = {"dualMaterialLowerThreshold", 0.35f, this}
	Lower soft-thresholding threshold for dual material mode.
Parameter< float >	p_dualMaterialUpperThreshold = {"dualMaterialUpperThreshold", 0.45f, this}
	Upper soft-thresholding threshold for dual material mode.
Parameter< int >	p_N = {"N", 3, this}
	Number of monomials to be used in polynomial correction.
Parameter< float >	p_lambda = {"lambda", 0.01f, this}
	Regularization parameter for optimization.
Parameter< bool >	p_useThirdOrder = {"useThirdOrder", false, this}
	Use the third order for the dual material mode.
Parameter< float >	p_sliceRatio = {"sliceRatio", 0.2f, this}
	Ratio of how many slices should be cut from top and bottom.
Parameter< float >	p_edgeThreshold = {"edgeThreshold", 0.1f, this}
	Edge threshold used to mask strong edges (normalized).
Parameter< bool >	p_ignoreMixedTerms = {"ignoreMixedTerms", true, this}
	Only use monomials corresponding to the higher absorbing material for dual material mode.
Parameter< std::string >	p_outputFile = {"outputFile", std::string{}, this}
	Output file to which the coefficients will be stored.
Parameter< bool >	p_inPlace = {"inPlace", false, this}
	Execute correction in-place on input data.
Parameter< bool >	p_downsample = {"downsample", false, this}
	Downsample input by a factor of 2 before estimating the beam-hardening.
Public Attributes inherited from ImFusion::CT::AlgorithmReconstructionDecorator< OptimizingAlgorithm >
SubProperty< std::unique_ptr< ReconstructionAlgorithm > >	p_reconAlgorithm
	Reconstruction algorithm for computing the intermediate CT volume.
Public Attributes inherited from ImFusion::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 ImFusion::Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Additional Inherited Members
Protected Member Functions inherited from ImFusion::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 ImFusion::CT::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 ImFusion::OptimizingAlgorithm
std::shared_ptr< Optimizer >	m_opt
	The optimizer instance.
Protected Attributes inherited from ImFusion::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 ImFusion::Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Enumeration Documentation

◆ Mode

enum class ImFusion::CT::BeamHardeningCompensation::Mode

strong

Enumerator
SingleMaterial	Single material beam hardening correction (e.g., water).
DualMaterial	Dual material beam hardening correction (e.g., water and bone).

Constructor & Destructor Documentation

◆ BeamHardeningCompensation()

ImFusion::CT::BeamHardeningCompensation::BeamHardeningCompensation ( SharedImageSet & proj )

Constructor.

Parameters

proj	Reference to projection data

Member Function Documentation

◆ compute()

void ImFusion::CT::BeamHardeningCompensation::compute ( )

overridevirtual

Execute the algorithm.

Implements ImFusion::Algorithm.

◆ configure()

void ImFusion::CT::BeamHardeningCompensation::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 ImFusion::CT::AlgorithmReconstructionDecorator< OptimizingAlgorithm >.

◆ configuration()

void ImFusion::CT::BeamHardeningCompensation::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 ImFusion::CT::AlgorithmReconstructionDecorator< OptimizingAlgorithm >.

◆ takeOutput()

OwningDataList ImFusion::CT::BeamHardeningCompensation::takeOutput ( )

overridevirtual

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

The default implementation will return an empty list.

Note: Since ownership of the data is transferred, you can call this method only once between calls to compute().

Reimplemented from ImFusion::Algorithm.

◆ evaluate()

double ImFusion::CT::BeamHardeningCompensation::evaluate	(	int	n,
		const double *	x,
		double *	dx = 0 )

overridevirtual

Evaluate the cost function.

n is the number of dimensions, x the parameters of size n. If the pointer dx is provided, the cost function shall compute partial derivatives and write it into dx.

Implements ImFusion::CostFunction.

◆ createDefaultOptimizer()

std::shared_ptr< Optimizer > ImFusion::CT::BeamHardeningCompensation::createDefaultOptimizer ( ) const

overridevirtual

Returns a default optimizer suited for this algorithm.

Implements ImFusion::OptimizingAlgorithm.

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

ImFusion/CT/BeamHardeningCompensation.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ Mode

Constructor & Destructor Documentation

◆ BeamHardeningCompensation()

Member Function Documentation

◆ compute()

◆ configure()

◆ configuration()

◆ takeOutput()

◆ evaluate()

◆ createDefaultOptimizer()