ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | List of all members
itk::LevelSetImage< TInput, VDimension, TOutput > Class Template Referenceabstract
Group Segmentation » Module ITKLevelSetsv4

#include <itkLevelSetImage.h>

Detailed Description

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

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

Template Parameters
TOutputOutputType of the level-set function value
VDimensionDimension of the underlying Image.

Definition at line 39 of file itkLevelSetImage.h.

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

Public Types

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< TInput, VDimension, TOutput, ImageBaseType >
 
- Public Types inherited from itk::LevelSetBase< TInput, 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 = 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 OffsetType GetDomainOffset () const
 
const char * GetNameOfClass () const override
 
virtual void SetDomainOffset (OffsetType _arg)
 
- Public Member Functions inherited from itk::LevelSetBase< TInput, VDimension, TOutput, ImageBase< VDimension > >
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
 
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
 
- 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 *)
 
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
 
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)
 
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::LevelSetBase< TInput, VDimension, TOutput, ImageBase< VDimension > >
static constexpr unsigned int Dimension
 

Protected Types

using ScalingType = GradientType
 

Protected Member Functions

virtual bool IsInsideDomain (const InputType &iP) const =0
 
 LevelSetImage ()
 
 ~LevelSetImage () override=default
 
- Protected Member Functions inherited from itk::LevelSetBase< TInput, 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 ()
 

Protected Attributes

OffsetType m_DomainOffset {}
 
ScalingType m_NeighborhoodScales {}
 
- Protected Attributes inherited from itk::LevelSetBase< TInput, 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 {}
 

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

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 48 of file itkLevelSetImage.h.

◆ ImageBaseType

template<typename TInput, unsigned int VDimension, typename TOutput>
using itk::LevelSetImage< TInput, VDimension, TOutput >::ImageBaseType = ImageBase<VDimension>

Definition at line 44 of file itkLevelSetImage.h.

◆ OffsetType

template<typename TInput, unsigned int VDimension, typename TOutput>
using itk::LevelSetImage< TInput, VDimension, TOutput >::OffsetType = typename ImageBaseType::OffsetType

Definition at line 62 of file itkLevelSetImage.h.

◆ OffsetValueType

template<typename TInput, unsigned int VDimension, typename TOutput>
using itk::LevelSetImage< TInput, VDimension, TOutput >::OffsetValueType = typename ImageBaseType::OffsetValueType

Definition at line 63 of file itkLevelSetImage.h.

◆ Pointer

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

Definition at line 47 of file itkLevelSetImage.h.

◆ ScalingType

template<typename TInput, unsigned int VDimension, typename TOutput>
using itk::LevelSetImage< TInput, VDimension, TOutput >::ScalingType = GradientType
protected

Definition at line 74 of file itkLevelSetImage.h.

◆ Self

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

Definition at line 46 of file itkLevelSetImage.h.

◆ Superclass

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

Definition at line 49 of file itkLevelSetImage.h.

Constructor & Destructor Documentation

◆ LevelSetImage()

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

◆ ~LevelSetImage()

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

Member Function Documentation

◆ GetDomainOffset()

template<typename TInput, unsigned int VDimension, typename TOutput>
virtual OffsetType itk::LevelSetImage< TInput, VDimension, TOutput >::GetDomainOffset ( ) const
virtual

◆ GetNameOfClass()

template<typename TInput, unsigned int VDimension, typename TOutput>
const char* itk::LevelSetImage< TInput, VDimension, TOutput >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::DataObject.

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

◆ IsInsideDomain()

template<typename TInput, unsigned int VDimension, typename TOutput>
virtual bool itk::LevelSetImage< TInput, VDimension, TOutput >::IsInsideDomain ( const InputType &  iP) const
protectedpure virtual

Implemented in itk::LevelSetSparseImage< TOutput, VDimension >, itk::LevelSetSparseImage< int8_t, VDimension >, and itk::LevelSetDenseImage< TImage >.

◆ SetDomainOffset()

template<typename TInput, unsigned int VDimension, typename TOutput>
virtual void itk::LevelSetImage< TInput, VDimension, TOutput >::SetDomainOffset ( OffsetType  _arg)
virtual

Member Data Documentation

◆ Dimension

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

Definition at line 54 of file itkLevelSetImage.h.

◆ m_DomainOffset

template<typename TInput, unsigned int VDimension, typename TOutput>
OffsetType itk::LevelSetImage< TInput, VDimension, TOutput >::m_DomainOffset {}
protected

Definition at line 76 of file itkLevelSetImage.h.

◆ m_NeighborhoodScales

template<typename TInput, unsigned int VDimension, typename TOutput>
ScalingType itk::LevelSetImage< TInput, VDimension, TOutput >::m_NeighborhoodScales {}
protected

Definition at line 75 of file itkLevelSetImage.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. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16