CropLabelMapAlgorithm Class Reference

#include <ImFusion/Base/CropLabelMapAlgorithm.h>

Class for cropping a label map around the targets with certain label values. More...

Inheritance diagram for CropLabelMapAlgorithm:

Detailed Description

Class for cropping a label map around the targets with certain label values.

If cropping the original volume of the label map at the same time is desired, the optional auxiliary image input allows cropping the volume the very same way. This algorithm allows for setting the desired label values, the margin (in pixels) around the object and whether to crop the image in place or create a new image when single label value is selected. When the input label map has one single frame, an additional functionality for splitting the label map and storing all the individual label images in one SharedImageSet is available.

Public Member Functions
	CropLabelMapAlgorithm (SharedImageSet &labelMap, SharedImageSet *auxImage=nullptr)
	CropLabelMapAlgorithm (SharedImageSet &labelMap, std::vector< SharedImageSet * > auxImages)
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.
void	compute () override
	Execute the algorithm.
void	setAuxImages (std::vector< SharedImageSet * > auxImages)
OwningDataList	takeOutput () override
	Return any new Data that was created by the Algorithm during the last call to compute().
Public Member Functions inherited from 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 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

Static Public Member Functions
static bool	createCompatible (const DataList &data, Algorithm **a=0)
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< std::vector< int > >	p_labelValues {"labelValues", std::vector{1}, *this}
	Parameters If p_splitAndCropLabelMap is true, the parameters p_labelValues and p_inPlace will become irrelevant to the algorithm, all the labels in the label map will be selected and a new SharedImageSet will be created for output.
Parameter< int >	p_margin = {"margin", 1, *this}
	Margin in pixels on each side.
Parameter< bool >	p_inPlace = {"inPlace", false, *this}
	If true, the image is cropped in place. This flag is only valid when a single label value is selected.
Parameter< bool >	p_oneImagePerLabel = {"oneImagePerLabel", false, *this}
	If true, a single image is created per selected label value. If false, an image that crops around the selected label values together is performed.
Parameter< bool >	p_splitAndCropLabelMap = {"splitAndCropLabelMap", false, *this}
	If true, the result contains all individual labels in a multi-label map (i.e. a label map taking multiple non-zero values), cropped around the label values.
Parameter< bool >	p_ignoreSingleLabelInSplit = {"ignoreSingleLabelInSplit", false, *this}
	If true, the computation for splitAndCropLabelMap is terminated when the input label map has only one single label.
Parameter< bool >	p_allowMissingLabel = {"allowMissingLabel", false, *this}
	If a label is not found, return a clone of the input image instead of an error.
Parameter< bool >	p_reorderLabelValues = {"reorderLabelValues", false, *this}
	Label-values are reordered to have values 1,2,3,..., and label-values not selected are set to zero.
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.

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

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.

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.

Member Data Documentation

p_labelValues

Parameter<std::vector<int> > p_labelValues {"labelValues", std::vector{1}, *this}

Parameters If p_splitAndCropLabelMap is true, the parameters p_labelValues and p_inPlace will become irrelevant to the algorithm, all the labels in the label map will be selected and a new SharedImageSet will be created for output.

Label values of the cropping target.

p_allowMissingLabel

Parameter<bool> p_allowMissingLabel = {"allowMissingLabel", false, *this}

If a label is not found, return a clone of the input image instead of an error.

Only applicable if p_splitAndCropLabelMap is false

---

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

• ImFusion/Base/CropLabelMapAlgorithm.h