#include <itkCuberilleImageToMeshFilter.h>

Inheritance diagram for itk::CuberilleImageToMeshFilter< TInputImage, TOutputMesh, TInterpolator >:

Collaboration diagram for itk::CuberilleImageToMeshFilter< TInputImage, TOutputMesh, TInterpolator >:

Detailed Description

template<class TInputImage, class TOutputMesh, class TInterpolator = itk::LinearInterpolateImageFunction<TInputImage>>
class itk::CuberilleImageToMeshFilter< TInputImage, TOutputMesh, TInterpolator >

This filter uses the 'cuberille' method to convert an implicit surface (image) to a mesh.

The 'cuberille' model was proposed over 30 years ago [1,2]. A basic summary of the algorithm is as follows: step over all pixels, for each pixel determine if it lies on the surface, center a cube on the surface pixel, create quadrilateral faces aligned with the cube (taking care of neighbouring pixels also on the surface), use a gradient descent based method to project cube vertices to iso-surface [3].

Parmeters: (Required) Input: specifies the input image containing the implicit surface for polygonization. Currently, the input must NOT have iso-surface pixels on the edge of the image. If this is the case, you MUST use itkConstantPadImageFilter to pad the edges by at least 1 pixel.

(Required) IsoSurfaceValue: specifies the value of the iso-surface for which to generate the mesh. Pixels equal to or greater than this value are considered to lie on the surface or inside the resultant mesh.

(Optional) GenerateTriangleFaces: specifies whether triangle or quadrilateral faces should be generated. The default is to generate triangle faces.

(Optional) ProjectVerticesToIsoSurface: specifies whether the vertices should be projected onto the iso-surface. If projection is disabled, the resultant mesh exhibits the traditional blocky features. Projection takes roughly half of the algorithm time. The default is to project the vertices.

(Optional) ProjectVertexSurfaceDistanceThreshold: specifies the threshold for the 'distance' from iso-surface during vertex projection. Note that the distance is actually measured in pixel value units (not space). The smaller this value, the closer the vertices will be to the iso-surface. Small values result in longer convergence time (i.e. slower). Values are clamped to the range [0.0, max pixel value]. The default value is 0.5.

(Optional) ProjectVertexStepLength: specifies the threshold for the step length during vertex projection. The smaller this value, the more likely the vertices will end up closer to the surface. Small values cause the projection to take longer to converge. Values are clamped to the range [0.0, large]. The default value is max spacing * 0.25 (expressed in physical space).

(Optional) ProjectVertexStepLengthRelaxationFactor: specifies the step length relaxation factor during vertex projection. The step length is multiplied by this factor each iteration to allow convergence. Values are clamped to the range [0.0, 1.0].The default value is 0.95.

(Optional) ProjectVertexMaximumNumberOfSteps: specifies the maximum number of steps used during vertex projection. The default value is 50.

References: [1] G. Herman and H. Liu, "Three-dimensional Display of Human organs from Computed Tomograms", Computer Graphics and Images Processing, Volume 9, Issue 1, Pages 1-21, 1979. [2] D. Gordon and J.K. Udupa, "Fast surface tracking in Three-dimensional Binary Images", Computer Vision, Graphics and Image Processing, Volume 45, Pages 196-214, 1989. [3] http://www2.imm.dtu.dk/~jab/gallery/polygonization.html

This implementation was taken from the Insight Journal: http://hdl.handle.net/10380/3186

Author: Dan Mueller, Philips Healthcare, dan dot muel at gmail dot com

Definition at line 114 of file itkCuberilleImageToMeshFilter.h.

Classes
class	VertexLookupMap

class	VertexLookupNode

Public Types
typedef OutputMeshType::CellIdentifier	CellIdentifier

typedef CellInterface < OutputPixelType, CellTraits >	CellInterfaceType

typedef OutputMeshType::CellsContainer	CellsContainer

typedef OutputMeshType::CellsContainerPointer	CellsContainerPointer

typedef OutputMeshType::CellTraits	CellTraits

typedef SmartPointer< const Self >	ConstPointer

typedef GradientFilterType::Pointer	GradientFilterPointer

typedef GradientImageFilter < InputImageType >	GradientFilterType

typedef GradientImageType::Pointer	GradientImagePointer

typedef GradientFilterType::OutputImageType	GradientImageType

typedef GradientInterpolatorType::Pointer	GradientInterpolatorPointer

typedef itk::VectorLinearInterpolateImageFunction < GradientImageType >	GradientInterpolatorType

typedef GradientFilterType::OutputPixelType	GradientPixelType

typedef InputImageType::IndexType	IndexType

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef ConstShapedNeighborhoodIterator < InputImageType >	InputImageIteratorType

typedef InputImageType::Pointer	InputImagePointer

typedef TInputImage	InputImageType

typedef InputImageType::PixelType	InputPixelType

typedef InterpolatorType::OutputType	InterpolatorOutputType

typedef InterpolatorType::Pointer	InterpolatorPointer

typedef TInterpolator	InterpolatorType

typedef OutputMeshType::Pointer	OutputMeshPointer

typedef OutputMeshType::MeshTraits	OutputMeshTraits

typedef TOutputMesh	OutputMeshType

typedef OutputMeshTraits::PixelType	OutputPixelType

typedef OutputMeshType::PointType	OutputPointType

typedef SmartPointer< Self >	Pointer

typedef OutputMeshType::PointIdentifier	PointIdentifier

typedef OutputMeshType::PointsContainer	PointsContainer

typedef OutputMeshType::PointsContainerPointer	PointsContainerPointer

typedef OutputMeshType::PointType	PointType

typedef QuadrilateralCellType::SelfAutoPointer	QuadrilateralAutoPointer

typedef QuadrilateralCellType::CellAutoPointer	QuadrilateralCellAutoPointer

typedef QuadrilateralCell < CellInterfaceType >	QuadrilateralCellType

typedef CuberilleImageToMeshFilter	Self

typedef InputImageType::SizeType	SizeType

typedef InputImageType::SpacingType	SpacingType

typedef InputImageType::SpacingValueType	SpacingValueType

typedef ImageToMeshFilter < TInputImage, TOutputMesh >	Superclass

typedef TriangleCellType::SelfAutoPointer	TriangleAutoPointer

typedef TriangleCellType::CellAutoPointer	TriangleCellAutoPointer

typedef TriangleCell < CellInterfaceType >	TriangleCellType

Public Types inherited from itk::ImageToMeshFilter< TInputImage, TOutputMesh >
typedef SmartPointer< const Self >	ConstPointer

typedef ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TInputImage	InputImageType

typedef OutputMeshType::Pointer	OutputMeshPointer

typedef TOutputMesh	OutputMeshType

typedef SmartPointer< Self >	Pointer

typedef ImageToMeshFilter	Self

typedef MeshSource< TOutputMesh >	Superclass

Public Types inherited from itk::MeshSource< TOutputMesh >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef OutputMeshType::Pointer	OutputMeshPointer

typedef TOutputMesh	OutputMeshType

typedef SmartPointer< Self >	Pointer

typedef MeshSource	Self

typedef ProcessObject	Superclass

typedef ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer

typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef std::vector < DataObjectPointer >	DataObjectPointerArray

typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType

typedef MultiThreader	MultiThreaderType

typedef std::vector < DataObjectIdentifierType >	NameArray

typedef SmartPointer< Self >	Pointer

typedef ProcessObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

virtual void	SetInput (const InputImageType *inputImage)


virtual InputPixelType	GetIsoSurfaceValue ()

virtual void	SetIsoSurfaceValue (InputPixelType _arg)


	itkGetObjectMacro (Interpolator, InterpolatorType)

virtual void	SetInterpolator (InterpolatorType *_arg)


virtual bool	GetGenerateTriangleFaces ()

virtual void	SetGenerateTriangleFaces (bool _arg)

virtual void	GenerateTriangleFacesOn ()

virtual void	GenerateTriangleFacesOff ()


virtual bool	GetProjectVerticesToIsoSurface ()

virtual void	SetProjectVerticesToIsoSurface (bool _arg)

virtual void	ProjectVerticesToIsoSurfaceOn ()

virtual void	ProjectVerticesToIsoSurfaceOff ()


virtual double	GetProjectVertexSurfaceDistanceThreshold ()

virtual void	SetProjectVertexSurfaceDistanceThreshold (double _arg)


virtual double	GetProjectVertexStepLength ()

virtual void	SetProjectVertexStepLength (double _arg)


virtual double	GetProjectVertexStepLengthRelaxationFactor ()

virtual void	SetProjectVertexStepLengthRelaxationFactor (double _arg)


virtual unsigned int	GetProjectVertexMaximumNumberOfSteps ()

virtual void	SetProjectVertexMaximumNumberOfSteps (unsigned int _arg)

Public Member Functions inherited from itk::ImageToMeshFilter< TInputImage, TOutputMesh >
OutputMeshType *	GetOutput ()

DataObject::Pointer	MakeOutput (DataObjectPointerArraySizeType idx) override

void	SetInput (unsigned int idx, const InputImageType *input)

void	SetInput (const InputImageType *input)

const InputImageType *	GetInput (unsigned int idx)

const InputImageType *	GetInput ()

Public Member Functions inherited from itk::MeshSource< TOutputMesh >
OutputMeshType *	GetOutput ()

OutputMeshType *	GetOutput (unsigned int idx)

virtual void	GraftNthOutput (unsigned int idx, DataObject *output)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)

void	SetOutput (TOutputMesh *output)

virtual void	GraftOutput (DataObject *output)

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual const float &	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

void	SetProgress (float progress)

virtual void	SetReleaseDataFlag (bool flag)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfThreads (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfThreads () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::MeshSource< TOutputMesh >
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
	CuberilleImageToMeshFilter ()

void	GenerateData ()

virtual void	GenerateOutputInformation ()

void	PrintSelf (std::ostream &os, Indent indent) const

	~CuberilleImageToMeshFilter ()

Protected Member Functions inherited from itk::ImageToMeshFilter< TInputImage, TOutputMesh >
	ImageToMeshFilter ()

	~ImageToMeshFilter () override

Protected Member Functions inherited from itk::MeshSource< TOutputMesh >
virtual void	GenerateInputRequestedRegion () override

	MeshSource ()

virtual	~MeshSource () override

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))

	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))

	itkLegacyMacro (virtual void RemoveInput(DataObject *input))

	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)

virtual void	SetPrimaryInput (DataObject *input)

virtual void	SetPrimaryOutput (DataObject *output)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation ()

virtual void	VerifyPreconditions ()

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName (void) const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName (void) const

DataObject *	GetOutput (DataObjectPointerArraySizeType idx)

const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Types
typedef VertexLookupMap < OutputMeshType >	VertexLookupMapType

Private Member Functions

void	ComputeGradientImage ()

void	SetVerticesFromFace (unsigned int face, bool *vertexHasQuad)

IndexType	GetVertexLookupIndex (unsigned int vertex, IndexType index)

void	ProjectVertexToIsoSurface (PointType &vertex)

void	AddVertex (PointIdentifier &id, IndexType index, const InputImageType image, OutputMeshType mesh)

void	AddQuadFace (CellIdentifier &id, PointIdentifier f[4], OutputMeshType *mesh)

Private Attributes
bool	m_GenerateTriangleFaces

GradientInterpolatorPointer	m_GradientInterpolator

InterpolatorPointer	m_Interpolator

InputPixelType	m_IsoSurfaceValue

SpacingValueType	m_MaxSpacing

unsigned int	m_ProjectVertexMaximumNumberOfSteps

double	m_ProjectVertexStepLength

double	m_ProjectVertexStepLengthRelaxationFactor

double	m_ProjectVertexSurfaceDistanceThreshold

bool	m_ProjectVerticesToIsoSurface

Additional Inherited Members
Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime

bool	m_Updating

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount