ImFusion::CT::ConvolutionFilter Class Reference

#include <ImFusion/CT/Solver/ConvolutionFilter.h>

Convolution filter implemented as LinearOperator. More...

Inheritance diagram for ImFusion::CT::ConvolutionFilter:

Detailed Description

Convolution filter implemented as LinearOperator.

Applies convolution kernels as linear operations for image filtering.

Warning

Currently assumes odd-sized convolution kernels.

Public Member Functions
	ConvolutionFilter (const SharedImageSet &domainRangeRef, const GlImage *kernel=nullptr)
bool	setKernel (const GlImage *kernel)
	Set the kernel of the convolution. Ownership stays with the caller, this is not copied.
Status	apply (const ExprBase &exprIn, const SharedImageSet &in, SharedImageSet &out, const ExprBase *exprOut=nullptr) const override
	Apply the convolution.
Status	applyAdjoint (const ExprBase &exprIn, const SharedImageSet &in, SharedImageSet &out, const ExprBase *exprOut=nullptr) const override
	Warning: the current implementation assumes that the kernel function is odd, and that the convolution is therefore self-adjoint.
std::unique_ptr< LinearOperator >	clone () const override
	Factory method.
virtual Status	apply (const SharedImageSet &in, SharedImageSet &out, const ExprBase *exprOut=nullptr) const=0
template<typename ImplType, typename ImplTypeOut>
Status	apply (const ImageMath::ExprBaseTpl< ImplType > &exprIn, const SharedImageSet &in, SharedImageSet &out, const ImageMath::ExprBaseTpl< ImplTypeOut > *exprOut=nullptr) const
template<typename ImplType>
Status	apply (const ImageMath::ExprBaseTpl< ImplType > &exprIn, const SharedImageSet &in, SharedImageSet &out, const ExprBase *exprOut=nullptr) const
Public Member Functions inherited from ImFusion::CT::LinearOperatorEvalInputExpr< false >
Status	apply (const SharedImageSet &in, SharedImageSet &out, const ExprBase *exprOut=nullptr) const override final
Status	applyAdjoint (const SharedImageSet &in, SharedImageSet &out, const ExprBase *exprOut=nullptr) const override final
	LinearOperator (const SharedImageSet *domainRef, const SharedImageSet *rangeRef=nullptr)
	Constructor with optional references for the domain and codomain (i.e. range) of the operator.
virtual Status	apply (const ExprBase &exprIn, const SharedImageSet &in, SharedImageSet &out, const ExprBase *exprOut=nullptr) const=0
	Applies a linear operator \(A\), optionally pre/post-composing with an ImageMath expression.
template<typename ImplType, typename ImplTypeOut>
Status	apply (const ImageMath::ExprBaseTpl< ImplType > &exprIn, const SharedImageSet &in, SharedImageSet &out, const ImageMath::ExprBaseTpl< ImplTypeOut > *exprOut=nullptr) const
template<typename ImplType>
Status	apply (const ImageMath::ExprBaseTpl< ImplType > &exprIn, const SharedImageSet &in, SharedImageSet &out, const ExprBase *exprOut=nullptr) const
virtual Status	applyAdjoint (const ExprBase &exprIn, const SharedImageSet &in, SharedImageSet &out, const ExprBase *exprOut=nullptr) const=0
	Applies the adjoint of a linear operator \(A\), optionally pre/post-composing with an ImageMath expression.
template<typename ImplType, typename ImplTypeOut>
Status	applyAdjoint (const ImageMath::ExprBaseTpl< ImplType > &exprIn, const SharedImageSet &in, SharedImageSet &out, const ImageMath::ExprBaseTpl< ImplTypeOut > *exprOut=nullptr) const
template<typename ImplType>
Status	applyAdjoint (const ImageMath::ExprBaseTpl< ImplType > &exprIn, const SharedImageSet &in, SharedImageSet &out, const ExprBase *exprOut=nullptr) const
Public Member Functions inherited from ImFusion::CT::LinearOperator
	LinearOperator (const SharedImageSet *domainRef, const SharedImageSet *rangeRef=nullptr)
	Constructor with optional references for the domain and codomain (i.e. range) of the operator.
	~LinearOperator () override=0
	Destructor.
template<typename ImplType, typename ImplTypeOut>
Status	apply (const ImageMath::ExprBaseTpl< ImplType > &exprIn, const SharedImageSet &in, SharedImageSet &out, const ImageMath::ExprBaseTpl< ImplTypeOut > *exprOut=nullptr) const
template<typename ImplType>
Status	apply (const ImageMath::ExprBaseTpl< ImplType > &exprIn, const SharedImageSet &in, SharedImageSet &out, const ExprBase *exprOut=nullptr) const
template<typename ImplType, typename ImplTypeOut>
Status	applyAdjoint (const ImageMath::ExprBaseTpl< ImplType > &exprIn, const SharedImageSet &in, SharedImageSet &out, const ImageMath::ExprBaseTpl< ImplTypeOut > *exprOut=nullptr) const
template<typename ImplType>
Status	applyAdjoint (const ImageMath::ExprBaseTpl< ImplType > &exprIn, const SharedImageSet &in, SharedImageSet &out, const ExprBase *exprOut=nullptr) const
Status	runBlock (Input &input, Output &output) override
	Applies the operator to the first element of input.
std::unique_ptr< LinearOperatorAdjointWrapper >	adjoint () const
	Creates an adjoint operator of this.
const SharedImageSet *	domainRef () const
	Getter for m_domainRef, can be nullptr if this is implicitly defined by the operator.
const SharedImageSet *	rangeRef () const
	Getter for m_rangeRef, can be nullptr if this is implicitly defined by the operator.
virtual std::unique_ptr< SharedImageSet >	createDomainSis () const
	Creates a SharedImageSet which is in the range of the operator.
virtual std::unique_ptr< SharedImageSet >	createRangeSis () const
	Creates a SharedImageSet which is in the range of the operator.
Eigen::MatrixXf	extractApplyMatrix () const
	Extracts a dense matrix representing this operator.
Eigen::MatrixXf	extractApplyAdjointMatrix () const
	Extracts a dense matrix representing this operator.
Public Member Functions inherited from ImFusion::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

Protected Attributes
const GlImage *	m_kernel = nullptr
bool	m_validKernel = false
GlConvolutionFilter	m_filter
Protected Attributes inherited from ImFusion::CT::LinearOperator
const SharedImageSet *	m_domainRef = nullptr
const SharedImageSet *	m_rangeRef = nullptr
Protected Attributes inherited from ImFusion::Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Additional Inherited Members
Public Types inherited from ImFusion::CT::LinearOperator
using	ExprBase = ImageMath::ExprBase
Public Types inherited from ImFusion::CT::Block
using	Input = DataList
using	Output = DataList
Public Attributes inherited from ImFusion::Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Member Function Documentation

apply() [1/4]

Status ImFusion::CT::ConvolutionFilter::apply ( const ExprBase & exprIn, const SharedImageSet & in, SharedImageSet & out, const ExprBase * exprOut = nullptr ) const

overridevirtual

Apply the convolution.

Implements ImFusion::CT::LinearOperator.

applyAdjoint()

Status ImFusion::CT::ConvolutionFilter::applyAdjoint ( const ExprBase & exprIn, const SharedImageSet & in, SharedImageSet & out, const ExprBase * exprOut = nullptr ) const

inlineoverridevirtual

Warning: the current implementation assumes that the kernel function is odd, and that the convolution is therefore self-adjoint.

Implements ImFusion::CT::LinearOperator.

clone()

std::unique_ptr< LinearOperator > ImFusion::CT::ConvolutionFilter::clone ( ) const

overridevirtual

Factory method.

Implements ImFusion::CT::LinearOperator.

apply() [2/4]

virtual Status ImFusion::CT::LinearOperator::apply ( const SharedImageSet & in, SharedImageSet & out, const ExprBase * exprOut = nullptr ) const

virtual

See also

LinearOperator::apply(const ExprBase&, SharedImageSet&, SharedImageSet&, const ExprBase*) with the input expression set to the identity applied to in.

Implements ImFusion::CT::LinearOperator.

apply() [3/4]

template<typename ImplType, typename ImplTypeOut>

Status ImFusion::CT::LinearOperator::apply ( const ImageMath::ExprBaseTpl< ImplType > & exprIn, const SharedImageSet & in, SharedImageSet & out, const ImageMath::ExprBaseTpl< ImplTypeOut > * exprOut = nullptr ) const

inline

See also

LinearOperator::apply(const ExprBase&, SharedImageSet&, SharedImageSet&, const ExprBase*) with the input expression

apply() [4/4]

template<typename ImplType>

Status ImFusion::CT::LinearOperator::apply ( const ImageMath::ExprBaseTpl< ImplType > & exprIn, const SharedImageSet & in, SharedImageSet & out, const ExprBase * exprOut = nullptr ) const

inline

See also

LinearOperator::apply(const ExprBase&, SharedImageSet&, SharedImageSet&, const ExprBase*) with the input expression

---

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

• ImFusion/CT/Solver/ConvolutionFilter.h