ITK  4.12.0
Insight Segmentation and Registration Toolkit
Classes | Public Types | Public Member Functions | Static Public Attributes | List of all members
itk::LevelSetBase< TInput, VDimension, TOutput, TDomain > Class Template Referenceabstract
Module ITKLevelSetsv4

#include <itkLevelSetBase.h>

+ Inheritance diagram for itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >:
+ Collaboration diagram for itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >:

Detailed Description

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
class itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >

Abstract base class for the representation of a level-set function.

Template Parameters
TInputInput type where the level set function will be evaluated
VDimensionDimension of the input space
TOutputReturned type when evaluating the level set function
TDomainSupport of the level-set function (e.g. Image or QuadEdgeMesh)

Definition at line 41 of file itkLevelSetBase.h.

Classes

class  DataType
 
struct  LevelSetDataType
 

Public Types

typedef SmartPointer< const Self > ConstPointer
 
typedef TDomain DomainType
 
typedef CovariantVector
< OutputRealType, VDimension > 		GradientType
 
typedef Matrix< OutputRealType,
VDimension, VDimension > 		HessianType
 
typedef TInput InputType
 
typedef NumericTraits
< OutputType >::RealType 		OutputRealType
 
typedef TOutput OutputType
 
typedef SmartPointer< Self > Pointer
 
typedef IdentifierType RegionType
 
typedef LevelSetBase Self
 
typedef DataObject Superclass
 

Public Member Functions

virtual OutputType Evaluate (const InputType &iP) const =0
 
virtual GradientType EvaluateGradient (const InputType &iP) const =0
 
virtual OutputRealType EvaluateGradientNorm (const InputType &iP) const
 
virtual HessianType EvaluateHessian (const InputType &iP) const =0
 
virtual OutputRealType EvaluateLaplacian (const InputType &iP) const =0
 
virtual OutputRealType EvaluateMeanCurvature (const InputType &iP) const =0
 
virtual const char * GetNameOfClass () const
 

Static Public Attributes

static const unsigned int Dimension = VDimension
 
RegionType m_MaximumNumberOfRegions
 
RegionType m_NumberOfRegions
 
RegionType m_RequestedNumberOfRegions
 
RegionType m_BufferedRegion
 
RegionType m_RequestedRegion
 
virtual void Evaluate (const InputType &iP, LevelSetDataType &ioData) const =0
 
virtual void EvaluateGradient (const InputType &iP, LevelSetDataType &ioData) const =0
 
virtual void EvaluateHessian (const InputType &iP, LevelSetDataType &ioData) const =0
 
virtual void EvaluateLaplacian (const InputType &iP, LevelSetDataType &ioData) const =0
 
virtual void EvaluateGradientNorm (const InputType &iP, LevelSetDataType &ioData) const
 
virtual void EvaluateMeanCurvature (const InputType &iP, LevelSetDataType &ioData) const
 
virtual void EvaluateForwardGradient (const InputType &iP, LevelSetDataType &ioData) const =0
 
virtual void EvaluateBackwardGradient (const InputType &iP, LevelSetDataType &ioData) const =0
 
virtual bool IsInside (const InputType &iP) const
 
virtual RegionType GetMaximumNumberOfRegions () const
 
virtual void Initialize () override
 
virtual void UpdateOutputInformation () override
 
virtual void SetRequestedRegionToLargestPossibleRegion () override
 
virtual void CopyInformation (const DataObject *data) override
 
virtual void Graft (const DataObject *data) override
 
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 
virtual bool VerifyRequestedRegion () override
 
virtual 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
 
 LevelSetBase ()
 
virtual ~LevelSetBase ()
 
 LevelSetBase (const Self &)
 
void operator= (const Self &)
 

Member Typedef Documentation

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
typedef SmartPointer< const Self > itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::ConstPointer

Definition at line 47 of file itkLevelSetBase.h.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
typedef TDomain itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::DomainType

Definition at line 56 of file itkLevelSetBase.h.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
typedef CovariantVector< OutputRealType, VDimension > itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::GradientType

Definition at line 58 of file itkLevelSetBase.h.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
typedef Matrix< OutputRealType, VDimension, VDimension > itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::HessianType

Definition at line 59 of file itkLevelSetBase.h.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
typedef TInput itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::InputType

Definition at line 54 of file itkLevelSetBase.h.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
typedef NumericTraits< OutputType >::RealType itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::OutputRealType

Definition at line 57 of file itkLevelSetBase.h.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
typedef TOutput itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::OutputType

Definition at line 55 of file itkLevelSetBase.h.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
typedef SmartPointer< Self > itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::Pointer

Definition at line 46 of file itkLevelSetBase.h.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
typedef IdentifierType itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::RegionType

Type used to define Regions

Definition at line 62 of file itkLevelSetBase.h.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
typedef LevelSetBase itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::Self

Definition at line 44 of file itkLevelSetBase.h.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
typedef DataObject itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::Superclass

Definition at line 45 of file itkLevelSetBase.h.

Constructor & Destructor Documentation

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::LevelSetBase ( )
protected

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::~LevelSetBase ( )
inlineprotectedvirtual

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

Definition at line 215 of file itkLevelSetBase.h.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::LevelSetBase ( const Self &  )
private

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

Member Function Documentation

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual void itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::CopyInformation ( const DataObject *  data)
overridevirtual

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

Reimplemented in itk::LevelSetSparseImage< TOutput, VDimension >, itk::LevelSetSparseImage< int8_t, VDimension >, itk::DiscreteLevelSetImage< TOutput, VDimension >, itk::DiscreteLevelSetImage< int8_t, VDimension >, itk::DiscreteLevelSetImage< TImage::PixelType, TImage::ImageDimension >, itk::LevelSetQuadEdgeMesh< TMesh >, and itk::LevelSetDenseImage< TImage >.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual OutputType itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::Evaluate ( const InputType &  iP) const
pure virtual

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

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual void itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::Evaluate ( const InputType &  iP,
LevelSetDataType &  ioData 
) const
pure virtual

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual void itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::EvaluateBackwardGradient ( const InputType &  iP,
LevelSetDataType &  ioData 
) const
pure virtual

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual void itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::EvaluateForwardGradient ( const InputType &  iP,
LevelSetDataType &  ioData 
) const
pure virtual

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual GradientType itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::EvaluateGradient ( const InputType &  iP) const
pure virtual

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

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual void itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::EvaluateGradient ( const InputType &  iP,
LevelSetDataType &  ioData 
) const
pure virtual

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual OutputRealType itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::EvaluateGradientNorm ( const InputType &  iP) const
virtual
template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual void itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::EvaluateGradientNorm ( const InputType &  iP,
LevelSetDataType &  ioData 
) const
virtual

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual HessianType itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::EvaluateHessian ( const InputType &  iP) const
pure virtual

Returns the hessian of the level set function at a given location iP

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual void itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::EvaluateHessian ( const InputType &  iP,
LevelSetDataType &  ioData 
) const
pure virtual

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual OutputRealType itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::EvaluateLaplacian ( const InputType &  iP) const
pure virtual
template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual void itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::EvaluateLaplacian ( const InputType &  iP,
LevelSetDataType &  ioData 
) const
pure virtual

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual OutputRealType itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::EvaluateMeanCurvature ( const InputType &  iP) const
pure virtual
template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual void itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::EvaluateMeanCurvature ( const InputType &  iP,
LevelSetDataType &  ioData 
) const
virtual

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual RegionType itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::GetBufferedRegion ( ) const
virtual

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual RegionType itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::GetMaximumNumberOfRegions ( ) const
virtual

Get the maximum number of regions that this data can be separated into.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual const char* itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::GetNameOfClass ( ) const
virtual

Run-time type information

Reimplemented in itk::LevelSetDenseImage< TImage >, itk::LevelSetQuadEdgeMesh< TMesh >, itk::MalcolmSparseLevelSetImage< VDimension >, itk::WhitakerSparseLevelSetImage< TOutput, VDimension >, itk::LevelSetImage< TInput, VDimension, TOutput >, itk::ShiSparseLevelSetImage< VDimension >, itk::LevelSetImage< Index< VDimension >, VDimension, TOutput >, itk::LevelSetImage< Index< VDimension >, VDimension, TImage::PixelType >, itk::LevelSetImage< Index< VDimension >, VDimension, int8_t >, itk::LevelSetSparseImage< TOutput, VDimension >, itk::LevelSetSparseImage< int8_t, VDimension >, itk::DiscreteLevelSetImage< TOutput, VDimension >, itk::DiscreteLevelSetImage< int8_t, VDimension >, and itk::DiscreteLevelSetImage< TImage::PixelType, TImage::ImageDimension >.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual RegionType itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::GetRequestedRegion ( ) const
virtual

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual void itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::Graft ( const DataObject *  data)
overridevirtual

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

Reimplemented in itk::DiscreteLevelSetImage< TOutput, VDimension >, itk::DiscreteLevelSetImage< int8_t, VDimension >, itk::DiscreteLevelSetImage< TImage::PixelType, TImage::ImageDimension >, itk::LevelSetQuadEdgeMesh< TMesh >, itk::LevelSetSparseImage< TOutput, VDimension >, itk::LevelSetSparseImage< int8_t, VDimension >, and itk::LevelSetDenseImage< TImage >.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual void itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::Initialize ( )
overridevirtual

Initialize the level set function

Reimplemented in itk::LevelSetSparseImage< TOutput, VDimension >, itk::LevelSetSparseImage< int8_t, VDimension >, itk::DiscreteLevelSetImage< TOutput, VDimension >, itk::DiscreteLevelSetImage< int8_t, VDimension >, itk::DiscreteLevelSetImage< TImage::PixelType, TImage::ImageDimension >, itk::LevelSetQuadEdgeMesh< TMesh >, and itk::LevelSetDenseImage< TImage >.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual bool itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::IsInside ( const InputType &  iP) const
virtual

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
void itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::operator= ( const Self &  )
private

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual bool itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::RequestedRegionIsOutsideOfTheBufferedRegion ( )
overridevirtual

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual void itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::SetBufferedRegion ( const RegionType &  region)
virtual

Set/Get the Buffered region

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual void itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::SetRequestedRegion ( const DataObject *  data)
overridevirtual

Set the requested region from this data object to match the requested region of the data object passed in as a parameter. This method implements the API from DataObject. The data object parameter must be castable to a PointSet.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual void itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::SetRequestedRegion ( const RegionType &  region)
virtual

Set/Get the Requested region

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual void itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::SetRequestedRegionToLargestPossibleRegion ( )
overridevirtual

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual void itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::UpdateOutputInformation ( )
overridevirtual

Methods to manage streaming.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
virtual bool itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::VerifyRequestedRegion ( )
overridevirtual

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

Member Data Documentation

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
const unsigned int itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::Dimension = VDimension
static

Definition at line 52 of file itkLevelSetBase.h.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
RegionType itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::m_BufferedRegion
protected

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

Definition at line 230 of file itkLevelSetBase.h.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
RegionType itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::m_MaximumNumberOfRegions
protected

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

Definition at line 227 of file itkLevelSetBase.h.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
RegionType itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::m_NumberOfRegions
protected

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

Definition at line 228 of file itkLevelSetBase.h.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
RegionType itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::m_RequestedNumberOfRegions
protected

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

Definition at line 229 of file itkLevelSetBase.h.

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
RegionType itk::LevelSetBase< TInput, VDimension, TOutput, TDomain >::m_RequestedRegion
protected

Returns true if iP is inside the level set, i.e. $\phi(p) \le 0 $

Definition at line 231 of file itkLevelSetBase.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Tue May 30 2017 04:23:36 for ITK by   doxygen 1.8.5