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

#include <itkLevelSetBase.h>

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 43 of file itkLevelSetBase.h.

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

Classes

class  DataType
 
struct  LevelSetDataType
 

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DomainType = TDomain
 
using GradientType = CovariantVector< OutputRealType, VDimension >
 
using HessianType = Matrix< OutputRealType, VDimension, VDimension >
 
using InputType = TInput
 
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

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
 
const char * GetNameOfClass () const override
 
- Public Member Functions inherited from itk::DataObject
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointer< ProcessObjectGetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () 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 ModifiedTimeTypeGetPipelineMTime () const
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStampGetRealTimeStamp () 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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 = VDimension
 
RegionType m_MaximumNumberOfRegions { 0 }
 
RegionType m_NumberOfRegions { 0 }
 
RegionType m_RequestedNumberOfRegions { 0 }
 
RegionType m_BufferedRegion { 0 }
 
RegionType m_RequestedRegion { 0 }
 
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
 
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
 
 LevelSetBase ()
 
 ~LevelSetBase () override=default
 

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 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 ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 51 of file itkLevelSetBase.h.

◆ DomainType

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

Definition at line 60 of file itkLevelSetBase.h.

◆ GradientType

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

Definition at line 62 of file itkLevelSetBase.h.

◆ HessianType

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

Definition at line 63 of file itkLevelSetBase.h.

◆ InputType

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

Definition at line 58 of file itkLevelSetBase.h.

◆ OutputRealType

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

Definition at line 61 of file itkLevelSetBase.h.

◆ OutputType

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

Definition at line 59 of file itkLevelSetBase.h.

◆ Pointer

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

Definition at line 50 of file itkLevelSetBase.h.

◆ RegionType

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

Type used to define Regions

Definition at line 66 of file itkLevelSetBase.h.

◆ Self

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

Definition at line 48 of file itkLevelSetBase.h.

◆ Superclass

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

Definition at line 49 of file itkLevelSetBase.h.

Constructor & Destructor Documentation

◆ LevelSetBase()

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 \)

◆ ~LevelSetBase()

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

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

Member Function Documentation

◆ CopyInformation()

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
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 from itk::DataObject.

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

◆ Evaluate() [1/2]

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

◆ Evaluate() [2/2]

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

◆ EvaluateBackwardGradient()

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

◆ EvaluateForwardGradient()

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

◆ EvaluateGradient() [1/2]

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

◆ EvaluateGradient() [2/2]

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

◆ EvaluateGradientNorm() [1/2]

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

◆ EvaluateGradientNorm() [2/2]

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 \)

◆ EvaluateHessian() [1/2]

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

◆ EvaluateHessian() [2/2]

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

◆ EvaluateLaplacian() [1/2]

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

◆ EvaluateLaplacian() [2/2]

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

◆ EvaluateMeanCurvature() [1/2]

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

◆ EvaluateMeanCurvature() [2/2]

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

◆ GetBufferedRegion()

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 \)

◆ GetMaximumNumberOfRegions()

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.

◆ GetNameOfClass()

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

◆ GetRequestedRegion()

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 \)

◆ Graft()

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
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 from itk::DataObject.

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

◆ Initialize()

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

Initialize the level set function

Reimplemented from itk::DataObject.

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

◆ IsInside()

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 \)

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

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

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

Reimplemented from itk::DataObject.

◆ SetBufferedRegion()

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

◆ SetRequestedRegion() [1/2]

template<typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
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.

Reimplemented from itk::DataObject.

◆ SetRequestedRegion() [2/2]

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

◆ SetRequestedRegionToLargestPossibleRegion()

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

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

Reimplemented from itk::DataObject.

◆ UpdateOutputInformation()

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

Methods to manage streaming.

Reimplemented from itk::DataObject.

◆ VerifyRequestedRegion()

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

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

Reimplemented from itk::DataObject.

Member Data Documentation

◆ Dimension

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

Definition at line 56 of file itkLevelSetBase.h.

◆ m_BufferedRegion

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

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

Definition at line 274 of file itkLevelSetBase.h.

◆ m_MaximumNumberOfRegions

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

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

Definition at line 271 of file itkLevelSetBase.h.

◆ m_NumberOfRegions

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

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

Definition at line 272 of file itkLevelSetBase.h.

◆ m_RequestedNumberOfRegions

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

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

Definition at line 273 of file itkLevelSetBase.h.

◆ m_RequestedRegion

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

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

Definition at line 275 of file itkLevelSetBase.h.


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