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::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage > Class Template Reference

#include <itkFastMarchingImageToNodePairContainerAdaptor.h>

Detailed Description

template<typename TInput, typename TOutput, typename TImage>
class itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >

Convenient adaptor class which converts Image into FastMarching::NodePairContainerType used for initializing the FastMarching.

One provides images by means of SetAliveImage, SetTrialImage, SetForbiddenImage and get corresponding containers by means of GetAlivePoints, GetTrialPoints, GetForbiddenPoints.

One can globally set the associated value for all FastMarchingTraitsBase::Alive points by means of SetAliveValue; and for all FastMarchingTraitsBase::Trial points by means of SetTrialValue.

To restrict the evolution of the front in certain area, one can use SetForbiddenImage and SetIsForbiddenImageBinaryMask depending on the input image.

See also
FastMarchingTraitsBase
FastMarchingBase
Examples
SphinxExamples/src/Filtering/FastMarching/CreateDistanceMapFromSeeds/Code.cxx.

Definition at line 50 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

+ Inheritance diagram for itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >:
+ Collaboration diagram for itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ImageConstPointer = typename ImageType::ConstPointer
 
using ImagePixelType = typename ImageType::PixelType
 
using ImagePointer = typename ImageType::Pointer
 
using ImageType = TImage
 
using LabelType = typename Traits::LabelType
 
using NodePairContainerPointer = typename Traits::NodePairContainerPointer
 
using NodePairContainerType = typename Traits::NodePairContainerType
 
using NodePairType = typename Traits::NodePairType
 
using OutputPixelType = typename Traits::OutputPixelType
 
using Pointer = SmartPointer< Self >
 
using Self = FastMarchingImageToNodePairContainerAdaptor
 
using Superclass = Object
 
using Traits = FastMarchingTraits< TInput, TOutput >
 
- 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 const ImageTypeGetAliveImage () const
 
NodePairContainerTypeGetAlivePoints ()
 
virtual OutputPixelType GetAliveValue () const
 
virtual const ImageTypeGetForbiddenImage () const
 
NodePairContainerTypeGetForbiddenPoints ()
 
virtual bool GetIsForbiddenImageBinaryMask () const
 
const char * GetNameOfClass () const override
 
virtual const ImageTypeGetTrialImage () const
 
NodePairContainerTypeGetTrialPoints ()
 
virtual OutputPixelType GetTrialValue () const
 
virtual void IsForbiddenImageBinaryMaskOn ()
 
void SetAliveImage (const ImageType *iImage)
 
virtual void SetAliveValue (OutputPixelType _arg)
 
void SetForbiddenImage (const ImageType *iImage)
 
virtual void SetIsForbiddenImageBinaryMask (bool _arg)
 
void SetTrialImage (const ImageType *iImage)
 
virtual void SetTrialValue (OutputPixelType _arg)
 
void Update ()
 
- 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) 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 Member Functions

static Pointer New ()
 
- 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 ImageDimension = Traits::ImageDimension
 

Protected Member Functions

 FastMarchingImageToNodePairContainerAdaptor ()
 
virtual void GenerateData ()
 
void SetPointsFromImage (const ImageType *image, const LabelType &iLabel, const OutputPixelType &iValue)
 
 ~FastMarchingImageToNodePairContainerAdaptor () override=default
 
- 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

ImageConstPointer m_AliveImage {}
 
NodePairContainerPointer m_AlivePoints {}
 
OutputPixelType m_AliveValue {}
 
ImageConstPointer m_ForbiddenImage {}
 
NodePairContainerPointer m_ForbiddenPoints {}
 
bool m_IsForbiddenImageBinaryMask { false }
 
ImageConstPointer m_TrialImage {}
 
NodePairContainerPointer m_TrialPoints {}
 
OutputPixelType m_TrialValue {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TInput , typename TOutput , typename TImage >
using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::ConstPointer = SmartPointer<const Self>

◆ ImageConstPointer

template<typename TInput , typename TOutput , typename TImage >
using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::ImageConstPointer = typename ImageType::ConstPointer

◆ ImagePixelType

template<typename TInput , typename TOutput , typename TImage >
using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::ImagePixelType = typename ImageType::PixelType

◆ ImagePointer

template<typename TInput , typename TOutput , typename TImage >
using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::ImagePointer = typename ImageType::Pointer

◆ ImageType

template<typename TInput , typename TOutput , typename TImage >
using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::ImageType = TImage

◆ LabelType

template<typename TInput , typename TOutput , typename TImage >
using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::LabelType = typename Traits::LabelType

◆ NodePairContainerPointer

template<typename TInput , typename TOutput , typename TImage >
using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::NodePairContainerPointer = typename Traits::NodePairContainerPointer

◆ NodePairContainerType

template<typename TInput , typename TOutput , typename TImage >
using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::NodePairContainerType = typename Traits::NodePairContainerType

◆ NodePairType

template<typename TInput , typename TOutput , typename TImage >
using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::NodePairType = typename Traits::NodePairType

◆ OutputPixelType

template<typename TInput , typename TOutput , typename TImage >
using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::OutputPixelType = typename Traits::OutputPixelType

◆ Pointer

template<typename TInput , typename TOutput , typename TImage >
using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::Pointer = SmartPointer<Self>

◆ Self

template<typename TInput , typename TOutput , typename TImage >
using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::Self = FastMarchingImageToNodePairContainerAdaptor

◆ Superclass

template<typename TInput , typename TOutput , typename TImage >
using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::Superclass = Object

◆ Traits

template<typename TInput , typename TOutput , typename TImage >
using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::Traits = FastMarchingTraits<TInput, TOutput>

Constructor & Destructor Documentation

◆ FastMarchingImageToNodePairContainerAdaptor()

template<typename TInput , typename TOutput , typename TImage >
itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::FastMarchingImageToNodePairContainerAdaptor ( )
protected

Constructor.

◆ ~FastMarchingImageToNodePairContainerAdaptor()

template<typename TInput , typename TOutput , typename TImage >
itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::~FastMarchingImageToNodePairContainerAdaptor ( )
overrideprotecteddefault

Destructor.

Member Function Documentation

◆ GenerateData()

template<typename TInput , typename TOutput , typename TImage >
virtual void itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::GenerateData ( )
protectedvirtual

◆ GetAliveImage()

template<typename TInput , typename TOutput , typename TImage >
virtual const ImageType* itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::GetAliveImage ( ) const
virtual

◆ GetAlivePoints()

template<typename TInput , typename TOutput , typename TImage >
NodePairContainerType* itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::GetAlivePoints ( )

Get resulting Alive Points container.

◆ GetAliveValue()

template<typename TInput , typename TOutput , typename TImage >
virtual OutputPixelType itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::GetAliveValue ( ) const
virtual

◆ GetForbiddenImage()

template<typename TInput , typename TOutput , typename TImage >
virtual const ImageType* itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::GetForbiddenImage ( ) const
virtual

◆ GetForbiddenPoints()

template<typename TInput , typename TOutput , typename TImage >
NodePairContainerType* itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::GetForbiddenPoints ( )

Get resulting Forbidden Points container.

◆ GetIsForbiddenImageBinaryMask()

template<typename TInput , typename TOutput , typename TImage >
virtual bool itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::GetIsForbiddenImageBinaryMask ( ) const
virtual

◆ GetNameOfClass()

template<typename TInput , typename TOutput , typename TImage >
const char* itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ GetTrialImage()

template<typename TInput , typename TOutput , typename TImage >
virtual const ImageType* itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::GetTrialImage ( ) const
virtual

◆ GetTrialPoints()

template<typename TInput , typename TOutput , typename TImage >
NodePairContainerType* itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::GetTrialPoints ( )

Get resulting Trial Points container.

◆ GetTrialValue()

template<typename TInput , typename TOutput , typename TImage >
virtual OutputPixelType itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::GetTrialValue ( ) const
virtual

◆ IsForbiddenImageBinaryMaskOn()

template<typename TInput , typename TOutput , typename TImage >
virtual void itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::IsForbiddenImageBinaryMaskOn ( )
virtual

◆ New()

template<typename TInput , typename TOutput , typename TImage >
static Pointer itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::New ( )
static

Method for creation through the object factory.

◆ SetAliveImage()

template<typename TInput , typename TOutput , typename TImage >
void itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::SetAliveImage ( const ImageType iImage)

Set one Alive Image.

Note
Only pixels with non null values are considered as FastMarchingTraitsBase::Alive points.

◆ SetAliveValue()

template<typename TInput , typename TOutput , typename TImage >
virtual void itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::SetAliveValue ( OutputPixelType  _arg)
virtual

◆ SetForbiddenImage()

template<typename TInput , typename TOutput , typename TImage >
void itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::SetForbiddenImage ( const ImageType iImage)

Set one Forbidden Image. There are two possible behaviors here depending on m_IsForbiddenImageBinaryMask:

◆ SetIsForbiddenImageBinaryMask()

template<typename TInput , typename TOutput , typename TImage >
virtual void itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::SetIsForbiddenImageBinaryMask ( bool  _arg)
virtual

◆ SetPointsFromImage()

template<typename TInput , typename TOutput , typename TImage >
void itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::SetPointsFromImage ( const ImageType image,
const LabelType iLabel,
const OutputPixelType iValue 
)
protected

◆ SetTrialImage()

template<typename TInput , typename TOutput , typename TImage >
void itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::SetTrialImage ( const ImageType iImage)

Set one Trial Image.

Note
Only pixels with non null values are considered as FastMarchingTraitsBase::TrialPoints.

◆ SetTrialValue()

template<typename TInput , typename TOutput , typename TImage >
virtual void itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::SetTrialValue ( OutputPixelType  _arg)
virtual

◆ Update()

template<typename TInput , typename TOutput , typename TImage >
void itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::Update ( )

Perform the conversion.

Member Data Documentation

◆ ImageDimension

template<typename TInput , typename TOutput , typename TImage >
constexpr unsigned int itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::ImageDimension = Traits::ImageDimension
staticconstexpr

◆ m_AliveImage

template<typename TInput , typename TOutput , typename TImage >
ImageConstPointer itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::m_AliveImage {}
protected

◆ m_AlivePoints

template<typename TInput , typename TOutput , typename TImage >
NodePairContainerPointer itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::m_AlivePoints {}
protected

◆ m_AliveValue

template<typename TInput , typename TOutput , typename TImage >
OutputPixelType itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::m_AliveValue {}
protected

◆ m_ForbiddenImage

template<typename TInput , typename TOutput , typename TImage >
ImageConstPointer itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::m_ForbiddenImage {}
protected

◆ m_ForbiddenPoints

template<typename TInput , typename TOutput , typename TImage >
NodePairContainerPointer itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::m_ForbiddenPoints {}
protected

◆ m_IsForbiddenImageBinaryMask

template<typename TInput , typename TOutput , typename TImage >
bool itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::m_IsForbiddenImageBinaryMask { false }
protected

◆ m_TrialImage

template<typename TInput , typename TOutput , typename TImage >
ImageConstPointer itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::m_TrialImage {}
protected

◆ m_TrialPoints

template<typename TInput , typename TOutput , typename TImage >
NodePairContainerPointer itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::m_TrialPoints {}
protected

◆ m_TrialValue

template<typename TInput , typename TOutput , typename TImage >
OutputPixelType itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::m_TrialValue {}
protected

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