ImFusion SDK 4.3
MetalArtifactReduction Class Reference

#include <ImFusion/CT/MetalArtifactReduction.h>

Metal artifact reduction algorithm for CT reconstruction. More...

+ Inheritance diagram for MetalArtifactReduction:

Detailed Description

Metal artifact reduction algorithm for CT reconstruction.

Wraps a reconstruction algorithm to compute initial reconstruction for metal detection. Optionally accepts pre-computed reconstruction for metal region detection.

Public Member Functions

 MetalArtifactReduction (SharedImageSet &data, SharedImageSet *vol=nullptr)
 Constructor.
 
void compute () override
 Execute the algorithm.
 
OwningDataList takeOutput () override
 Return any new Data that was created by the Algorithm during the last call to compute().
 
SharedImageSetprojMetalMask ()
 
- Public Member Functions inherited from AlgorithmReconstructionDecorator< Algorithm >
 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 configure (const Properties *p) override
 
void configuration (Properties *p) const override
 
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.
 
ReconstructionAlgorithmgetReconAlgorithm () override
 
- Public Member Functions inherited from Algorithm
 Algorithm ()
 Default constructor will registers a single "compute" action that calls compute() and returns status().
 
Progressprogress () const
 Returns the progress interface if set.
 
virtual int status () const
 Indicates the status of the last call to compute().
 
const FactoryInfofactoryInfo () 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
 
Configurableoperator= (const Configurable &)
 
Configurableoperator= (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_inPlace = {"inPlace", false, *this}
 Boolean variable indicating whether to inpaint the projections in place.
 
Parameter< double > p_metalThreshold = {"metalThreshold", 0.0, *this}
 Threshold for masking the metal region.
 
Parameter< int > p_gaussianKernelSize = {"gaussianKernelSize", 15, *this}
 Kernel size of the Gaussian smoothing filter.
 
Parameter< int > p_morphologicalOpSize = {"morphologicalOpSize", 3, *this}
 Kernel size of the morphological operation.
 
Parameter< bool > p_outputProjectionMasks = {"outputProjectionMasks", false, *this}
 Whether to output the masks on projections for convenience of debugging.
 
- Public Attributes inherited from AlgorithmReconstructionDecorator< Algorithm >
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.
 

Protected Attributes

SharedImageSetm_inputVol = nullptr
 
std::unique_ptr< SharedImageSetm_imgOut
 Output images.
 
std::unique_ptr< SharedImageSetm_mask
 Mask for metal regions.
 
std::unique_ptr< SharedImageSetm_outputProjs
 Output projections. Only set if p_inPlace is false.
 
std::unique_ptr< SharedImageSetm_projMask
 Mask for projections.
 
- Protected Attributes inherited from AlgorithmReconstructionDecorator< Algorithm >
SharedImageSetm_cbData
 ConeBeamData instance, storing projection data.
 
std::unique_ptr< SharedImageSetm_cbDataOwn
 Owning ConeBeamData, storing projection data.
 
- Protected Attributes inherited from Algorithm
std::string m_name
 Algorithm name.
 
Progressm_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< Actionm_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< Paramm_params
 List of all registered Parameter and SubProperty instances.
 

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

Constructor & Destructor Documentation

◆ MetalArtifactReduction()

Constructor.

Parameters
dataCone-beam projection data
volOptional pre-computed reconstruction volume for metal detection

Member Function Documentation

◆ compute()

void compute ( )
overridevirtual

Execute the algorithm.

Implements Algorithm.

◆ takeOutput()

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


The documentation for this class was generated from the following file:
Search Tab / S to search, Esc to close