#include <itkDiscreteLevelSetImage.h>

Detailed Description

template<typename TOutput, unsigned int VDimension>
class itk::DiscreteLevelSetImage< TOutput, VDimension >

Abstract class for a level-set function on one Image.

Template Parameters

TOutput	OutputType of the level-set function value
VDimension	Dimension of the underlying Image.

Definition at line 36 of file itkDiscreteLevelSetImage.h.

Inheritance diagram for itk::DiscreteLevelSetImage< TOutput, VDimension >:

Collaboration diagram for itk::DiscreteLevelSetImage< TOutput, VDimension >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	IndexType = Index< VDimension >

using	Pointer = SmartPointer< Self >

using	Self = DiscreteLevelSetImage

using	Superclass = LevelSetImage< IndexType, VDimension, TOutput >

Public Types inherited from itk::LevelSetImage< Index< VDimension >, VDimension, TOutput >
using	ConstPointer = SmartPointer< const Self >

using	ImageBaseType = ImageBase< VDimension >

using	OffsetType = typename ImageBaseType::OffsetType

using	OffsetValueType = typename ImageBaseType::OffsetValueType

using	Pointer = SmartPointer< Self >

using	Self = LevelSetImage

using	Superclass = LevelSetBase< Index< VDimension >, VDimension, TOutput, ImageBaseType >

Public Types inherited from itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, ImageBase< VDimension > >
using	ConstPointer = SmartPointer< const Self >

using	DomainType = ImageBase< VDimension >

using	GradientType = CovariantVector< OutputRealType, VDimension >

using	HessianType = Matrix< OutputRealType, VDimension, VDimension >

using	InputType = Index< VDimension >

using	OutputRealType = typename NumericTraits< OutputType >::RealType

using	OutputType = TOutput

using	Pointer = SmartPointer< Self >

using	RegionType = IdentifierType

using	Self = LevelSetBase

using	Superclass = DataObject

Public Types inherited from itk::DataObject
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = std::string

using	DataObjectPointerArraySizeType = std::vector< Pointer >::size_type

using	Pointer = SmartPointer< Self >

using	Self = DataObject

using	Superclass = Object

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

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
OutputType	Evaluate (const InputType &inputIndex) const override=0

void	Evaluate (const InputType &inputIndex, LevelSetDataType &data) const override

virtual GradientType	EvaluateBackwardGradient (const InputType &inputIndex) const

void	EvaluateBackwardGradient (const InputType &inputIndex, LevelSetDataType &data) const override

virtual GradientType	EvaluateForwardGradient (const InputType &inputIndex) const

void	EvaluateForwardGradient (const InputType &inputIndex, LevelSetDataType &data) const override

GradientType	EvaluateGradient (const InputType &inputIndex) const override

void	EvaluateGradient (const InputType &inputIndex, LevelSetDataType &data) const override

HessianType	EvaluateHessian (const InputType &inputIndex) const override

void	EvaluateHessian (const InputType &inputIndex, LevelSetDataType &data) const override

OutputRealType	EvaluateLaplacian (const InputType &inputIndex) const override

void	EvaluateLaplacian (const InputType &inputIndex, LevelSetDataType &data) const override

OutputRealType	EvaluateMeanCurvature (const InputType &inputIndex) const override

void	EvaluateMeanCurvature (const InputType &inputIndex, LevelSetDataType &data) const override

const char *	GetNameOfClass () const override

Public Member Functions inherited from itk::LevelSetImage< Index< VDimension >, VDimension, TOutput >
virtual OffsetType	GetDomainOffset () const

const char *	GetNameOfClass () const override

virtual void	SetDomainOffset (OffsetType _arg)

Public Member Functions inherited from itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, ImageBase< VDimension > >
virtual OutputRealType	EvaluateGradientNorm (const InputType &iP) const

virtual void	EvaluateGradientNorm (const InputType &iP, LevelSetDataType &ioData) const

virtual bool	IsInside (const InputType &iP) const

virtual RegionType	GetMaximumNumberOfRegions () const

void	Initialize () override

void	UpdateOutputInformation () override

void	SetRequestedRegionToLargestPossibleRegion () override

void	CopyInformation (const DataObject *data) override

void	Graft (const DataObject *data) override

bool	RequestedRegionIsOutsideOfTheBufferedRegion () override

bool	VerifyRequestedRegion () override

void	SetRequestedRegion (const DataObject *data) override

virtual void	SetRequestedRegion (const RegionType &region)

virtual RegionType	GetRequestedRegion () const

virtual void	SetBufferedRegion (const RegionType &region)

virtual RegionType	GetBufferedRegion () const

Public Member Functions inherited from itk::DataObject
virtual void	DataHasBeenGenerated ()

void	DisconnectPipeline ()

bool	GetDataReleased () const

virtual const bool &	GetReleaseDataFlag () const

SmartPointer< ProcessObject >	GetSource () const

DataObjectPointerArraySizeType	GetSourceOutputIndex () const

const DataObjectIdentifierType &	GetSourceOutputName () const

virtual ModifiedTimeType	GetUpdateMTime () const

virtual void	PrepareForNewData ()

virtual void	PropagateRequestedRegion ()

void	ReleaseData ()

virtual void	ReleaseDataFlagOn ()

virtual void	ResetPipeline ()

void	SetReleaseDataFlag (bool flag)

bool	ShouldIReleaseData () const

virtual void	Update ()

virtual void	UpdateOutputData ()

void	UpdateSource () const

void	SetPipelineMTime (ModifiedTimeType time)

virtual const ModifiedTimeType &	GetPipelineMTime () const

virtual void	SetRealTimeStamp (RealTimeStamp _arg)

virtual const RealTimeStamp &	GetRealTimeStamp () const

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

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

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

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

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

Static Public Attributes
static constexpr unsigned int	Dimension = Superclass::Dimension

Static Public Attributes inherited from itk::LevelSetImage< Index< VDimension >, VDimension, TOutput >
static constexpr unsigned int	Dimension

Static Public Attributes inherited from itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, ImageBase< VDimension > >
static constexpr unsigned int	Dimension

Protected Member Functions
void	CopyInformation (const DataObject *data) override

	DiscreteLevelSetImage ()=default

void	Graft (const DataObject *data) override

void	Initialize () override

	~DiscreteLevelSetImage () override=default

Protected Member Functions inherited from itk::LevelSetImage< Index< VDimension >, VDimension, TOutput >
virtual bool	IsInsideDomain (const InputType &iP) const=0

	LevelSetImage ()

	~LevelSetImage () override=default

Protected Member Functions inherited from itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, ImageBase< VDimension > >
	LevelSetBase ()

	~LevelSetBase () override=default

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

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

virtual void	PropagateResetPipeline ()

	~DataObject () override

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

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

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~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 ()

Additional Inherited Members
Static Public Member Functions inherited from itk::DataObject
static bool	GetGlobalReleaseDataFlag ()

static void	GlobalReleaseDataFlagOff ()

static void	GlobalReleaseDataFlagOn ()

static Pointer	New ()

static void	SetGlobalReleaseDataFlag (bool val)

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

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

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

static Pointer	New ()

Protected Types inherited from itk::LevelSetImage< Index< VDimension >, VDimension, TOutput >
using	ScalingType = GradientType

Protected Attributes inherited from itk::LevelSetImage< Index< VDimension >, VDimension, TOutput >
OffsetType	m_DomainOffset

ScalingType	m_NeighborhoodScales

Protected Attributes inherited from itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, ImageBase< VDimension > >
RegionType	m_MaximumNumberOfRegions

RegionType	m_NumberOfRegions

RegionType	m_RequestedNumberOfRegions

RegionType	m_BufferedRegion

RegionType	m_RequestedRegion

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename TOutput, unsigned int VDimension>

using itk::DiscreteLevelSetImage< TOutput, VDimension >::ConstPointer = SmartPointer<const Self>

Definition at line 45 of file itkDiscreteLevelSetImage.h.

◆ IndexType

template<typename TOutput, unsigned int VDimension>

using itk::DiscreteLevelSetImage< TOutput, VDimension >::IndexType = Index<VDimension>

Definition at line 41 of file itkDiscreteLevelSetImage.h.

◆ Pointer

template<typename TOutput, unsigned int VDimension>

using itk::DiscreteLevelSetImage< TOutput, VDimension >::Pointer = SmartPointer<Self>

Definition at line 44 of file itkDiscreteLevelSetImage.h.

◆ Self

template<typename TOutput, unsigned int VDimension>

using itk::DiscreteLevelSetImage< TOutput, VDimension >::Self = DiscreteLevelSetImage

Definition at line 43 of file itkDiscreteLevelSetImage.h.

◆ Superclass

template<typename TOutput, unsigned int VDimension>

using itk::DiscreteLevelSetImage< TOutput, VDimension >::Superclass = LevelSetImage<IndexType, VDimension, TOutput>

Definition at line 46 of file itkDiscreteLevelSetImage.h.

Constructor & Destructor Documentation

◆ DiscreteLevelSetImage()

template<typename TOutput, unsigned int VDimension>

itk::DiscreteLevelSetImage< TOutput, VDimension >::DiscreteLevelSetImage ( )

protecteddefault

◆ ~DiscreteLevelSetImage()

template<typename TOutput, unsigned int VDimension>

itk::DiscreteLevelSetImage< TOutput, VDimension >::~DiscreteLevelSetImage ( )

overrideprotecteddefault

Member Function Documentation

◆ CopyInformation()

template<typename TOutput, unsigned int VDimension>

void itk::DiscreteLevelSetImage< TOutput, VDimension >::CopyInformation ( const DataObject * data )

overrideprotectedvirtual

Copy level set information from data object

Reimplemented from itk::DataObject.

Reimplemented in itk::LevelSetSparseImage< TOutput, VDimension >, and itk::LevelSetSparseImage< int8_t, VDimension >.

◆ Evaluate() [1/2]

template<typename TOutput, unsigned int VDimension>

OutputType itk::DiscreteLevelSetImage< TOutput, VDimension >::Evaluate ( const InputType & inputIndex ) const

overridepure virtual

Returns the gradient of the level set function at a given location inputIndex

Implements itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, ImageBase< VDimension > >.

Implemented in itk::MalcolmSparseLevelSetImage< VDimension >, itk::WhitakerSparseLevelSetImage< TOutput, VDimension >, itk::ShiSparseLevelSetImage< VDimension >, and itk::LevelSetDenseImage< TImage >.

◆ Evaluate() [2/2]

template<typename TOutput, unsigned int VDimension>

void itk::DiscreteLevelSetImage< TOutput, VDimension >::Evaluate	(	const InputType &	inputIndex,
		LevelSetDataType &	data
	)		const

overridevirtual

Returns the value of the level set function at a given location inputIndex

Implements itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, ImageBase< VDimension > >.

◆ EvaluateBackwardGradient() [1/2]

template<typename TOutput, unsigned int VDimension>

virtual GradientType itk::DiscreteLevelSetImage< TOutput, VDimension >::EvaluateBackwardGradient ( const InputType & inputIndex ) const

virtual

◆ EvaluateBackwardGradient() [2/2]

template<typename TOutput, unsigned int VDimension>

void itk::DiscreteLevelSetImage< TOutput, VDimension >::EvaluateBackwardGradient	(	const InputType &	inputIndex,
		LevelSetDataType &	data
	)		const

overridevirtual

Returns the gradient of the level set function at a given location inputIndex as part of the LevelSetDataType

Implements itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, ImageBase< VDimension > >.

◆ EvaluateForwardGradient() [1/2]

template<typename TOutput, unsigned int VDimension>

virtual GradientType itk::DiscreteLevelSetImage< TOutput, VDimension >::EvaluateForwardGradient ( const InputType & inputIndex ) const

virtual

◆ EvaluateForwardGradient() [2/2]

template<typename TOutput, unsigned int VDimension>

void itk::DiscreteLevelSetImage< TOutput, VDimension >::EvaluateForwardGradient	(	const InputType &	inputIndex,
		LevelSetDataType &	data
	)		const

overridevirtual

Returns the gradient of the level set function at a given location inputIndex as part of the LevelSetDataType

Implements itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, ImageBase< VDimension > >.

◆ EvaluateGradient() [1/2]

template<typename TOutput, unsigned int VDimension>

GradientType itk::DiscreteLevelSetImage< TOutput, VDimension >::EvaluateGradient ( const InputType & inputIndex ) const

overridevirtual

Returns the image gradient of the level set function at a given location inputIndex

Implements itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, ImageBase< VDimension > >.

◆ EvaluateGradient() [2/2]

template<typename TOutput, unsigned int VDimension>

void itk::DiscreteLevelSetImage< TOutput, VDimension >::EvaluateGradient	(	const InputType &	inputIndex,
		LevelSetDataType &	data
	)		const

overridevirtual

Returns the gradient of the level set function at a given location inputIndex as part of the LevelSetDataType

Implements itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, ImageBase< VDimension > >.

◆ EvaluateHessian() [1/2]

template<typename TOutput, unsigned int VDimension>

HessianType itk::DiscreteLevelSetImage< TOutput, VDimension >::EvaluateHessian ( const InputType & inputIndex ) const

overridevirtual

Returns the image hessian of the level set function at a given location inputIndex

Implements itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, ImageBase< VDimension > >.

◆ EvaluateHessian() [2/2]

template<typename TOutput, unsigned int VDimension>

void itk::DiscreteLevelSetImage< TOutput, VDimension >::EvaluateHessian	(	const InputType &	inputIndex,
		LevelSetDataType &	data
	)		const

overridevirtual

Returns the Hessian of the level set function at a given location inputIndex as part of the LevelSetDataType

Implements itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, ImageBase< VDimension > >.

◆ EvaluateLaplacian() [1/2]

template<typename TOutput, unsigned int VDimension>

OutputRealType itk::DiscreteLevelSetImage< TOutput, VDimension >::EvaluateLaplacian ( const InputType & inputIndex ) const

overridevirtual

Returns the image Laplacian of the level set function at a given location inputIndex

Implements itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, ImageBase< VDimension > >.

◆ EvaluateLaplacian() [2/2]

template<typename TOutput, unsigned int VDimension>

void itk::DiscreteLevelSetImage< TOutput, VDimension >::EvaluateLaplacian	(	const InputType &	inputIndex,
		LevelSetDataType &	data
	)		const

overridevirtual

Returns the Laplacian of the level set function at a given location inputIndex as part of the LevelSetDataType

Implements itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, ImageBase< VDimension > >.

◆ EvaluateMeanCurvature() [1/2]

template<typename TOutput, unsigned int VDimension>

OutputRealType itk::DiscreteLevelSetImage< TOutput, VDimension >::EvaluateMeanCurvature ( const InputType & inputIndex ) const

overridevirtual

Returns the mean curvature of the level set function at a given location inputIndex

Implements itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, ImageBase< VDimension > >.

◆ EvaluateMeanCurvature() [2/2]

template<typename TOutput, unsigned int VDimension>

void itk::DiscreteLevelSetImage< TOutput, VDimension >::EvaluateMeanCurvature	(	const InputType &	inputIndex,
		LevelSetDataType &	data
	)		const

overridevirtual

Returns the Hessian of the level set function at a given location inputIndex as part of the LevelSetDataType

Reimplemented from itk::LevelSetBase< Index< VDimension >, VDimension, TOutput, ImageBase< VDimension > >.

◆ GetNameOfClass()

template<typename TOutput, unsigned int VDimension>

const char* itk::DiscreteLevelSetImage< TOutput, VDimension >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::DataObject.

Reimplemented in itk::WhitakerSparseLevelSetImage< TOutput, VDimension >, itk::LevelSetSparseImage< TOutput, VDimension >, and itk::LevelSetSparseImage< int8_t, VDimension >.

◆ Graft()

template<typename TOutput, unsigned int VDimension>

void itk::DiscreteLevelSetImage< TOutput, VDimension >::Graft ( const DataObject * data )

overrideprotectedvirtual

Graft data object as level set object

Reimplemented from itk::DataObject.

Reimplemented in itk::LevelSetSparseImage< TOutput, VDimension >, and itk::LevelSetSparseImage< int8_t, VDimension >.

◆ Initialize()

template<typename TOutput, unsigned int VDimension>

void itk::DiscreteLevelSetImage< TOutput, VDimension >::Initialize ( )

overrideprotectedvirtual

Initial the level set pointer

Reimplemented from itk::DataObject.

Reimplemented in itk::LevelSetSparseImage< TOutput, VDimension >, and itk::LevelSetSparseImage< int8_t, VDimension >.

Member Data Documentation

◆ Dimension

template<typename TOutput, unsigned int VDimension>

constexpr unsigned int itk::DiscreteLevelSetImage< TOutput, VDimension >::Dimension = Superclass::Dimension

staticconstexpr

Definition at line 51 of file itkDiscreteLevelSetImage.h.

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

itkDiscreteLevelSetImage.h

Detailed Description

template<typename TOutput, unsigned int VDimension> class itk::DiscreteLevelSetImage< TOutput, VDimension >

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ IndexType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ DiscreteLevelSetImage()

◆ ~DiscreteLevelSetImage()

Member Function Documentation

◆ CopyInformation()

◆ Evaluate() [1/2]

◆ Evaluate() [2/2]

◆ EvaluateBackwardGradient() [1/2]

◆ EvaluateBackwardGradient() [2/2]

◆ EvaluateForwardGradient() [1/2]

◆ EvaluateForwardGradient() [2/2]

◆ EvaluateGradient() [1/2]

◆ EvaluateGradient() [2/2]

◆ EvaluateHessian() [1/2]

◆ EvaluateHessian() [2/2]

◆ EvaluateLaplacian() [1/2]

◆ EvaluateLaplacian() [2/2]

◆ EvaluateMeanCurvature() [1/2]

◆ EvaluateMeanCurvature() [2/2]

◆ GetNameOfClass()

◆ Graft()

◆ Initialize()

Member Data Documentation

◆ Dimension

template<typename TOutput, unsigned int VDimension>
class itk::DiscreteLevelSetImage< TOutput, VDimension >