 |
ImFusion C++ SDK 4.4.0
|
|
ImFusion C++ SDK 4.4.0
|
#include <CranialPlugin/include/ImFusion/Cranial/SkullStrippingAlgorithm.h>
Algorithm for segmenting the brain in MR volumes. More...
Algorithm for segmenting the brain in MR volumes.
Public Member Functions | |
| SkullStrippingAlgorithm (SharedImageSet &input, AnatomicalStructureCollection *asc=nullptr) | |
| Constructor. If asc is not null, segmentation results will be written to it. | |
| SharedImageSet & | input () const |
| void | setInputImage (SharedImageSet &newInput) |
| AnatomicalStructureCollection * | asc () const |
| const SharedImageSet * | brainMask () const |
| Returns a non-owning pointer to the generated brain mask, or nullptr if the algorithm was not successful or if the output was already fetched via takeOutput(). | |
| const SharedImageSet * | maskedImage () const |
| Returns a non-owning pointer to the generated masked image, or nullptr if the algorithm was not successful or if the output was already fetched via takeOutput(). | |
| 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(). | |
| 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 |
Public Attributes | |
| Parameter< std::string > | p_modelPath = {"modelPath", "", this} |
| Model to use for the brain segmentation. | |
| Parameter< bool > | p_autoCrop = {"autoCrop", true, this} |
| If enabled, automatically crops the masked image around the segmented brain. | |
| Parameter< bool > | p_exportLabelMap = {"exportLabelMap", true, this} |
| If enabled, export the label map as a separate data. | |
| Parameter< bool > | p_exportMaskedImage = {"exportMaskedImage", true, this} |
| If enabled, export the label map as a separate data. | |
| Parameter< bool > | p_extractMeshes = {"extractMeshes", true, this} |
| If disabled, the algorithm will not extract meshes. | |
| Parameter< int > | p_dilation = {"dilation", 0, this} |
| Size of the optional morphological post-processing applied to the brain mask in native voxel units. Positive integers for dilation, negative ones for erosion, 0 skips this step. | |
| 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. | |
| void | compute () override |
| Execute the algorithm. | |
| bool | survivesDataDeletion (const Data *data) const override |
| Indicates whether the algorithm can handle (partial) deletion of the specified data, by default this checks whether the data is in the input list. | |
| OwningDataList | takeOutput () override |
| Returns (1) the masked image if flag is enabled, (2) the brain mask if flag is enabled, (3) the AnatomicalStructureCollection if it has been created by the algorithm. | |
| static bool | createCompatible (const DataList &data, Algorithm **a=0) |
| Standard methods for the Algorithm interface. | |
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... | |
| 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. | |
| 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::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. | |
|
overridevirtual |
Execute the algorithm.
Implements ImFusion::Algorithm.
|
overridevirtual |
Indicates whether the algorithm can handle (partial) deletion of the specified data, by default this checks whether the data is in the input list.
Reimplemented from ImFusion::Algorithm.
|
overridevirtual |
Returns (1) the masked image if flag is enabled, (2) the brain mask if flag is enabled, (3) the AnatomicalStructureCollection if it has been created by the algorithm.
Reimplemented from ImFusion::Algorithm.
| Parameter<bool> ImFusion::Cranial::SkullStrippingAlgorithm::p_autoCrop = {"autoCrop", true, this} |
If enabled, automatically crops the masked image around the segmented brain.
Otherwise, the binary mask will have the same resolution as the input image.