 |
ImFusion C++ SDK 4.4.0
|
|
ImFusion C++ SDK 4.4.0
|
#include <ImFusion/ML/ModalitySynthesisAlgorithm.h>
Class for running an algorithm that that given an image in one modality generates the corresponding image in another modality. (e.g. MR to CT). More...
Class for running an algorithm that that given an image in one modality generates the corresponding image in another modality. (e.g. MR to CT).
Public Member Functions | |
| ModalitySynthesisAlgorithm (SharedImageSet *image=nullptr) | |
| bool | setInput (SharedImageSet *newInput) |
| Change input image. | |
| void | compute () override |
| Convert MR image to a CT one and interpolate slices if needed. | |
| OwningDataList | takeOutput () override |
| Retrieve synthetic CT image. | |
| Public Member Functions inherited from ImFusion::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(). | |
| virtual bool | survivesDataDeletion (const Data *) const |
| Indicates whether the algorithm can handle (partial) deletion of the specified data, by default this checks whether the data is in the input list. | |
| 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 | 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 |
Static Public Member Functions | |
| static bool | createCompatible (const DataList &data, Algorithm **a=nullptr) |
| Method for AlgorithmFactory for selecting viable algorithms based on input data. | |
| 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< int > | p_numInterpolations = {"numInterpolations", -1, this} |
| Number of interpolated slices that should be added between every two original slices. | |
| Parameter< std::string > | p_encoderConfigPath = {"encoderConfigPath", "", this} |
| Filename of the encoder model's configuration. | |
| Parameter< std::string > | p_decoderConfigPath = {"decoderConfigPath", "", this} |
| FIlename of the decoder model's configuration. | |
| 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. | |
Protected Attributes | |
| SharedImageSet * | m_input |
| std::unique_ptr< SharedImageSet > | m_output |
| Input image to process. | |
| std::unique_ptr< MachineLearningModel > | m_encoder |
| Output created by the algorithm. | |
| std::unique_ptr< MachineLearningModel > | m_decoder |
| 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. | |
Additional Inherited Members | |
| 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... | |
| 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. | |
| bool ImFusion::ML::ModalitySynthesisAlgorithm::setInput | ( | SharedImageSet * | newInput | ) |
Change input image.
Returns false if the image is incompatible, true otherwise
|
overridevirtual |
Convert MR image to a CT one and interpolate slices if needed.
Implements ImFusion::Algorithm.
|
overridevirtual |
Retrieve synthetic CT image.
Reimplemented from ImFusion::Algorithm.
| Parameter<int> ImFusion::ML::ModalitySynthesisAlgorithm::p_numInterpolations = {"numInterpolations", -1, this} |
Number of interpolated slices that should be added between every two original slices.
If set to -1 the number will be inferred automatically to achieve roughly isotropic resolution.