GlVolumeCompounding Class Reference

#include <ImFusion/GL/GlVolumeCompounding.h>

Compounding of multiple volumes (SharedImageSets) with different modalities for the computation of the resulting voxel values (Mode): Mean, Median, Maximum, and Distance. More...

Inheritance diagram for GlVolumeCompounding:

Detailed Description

Compounding of multiple volumes (SharedImageSets) with different modalities for the computation of the resulting voxel values (Mode): Mean, Median, Maximum, and Distance.

Note

While the first three modes are self-descriptive, the DISTANCE mode computes distance-maps of the input volumes and employs them to blend the resulting volume. This mode allows to reduce artifacts at the edges. The properties of the resulting volume are taken from the given reference volume (setReferenceVolume()) or inferred from the input volumes.

Public Types
enum	Mode { MEAN = 1 , MEDIAN = 2 , MAXIMUM = 3 , DISTANCE = 4 }
	Compounding mode, i.e. how the resulting voxel values is computed. More...
enum	WeightedMeanMode { RADIAL = 1 , ALONGZ = 2 , COSINE = 3 }
	The mode for weighted Mean. More...
enum class	InterpolationMode { Nearest = 1 , Linear = 2 }
	Interpolation mode for texture lookup. More...
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 Member Functions
	GlVolumeCompounding (SharedImageSet *volumes, bool own=false)
	Constructor providing the volume set as single SharedImageSet.
	GlVolumeCompounding (const std::vector< SharedImageSet * > volumes)
	Constructor taking a list of SharedImageSets.
	~GlVolumeCompounding () override
	Destructor.
void	setMode (Mode mode)
	Set the compounding mode.
void	setUseGPU (bool enable)
	Enable/Disable GPU computation.
void	setWeightedMean (bool enable)
	Use weighting wrt. volume center for mean mode (only on GPU)
void	setWeightedMeanMode (WeightedMeanMode mode)
	set the weighted mean mode
void	setInterpolationMode (InterpolationMode mode)
	Set the interpolation mode used for texture lookup.
void	setReferenceVolume (SharedImage *vol)
	Provide an optional reference volume to use as descriptor for the output volume.
bool	hasReferenceVolume () const
	Return if a reference volume is used.
void	boundingBox (vec3 &centerOut, vec3 &extentOut, double &spacingOut) const
	Compute the bounding box of the volume set.
void	compute () override
	Creates the compound volume.
SharedImageSet *	volumeSet ()
	Return the set of volumes to be compounded.
OwningDataList	takeOutput () override
	Return any new Data that was created by the Algorithm during the last call to compute().
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 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)
	Check if input data is compatible and create this algorithm if requested.
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 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 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 Enumeration Documentation

Mode

enum Mode

Compounding mode, i.e. how the resulting voxel values is computed.

Enumerator
MEAN	Compute mean.
MEDIAN	Compute median (in case of even number of samples, will use the larger center one)
MAXIMUM	Compute maximum.
DISTANCE	Compute distance to border.

WeightedMeanMode

enum WeightedMeanMode

The mode for weighted Mean.

Enumerator
RADIAL	Compute the weight by the distance to the center.
ALONGZ	Compute the weight by the distance to the center in z direction.
COSINE	Compute the weight by a smooth cosine along the border covering any overlap.

InterpolationMode

enum class InterpolationMode

strong

Interpolation mode for texture lookup.

Enumerator
Nearest	Nearest-neighbor interpolation, useful for label maps.
Linear	Use bi-/tri-linear interpolation.

Member Function Documentation

compute()

void compute ( )

overridevirtual

Creates the compound volume.

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.

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/GL/GlVolumeCompounding.h