SplineLabelPainterAlgorithm Class Reference

#include <ImFusion/Seg/SplineLabelPainterAlgorithm.h>

Algorithm for executing the label painter on an image guided by a spline. More...

Inheritance diagram for SplineLabelPainterAlgorithm:

Detailed Description

Algorithm for executing the label painter on an image guided by a spline.

Public Member Functions
	SplineLabelPainterAlgorithm (SharedImageSet *imgIn)
	Algorithm constructor.
	~SplineLabelPainterAlgorithm () override
	Destructor.
SharedImageSet *	inputImage () const
	Return the input image.
void	setSpline (const Spline *s)
	Sets the spline.
const Spline *	spline () const
	Retrieves the spline.
void	compute () override
	Compute the result.
OwningDataList	takeOutput () override
	If the algorithm creates new image data, it has to be transferred here.
void	setLabel (unsigned char lab)
	Set the label value.
void	setNumSplintPoints (int numPoints)
	Set the number of spline points.
void	setRadius (double radius)
	Set the radius.
void	setAdaptiveness (double adaptiveness)
	Set the adaptiveness.
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	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)
	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.

Public Attributes
Parameter< unsigned char >	p_label = {"label", 1, *this}
	The label value that will be written to the labelmap.
Parameter< int >	p_numSplinePoints = {"numSplinePts", 1000, *this}
	The number of points used to interpolate the spline.
Parameter< double >	p_radius = {"radius", 20, *this}
	Radius in pixels that will be filled around the spline.
Parameter< double >	p_adaptiveness = {"adaptiveness", 0.8, *this}
	How strong the labels adopt to the pixel intensities inside the radius.
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
void	computeSweep (TrackedSharedImageSet *inputTsis)
void	computeVolume ()
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
SharedImageSet *	m_img
	Input image.
std::unique_ptr< SharedImageSet >	m_imgOut
	Output label image.
const Spline *	m_spline
	Spline.
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.

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

Member Function Documentation

compute()

void compute ( )

overridevirtual

Compute the result.

Implements Algorithm.

takeOutput()

OwningDataList takeOutput ( )

overridevirtual

If the algorithm creates new image data, it has to be transferred here.

Reimplemented from Algorithm.

Member Data Documentation

p_numSplinePoints

Parameter<int> p_numSplinePoints = {"numSplinePts", 1000, *this}

The number of points used to interpolate the spline.

A value of 0 or less, disables interpolation and treats the spline as a polyline.

p_adaptiveness

Parameter<double> p_adaptiveness = {"adaptiveness", 0.8, *this}

How strong the labels adopt to the pixel intensities inside the radius.

A value of 0 disables this.

---

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

• ImFusion/Seg/SplineLabelPainterAlgorithm.h