ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
itk::LevelSetDenseImage< TImage > Class Template Reference

#include <itkLevelSetDenseImage.h>

Detailed Description

template<typename TImage>
class itk::LevelSetDenseImage< TImage >

Base class for the "dense" representation of a level-set function on one image.

This representation is a "dense" level-set function, i.e. it defines a level-set function on a grid (more precisely the underlying structure is an Image).

Template Parameters
TImageInput image type of the level set function
Todo:
Think about using image iterators instead of GetPixel()
Examples
SphinxExamples/src/Bridge/VtkGlue/VisualizeEvolvingDense2DLevelSetAsElevationMap/Code.cxx, SphinxExamples/src/Bridge/VtkGlue/VisualizeEvolvingDense2DLevelSetZeroSet/Code.cxx, SphinxExamples/src/Bridge/VtkGlue/VisualizeStaticDense2DLevelSetAsElevationMap/Code.cxx, and SphinxExamples/src/Bridge/VtkGlue/VisualizeStaticDense2DLevelSetZeroSet/Code.cxx.

Definition at line 41 of file itkLevelSetDenseImage.h.

+ Inheritance diagram for itk::LevelSetDenseImage< TImage >:
+ Collaboration diagram for itk::LevelSetDenseImage< TImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ImagePointer = typename ImageType::Pointer
 
using ImageType = TImage
 
using IndexType = typename ImageType::IndexType
 
using PixelType = typename ImageType::PixelType
 
using Pointer = SmartPointer< Self >
 
using RegionType = typename ImageType::RegionType
 
using Self = LevelSetDenseImage
 
using Superclass = DiscreteLevelSetImage< PixelType, ImageType::ImageDimension >
 
- Public Types inherited from itk::DiscreteLevelSetImage< TImage::PixelType, TImage::ImageDimension >
using ConstPointer = SmartPointer< const Self >
 
using IndexType = Index< VDimension >
 
using Pointer = SmartPointer< Self >
 
using Self = DiscreteLevelSetImage
 
using Superclass = LevelSetImage< IndexType, VDimension, TImage::PixelType >
 
- Public Types inherited from itk::LevelSetImage< Index< VDimension >, VDimension, TImage::PixelType >
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, TImage::PixelType, ImageBaseType >
 
- Public Types inherited from itk::LevelSetBase< Index< VDimension >, VDimension, TImage::PixelType, 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 = TImage::PixelType
 
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 ImageTypeGetModifiableImage ()
 
const char * GetNameOfClass () const override
 
virtual void SetImage (ImageType *inputImage)
 
OutputType Evaluate (const InputType &inputIndex) const override
 
void Evaluate (const InputType &inputIndex, LevelSetDataType &data) const override
 
- Public Member Functions inherited from itk::DiscreteLevelSetImage< TImage::PixelType, TImage::ImageDimension >
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, TImage::PixelType >
virtual OffsetType GetDomainOffset () const
 
const char * GetNameOfClass () const override
 
virtual void SetDomainOffset (OffsetType _arg)
 
- Public Member Functions inherited from itk::LevelSetBase< Index< VDimension >, VDimension, TImage::PixelType, 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< 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 *)
 
unsigned long AddObserver (const EventObject &event, Command *) 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)
 
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 Member Functions

static Pointer New ()
 
- 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 ()
 

Static Public Attributes

static constexpr unsigned int Dimension = Superclass::Dimension
 
- Static Public Attributes inherited from itk::DiscreteLevelSetImage< TImage::PixelType, TImage::ImageDimension >
static constexpr unsigned int Dimension
 
- Static Public Attributes inherited from itk::LevelSetImage< Index< VDimension >, VDimension, TImage::PixelType >
static constexpr unsigned int Dimension
 
- Static Public Attributes inherited from itk::LevelSetBase< Index< VDimension >, VDimension, TImage::PixelType, ImageBase< VDimension > >
static constexpr unsigned int Dimension
 

Protected Member Functions

void CopyInformation (const DataObject *data) override
 
void Graft (const DataObject *data) override
 
void Initialize () override
 
bool IsInsideDomain (const InputType &inputIndex) const override
 
 LevelSetDenseImage ()=default
 
 ~LevelSetDenseImage () override=default
 
- Protected Member Functions inherited from itk::DiscreteLevelSetImage< TImage::PixelType, TImage::ImageDimension >
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, TImage::PixelType >
 LevelSetImage ()
 
 ~LevelSetImage () override=default
 
- Protected Member Functions inherited from itk::LevelSetBase< Index< VDimension >, VDimension, TImage::PixelType, 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 ()
 

Protected Attributes

ImagePointer m_Image {}
 
- Protected Attributes inherited from itk::LevelSetImage< Index< VDimension >, VDimension, TImage::PixelType >
OffsetType m_DomainOffset
 
ScalingType m_NeighborhoodScales
 
- Protected Attributes inherited from itk::LevelSetBase< Index< VDimension >, VDimension, TImage::PixelType, 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 {}
 

Additional Inherited Members

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

Member Typedef Documentation

◆ ConstPointer

template<typename TImage >
using itk::LevelSetDenseImage< TImage >::ConstPointer = SmartPointer<const Self>

Definition at line 55 of file itkLevelSetDenseImage.h.

◆ ImagePointer

template<typename TImage >
using itk::LevelSetDenseImage< TImage >::ImagePointer = typename ImageType::Pointer

Definition at line 48 of file itkLevelSetDenseImage.h.

◆ ImageType

template<typename TImage >
using itk::LevelSetDenseImage< TImage >::ImageType = TImage

Definition at line 47 of file itkLevelSetDenseImage.h.

◆ IndexType

template<typename TImage >
using itk::LevelSetDenseImage< TImage >::IndexType = typename ImageType::IndexType

Definition at line 49 of file itkLevelSetDenseImage.h.

◆ PixelType

template<typename TImage >
using itk::LevelSetDenseImage< TImage >::PixelType = typename ImageType::PixelType

Definition at line 50 of file itkLevelSetDenseImage.h.

◆ Pointer

template<typename TImage >
using itk::LevelSetDenseImage< TImage >::Pointer = SmartPointer<Self>

Definition at line 54 of file itkLevelSetDenseImage.h.

◆ RegionType

template<typename TImage >
using itk::LevelSetDenseImage< TImage >::RegionType = typename ImageType::RegionType

Definition at line 51 of file itkLevelSetDenseImage.h.

◆ Self

template<typename TImage >
using itk::LevelSetDenseImage< TImage >::Self = LevelSetDenseImage

Definition at line 53 of file itkLevelSetDenseImage.h.

◆ Superclass

template<typename TImage >
using itk::LevelSetDenseImage< TImage >::Superclass = DiscreteLevelSetImage<PixelType, ImageType::ImageDimension>

Definition at line 56 of file itkLevelSetDenseImage.h.

Constructor & Destructor Documentation

◆ LevelSetDenseImage()

template<typename TImage >
itk::LevelSetDenseImage< TImage >::LevelSetDenseImage ( )
protecteddefault

◆ ~LevelSetDenseImage()

template<typename TImage >
itk::LevelSetDenseImage< TImage >::~LevelSetDenseImage ( )
overrideprotecteddefault

Member Function Documentation

◆ CopyInformation()

template<typename TImage >
void itk::LevelSetDenseImage< TImage >::CopyInformation ( const DataObject data)
overrideprotectedvirtual

Copy level set information from data object

Reimplemented from itk::DataObject.

◆ Evaluate() [1/2]

template<typename TImage >
OutputType itk::LevelSetDenseImage< TImage >::Evaluate ( const InputType inputIndex) const
overridevirtual

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

Implements itk::DiscreteLevelSetImage< TImage::PixelType, TImage::ImageDimension >.

◆ Evaluate() [2/2]

template<typename TImage >
void itk::LevelSetDenseImage< TImage >::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, TImage::PixelType, ImageBase< VDimension > >.

◆ GetModifiableImage()

template<typename TImage >
virtual ImageType* itk::LevelSetDenseImage< TImage >::GetModifiableImage ( )
virtual

◆ GetNameOfClass()

template<typename TImage >
const char* itk::LevelSetDenseImage< TImage >::GetNameOfClass ( ) const
overridevirtual

Run-time type information

Reimplemented from itk::DataObject.

◆ Graft()

template<typename TImage >
void itk::LevelSetDenseImage< TImage >::Graft ( const DataObject data)
overrideprotectedvirtual

Graft data object as level set object

Reimplemented from itk::DataObject.

◆ Initialize()

template<typename TImage >
void itk::LevelSetDenseImage< TImage >::Initialize ( )
overrideprotectedvirtual

Initial the level set pointer

Reimplemented from itk::DataObject.

◆ IsInsideDomain()

template<typename TImage >
bool itk::LevelSetDenseImage< TImage >::IsInsideDomain ( const InputType inputIndex) const
overrideprotectedvirtual

◆ New()

template<typename TImage >
static Pointer itk::LevelSetDenseImage< TImage >::New ( )
static

Method for creation through object factory

◆ SetImage()

template<typename TImage >
virtual void itk::LevelSetDenseImage< TImage >::SetImage ( ImageType inputImage)
virtual

Member Data Documentation

◆ Dimension

template<typename TImage >
constexpr unsigned int itk::LevelSetDenseImage< TImage >::Dimension = Superclass::Dimension
staticconstexpr

Definition at line 64 of file itkLevelSetDenseImage.h.

◆ m_Image

template<typename TImage >
ImagePointer itk::LevelSetDenseImage< TImage >::m_Image {}
protected

Definition at line 89 of file itkLevelSetDenseImage.h.


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