MeshToLabelMapAlgorithm Class Reference

#include <ImFusion/Base/MeshToLabelMapAlgorithm.h>

Algorithm to perform a voxelization (conversion) of a mesh to a label map. More...

Inheritance diagram for MeshToLabelMapAlgorithm:

Detailed Description

Algorithm to perform a voxelization (conversion) of a mesh to a label map.

The algorithm can work in two modes:

• If no reference volume is provided then the output label map is created axis-aligned wrt. the input mesh coordinate system and with the pixel spacing as configured.
• If a reference volume is provided the algorithm will create one label map for each image in the reference SharedImageSet matching its orientation and spacing.

The input mesh must be manifold (watertight) in order to yield correct voxelization results. This algorithm provides an optional GPU implementation, which requires OpenGL 4.3. CPU and GPU versions may yield slightly different results due to numerical precision.

Public Member Functions
	MeshToLabelMapAlgorithm (const Mesh *mesh, const SharedImageSet *refVolumes=nullptr)
void	setValues (int insideValue, int outsideValue)
void	setOutSpacing (double spacing)
void	setMargin (int margin)
OwningDataList	takeOutput () override
	Return any new Data that was created by the Algorithm during the last call to compute().
void	compute () override
	Execute the algorithm.
void	configure (const Properties *p) override
	Configure this object instance by de-serializing the given Properties.
std::unique_ptr< SharedImageSet >	computeGPU (SharedImageSet *output=nullptr, ImageMath::ExprBase *exprOut=nullptr)
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	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=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< double >	p_outSpacing = {"outSpacing", 1.0, this}
	Spacing of the output image when no reference volume is provided.
Parameter< int >	p_marginPx = {"marginPx", 10, this}
	Margin in pixels (sum of front and back margin). Actual margin may be larger than this value.
Parameter< uint8_t >	p_outsideValue = {"outsideValue", static_cast<uint8_t>(0), this}
	Label value for voxels outside of the mesh.
Parameter< uint8_t >	p_insideValue = {"insideValue", static_cast<uint8_t>(1), this}
	Label value for voxels inside the mesh.
Parameter< bool >	p_useGPU = {"useGPU", true, *this}
	Run on GPU if possible (requires OpenGL 4.3, falls back to CPU if unavailable)
Parameter< bool >	p_forceGPU = {"forceGPU", false, *this}
Parameter< std::optional< size_t > >	p_memoryLimitMB = {"memoryLimitMB", std::nullopt, this}
	Maximum memory in MB for total accumulation volume.
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
std::unique_ptr< SharedImageSet >	computeCPU ()
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
const Mesh *	m_mesh
	Input mesh.
const SharedImageSet *	m_refVolumes
	(Optional) Input reference volume
std::unique_ptr< SharedImageSet >	m_labels
	Output label map.
std::unique_ptr< GL::Program >	m_voxelizeProgram
std::unique_ptr< GL::ProgramCache >	m_copyProgManager
std::unique_ptr< GL::ShaderStorageBuffer >	m_vertexBuffer
std::unique_ptr< GL::ShaderStorageBuffer >	m_indexBuffer
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

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.

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.

---

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

• ImFusion/Base/MeshToLabelMapAlgorithm.h