iMSTK: imstk::SurfaceMeshImageMask Class Reference

Inheritance diagram for imstk::SurfaceMeshImageMask:

Collaboration diagram for imstk::SurfaceMeshImageMask:

Public Member Functions
void	setReferenceImage (std::shared_ptr< ImageData > refImage)
	Optional input, used for information (dimensions, spacing, etc)

void	setInputMesh (std::shared_ptr< SurfaceMesh > mesh)

std::shared_ptr< ImageData >	getOutputImage () const

void	setDimensions (int dimX, int dimY, int dimZ)
	The dimensions of the image to generate.


	imstkSetMacro (BorderExtent, int)
	Get/Set a border around the generated image of pixel amount border exists outside of bounds.

	imstkGetMacro (BorderExtent, int)


	imstkSetMacro (Dimensions, const Vec3i &)
	The dimensions of the image to generate.

	imstkGetMacro (Dimensions, const Vec3i &)

Public Member Functions inherited from imstk::GeometryAlgorithm
std::shared_ptr< Geometry >	getInput (size_t port=0) const
	Returns input geometry given port, returns nullptr if doesn't exist.

std::shared_ptr< Geometry >	getOutput (size_t port=0) const
	Returns output geometry given port, returns nullptr if doesn't exist.

void	setInput (std::shared_ptr< Geometry > inputGeometry, size_t port=0)
	Set the input at the port.

void	update ()
	Do the actual algorithm.

Protected Member Functions
void	requestUpdate () override
	Users can implement this for the logic to be run.

Protected Member Functions inherited from imstk::GeometryAlgorithm
void	setOutput (std::shared_ptr< Geometry > inputGeometry, const size_t port=0)
	Set the output at the port.

template<typename T >
void	setRequiredInputType (const size_t port)
	Declares the type for the port with the given number, also defines that the give port is required for the filter to run correctly.

template<typename T >
void	setOptionalInputType (const size_t port)
	Declares the type for the port with the given number, the data for this port is optional and may be omitted.

virtual bool	areInputsValid ()
	Check inputs are correct. More...

void	setNumInputPorts (const size_t numPorts)
	Get/Set the amount of input ports.

	imstkGetMacro (NumInputPorts, size_t)

void	setNumOutputPorts (const size_t numPorts)
	Get/Set the amount of output ports.

	imstkGetMacro (NumOutputPorts, size_t)

Additional Inherited Members
Protected Types inherited from imstk::GeometryAlgorithm
using	GeometryCheck = std::function< bool(Geometry *)>

using	TypeCheckContainer = std::unordered_map< size_t, GeometryCheck >

Protected Attributes inherited from imstk::GeometryAlgorithm
TypeCheckContainer	m_requiredTypeChecks

TypeCheckContainer	m_optionalTypeChecks

Detailed Description

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