Inheritance diagram for ImFusion::AnatomicalStructureProcessing::MaskAnatomicalStructure:

Public Types
enum class	MaskAttachmentMode { NativeGridWorldMap , DenseTargetGrid }
	Controls how the mask image is attached to image frames. More...
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
	MaskAnatomicalStructure (SharedImageSet &toMask, const AnatomicalStructureCollection &asc)
void	compute () override
	Execute the algorithm.
Public Member Functions inherited from ImFusion::Algorithm
	Algorithm ()
	Default constructor will registers a single "compute" action that calls compute() and returns status().
virtual OwningDataList	takeOutput ()
	Return any new Data that was created by the Algorithm during the last call to compute().
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 std::unique_ptr< SharedImageSet >	maskImage (const AnatomicalStructure &as, double threshold=0.0)
	Derives a mask image from the anatomical structure's meshes or label map.
static SharedImage *	attachMask (SharedImageSet &toMask, const SharedImageSet &maskData, MaskAttachmentMode mode=MaskAttachmentMode::NativeGridWorldMap)
	Attaches `maskData` to each frame of `toMask` according to `mode`.
static SharedImage *	mask (SharedImageSet &toMask, const AnatomicalStructure &as, double threshold=0.0, MaskAttachmentMode mode=MaskAttachmentMode::NativeGridWorldMap)
	Convenience: calls maskImage() then attachMask() with `mode`.
static bool	createCompatible (const DataList &dl, Algorithm **a=0)
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< std::string >	p_identifier = {"identifier", "", this}
Parameter< double >	p_threshold = {"threshold", 0.0, this}
	If not set to zero, threshold (in mm) of the distance volume is used to mask the anatomical structure.
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::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

◆ MaskAttachmentMode

enum class ImFusion::AnatomicalStructureProcessing::MaskAnatomicalStructure::MaskAttachmentMode

strong

Controls how the mask image is attached to image frames.

Enumerator

NativeGridWorldMap

Attach as ExplicitIntensityMask without resampling (default).

The mask keeps its native grid and resolution; membership is resolved via world-space coordinate mapping on every lookup. Memory-efficient and supports masks at any resolution, but the mask does not track in-place pose changes on the target image (e.g. during registration).

DenseTargetGrid

Resample maskData to each target frame's exact voxel grid (nearest-neighbour) and attach as a binary ExplicitMask.

Lookup is a direct per-voxel index with no world-space remapping, so the mask follows the image when its pose changes (e.g. during registration). Use this whenever the mask must travel with a moving image.

Member Function Documentation

◆ maskImage()

std::unique_ptr< SharedImageSet > ImFusion::AnatomicalStructureProcessing::MaskAnatomicalStructure::maskImage	(	const AnatomicalStructure &	as,
		double	threshold = 0.0 )

static

Derives a mask image from the anatomical structure's meshes or label map.

Prefers meshes when available (rasterization, or distance image if threshold != 0). Falls back to the label map under Keys::Segmentation::key. The returned SIS can be used standalone or passed to attachMask() for multiple images.

Returns: an owned SharedImageSet containing the mask, or nullptr on failure.

◆ attachMask()

SharedImage * ImFusion::AnatomicalStructureProcessing::MaskAnatomicalStructure::attachMask	(	SharedImageSet &	toMask,
		const SharedImageSet &	maskData,
		MaskAttachmentMode	mode = MaskAttachmentMode::NativeGridWorldMap )

static

Attaches maskData to each frame of toMask according to mode.

Call maskImage() once and attachMask() per image when masking multiple images from the same anatomical structure.

Returns: a non-owning pointer to the last attached mask image, or nullptr if no frame was masked.

◆ mask()

SharedImage * ImFusion::AnatomicalStructureProcessing::MaskAnatomicalStructure::mask	(	SharedImageSet &	toMask,
		const AnatomicalStructure &	as,
		double	threshold = 0.0,
		MaskAttachmentMode	mode = MaskAttachmentMode::NativeGridWorldMap )

static

Convenience: calls maskImage() then attachMask() with mode.

Returns: a non-owning pointer to the last created mask image, or nullptr on failure.

◆ compute()

void ImFusion::AnatomicalStructureProcessing::MaskAnatomicalStructure::compute ( )

overridevirtual

Execute the algorithm.

Implements ImFusion::Algorithm.

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

AnatomyPlugin/include/ImFusion/AnatomyPlugin/AnatomicalStructureProcessing.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ MaskAttachmentMode

Member Function Documentation

◆ maskImage()

◆ attachMask()

◆ mask()

◆ compute()