StructuresViewAlgorithm Class Reference

#include <ImFusion/Seg/StructuresViewAlgorithm.h>

ImFusion::Algorithm that wraps around a StructuresView and adds a couple of convenience functions. More...

Inheritance diagram for StructuresViewAlgorithm:

Detailed Description

ImFusion::Algorithm that wraps around a StructuresView and adds a couple of convenience functions.

This algorithm provides the following set of extra features over a StructuresView:

• You can optionally set a DataModel to use as storage backend. In this case, the algorithm will subscribe to all changes of the DataModel and configure the underlying StructuresView to always show all label maps (images with Modality::LABEL) that are present in the DataModel.
• When using a DataModel as storage backend, you can use the convenience functions such as createStructure()/deleteStructure(), that will change the underlying DataModel and create/delete label maps if needed. These functions have no effect if there is no DataModel assigned.

See also

StructuresView, StructuresViewAlgorithmController

Public Member Functions
	StructuresViewAlgorithm (const std::vector< SharedImageSet * > &labelMaps)
	Creates a StructuresViewAlgorithm representing a static set of label maps.
	StructuresViewAlgorithm (DataModel &dataModel)
	Creates a StructuresViewAlgorithm dynamically representing all label maps in the given DataModel.
StructuresView &	structuresView ()
	Returns the underlying StructuresView.
const StructuresView &	structuresView () const
DataModel *	dataModel () const
	Returns the optional pointer to a DataModel to use as storage backend.
void	setDataModel (DataModel *value)
	Sets the optional pointer to a DataModel to use as storage backend.
void	detectLabels ()
	Calls LabelDataComponent::detectLabels() for every registered label map.
Structure *	createStructure (const SharedImageSet &referenceImage, bool reuseExistingLabelMapIfPossible)
	Creates a new Structure for the given reference image.
void	deleteStructure (Structure *structure)
	Deletes the given structure from the underlying storage backend.
const SharedImageSet *	referenceImageOf (const Structure &structure) const
	Returns the reference image that is used for the given structure.
StructureStatistics	computeStatistics (const Structure &s) const
	Computes statistics (voxel count, volume, bounding box statistics, connected components) for the given structure.
void	compute () override
	Execute the algorithm.
void	configure (const Properties *p) override
	Configure this object instance by de-serializing the given Properties.
void	configuration (Properties *p) const override
	Serialize the current object configuration into the given Properties object.
Public Member Functions inherited from 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 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
Configurable &	operator= (const Configurable &)
Configurable &	operator= (Configurable &&) noexcept
Public Member Functions inherited from SignalReceiver
	SignalReceiver ()=default
	Default constructor.
	SignalReceiver (const SignalReceiver &other)
	Copy constructor, does not copy any existing signal connections from other.
SignalReceiver &	operator= (SignalReceiver rhs)
	Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs.
virtual	~SignalReceiver ()
	Virtual destructor disconnects from all connected signals.

Static Public Member Functions
static bool	createCompatible (const DataList &data, Algorithm **a=0)
	If data is compatible with algorithm return true. If a is not zero, create algorithm with input data.
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.

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...
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 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.
Protected Member Functions inherited from SignalReceiver
void	disconnectAll ()
	Disconnects all existing connections.
Protected Attributes inherited from 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 Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Function Documentation

detectLabels()

void detectLabels

(

)

Calls LabelDataComponent::detectLabels() for every registered label map.

If a DataModel is set, it additionally checks whether any data sets of modality LABEL are in there, which are not yet registered (this can happen if the modality has changed after adding them to the DataModel).

createStructure()

Structure * createStructure	(	const SharedImageSet &	referenceImage,
		bool	reuseExistingLabelMapIfPossible )

Creates a new Structure for the given reference image.

If reuseExistingLabelMapIfPossible is true, it will check whether there is already an existing label map for referenceImage and if there are still free label configurations available. If so, it will use that label map instead of creating a new one. Furthermore, this function will automatically create a LinkPose instance in the DataModel to keep the poses of label map and reference image in sync.

Note

This function has no effect if there is no DataModel configured.

deleteStructure()

void deleteStructure

(

Structure *

structure

)

Deletes the given structure from the underlying storage backend.

All pixels of the label map that have the structure's label value are set to 0. If this was the last structure of the label map, the whole label map will be deleted (from the DataModel).

Note

This function has no effect if there is no DataModel configured.

referenceImageOf()

const SharedImageSet * referenceImageOf

(

const Structure &

structure

)

const

Returns the reference image that is used for the given structure.

Only considers structures that where created using createStructure().

computeStatistics()

StructureStatistics computeStatistics

(

const Structure &

s

)

const

Computes statistics (voxel count, volume, bounding box statistics, connected components) for the given structure.

Note

if the label map is 2d, only surface area and pixel count have meaningful values

compute()

void compute ( )

overridevirtual

Execute the algorithm.

Implements Algorithm.

configure()

void configure ( const Properties * p )

overridevirtual

Configure this object instance by de-serializing the given Properties.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configuration() for the inverse functionality

Reimplemented from Configurable.

configuration()

void configuration ( Properties * p ) const

overridevirtual

Serialize the current object configuration into the given Properties object.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configure() for the inverse functionality

Reimplemented from Configurable.

---

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

• ImFusion/Seg/StructuresViewAlgorithm.h