ITK  4.1.0
Insight Segmentation and Registration Toolkit
Classes | Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions
itk::NarrowBandImageFilterBase< TInputImage, TOutputImage > Class Template Reference

#include <itkNarrowBandImageFilterBase.h>

+ Inheritance diagram for itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >:
+ Collaboration diagram for itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >:

List of all members.

Classes

struct  NarrowBandImageFilterBaseThreadStruct
struct  ThreadRegionType

Public Types

typedef BandNode< IndexType,
PixelType
BandNodeType
typedef SmartPointer< const SelfConstPointer
typedef
Superclass::FiniteDifferenceFunctionType 
FiniteDifferenceFunctionType
typedef OutputImageType::IndexType IndexType
typedef Superclass::InputImageType InputImageType
typedef NarrowBandType::Iterator NarrowBandIterator
typedef NarrowBandType::Pointer NarrowBandPointer
typedef NarrowBand< BandNodeTypeNarrowBandType
typedef Superclass::OutputImageType OutputImageType
typedef Superclass::PixelType PixelType
typedef SmartPointer< SelfPointer
typedef NarrowBandType::RegionType RegionType
typedef NarrowBandImageFilterBase Self
typedef
FiniteDifferenceImageFilter
< TInputImage, TOutputImage > 
Superclass
typedef Superclass::TimeStepType TimeStepType
typedef OutputImageType::ValueType ValueType

Public Member Functions

virtual void CopyInputToOutput ()
virtual void CreateNarrowBand ()
virtual const char * GetNameOfClass () const
float GetNarrowBandInnerRadius () const
float GetNarrowBandTotalRadius () const
void InsertNarrowBandNode (const IndexType &index)
void InsertNarrowBandNode (const IndexType &index, const PixelType &value, const signed char &nodestate)
virtual void SetNarrowBand (NarrowBandType *ptr)
virtual void SetIsoSurfaceValue (ValueType _arg)
virtual ValueType GetIsoSurfaceValue () const
void InsertNarrowBandNode (const BandNodeType &node)
void SetNarrowBandTotalRadius (const float &val)
void SetNarrowBandInnerRadius (const float &val)

Static Public Attributes

static const unsigned int ImageDimension = Superclass::ImageDimension

Protected Member Functions

void ClearNarrowBand ()
virtual void GenerateData ()
void GetSplitRegion (const vcl_size_t &i, ThreadRegionType &splitRegion)
virtual void Initialize ()
virtual void InitializeIteration ()
 NarrowBandImageFilterBase ()
virtual void PostProcessOutput ()
void PrintSelf (std::ostream &os, Indent indent) const
void WaitForAll ()
virtual ~NarrowBandImageFilterBase ()

Protected Attributes

Barrier::Pointer m_Barrier
ValueType m_IsoSurfaceValue
NarrowBandPointer m_NarrowBand
std::vector< RegionTypem_RegionList
IdentifierType m_ReinitializationFrequency
IdentifierType m_Step
bool m_Touched
std::vector< bool > m_TouchedForThread

Private Member Functions

virtual void AllocateUpdateBuffer ()
virtual void ApplyUpdate (const TimeStepType &)
virtual TimeStepType CalculateChange ()
 NarrowBandImageFilterBase (const Self &)
void operator= (const Self &)
virtual void ThreadedApplyUpdate (const TimeStepType &dt, const ThreadRegionType &regionToProcess, ThreadIdType threadId)
virtual TimeStepType ThreadedCalculateChange (const ThreadRegionType &regionToProcess, ThreadIdType threadId)
virtual void ThreadedIterate (void *arg, ThreadIdType threadId)

Static Private Member Functions

static ITK_THREAD_RETURN_TYPE IterateThreaderCallback (void *arg)

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >

This class implements a multi-threaded finite difference image to image solver that can be applied to an arbitrary list of pixels.

This class is intended as a common base class for classical narrowband solvers and manifold solvers. This base class implements a common memory management and multi-threaded architecture for applying a finite difference function to a list of pixels in an image. The specifics of narrowband solvers such as re-initialization and the use of land-mines are not implemented.
INPUTS
This filter takes an itk::Image as input. The appropriate type of input image is entirely determined by the application. As a rule, however, the input type is immediately converted to the output type before processing. This is because the input is not assumed to be a real value type and must be converted to signed, real values for the calculations.
OUTPUTS
The output is an itk::Image and is the solution of the pde. The embedding of the interface may vary with the application, but the usual ITK convention is that it is the zero level set in the output image.
IMPORTANT!
Read the documentation for FiniteDifferenceImageFilter before attempting to use this filter. The solver requires that you specify a FiniteDifferenceFunction to use for calculations. This is set using the method SetDifferenceFunction in the parent class.
REFERENCES
Sethian, J.A. Level Set Methods. Cambridge University Press. 1996.

Definition at line 68 of file itkNarrowBandImageFilterBase.h.


Member Typedef Documentation

template<class TInputImage, class TOutputImage>
typedef BandNode< IndexType, PixelType > itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::BandNodeType

This is the storage type for the nodes on the narrow band.

Definition at line 106 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
typedef SmartPointer< const Self > itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::ConstPointer
template<class TInputImage, class TOutputImage>
typedef Superclass::FiniteDifferenceFunctionType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::FiniteDifferenceFunctionType

The value type of the time step. This is distinct from PixelType because PixelType may often be a vector value, while the TimeStep is a scalar value.

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Definition at line 85 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
typedef OutputImageType::IndexType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::IndexType
template<class TInputImage, class TOutputImage>
typedef Superclass::InputImageType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::InputImageType
template<class TInputImage, class TOutputImage>
typedef NarrowBandType::Iterator itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::NarrowBandIterator

Definition at line 112 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
typedef NarrowBandType::Pointer itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::NarrowBandPointer

Definition at line 110 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
typedef NarrowBand< BandNodeType > itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::NarrowBandType

The list type for storing the narrow band.

Definition at line 109 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
typedef Superclass::OutputImageType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::OutputImageType
template<class TInputImage, class TOutputImage>
typedef Superclass::PixelType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::PixelType

The pixel type of the output image will be used in computations. Inherited from the superclass.

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Definition at line 93 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
typedef SmartPointer< Self > itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::Pointer
template<class TInputImage, class TOutputImage>
typedef NarrowBandType::RegionType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::RegionType

Definition at line 111 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
typedef NarrowBandImageFilterBase itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::Self
template<class TInputImage, class TOutputImage>
typedef FiniteDifferenceImageFilter< TInputImage, TOutputImage > itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::Superclass
template<class TInputImage, class TOutputImage>
typedef Superclass::TimeStepType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::TimeStepType
template<class TInputImage, class TOutputImage>
typedef OutputImageType::ValueType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::ValueType

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage>
itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::NarrowBandImageFilterBase ( ) [inline, protected]

Definition at line 212 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
virtual itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::~NarrowBandImageFilterBase ( ) [inline, protected, virtual]

Definition at line 224 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::NarrowBandImageFilterBase ( const Self ) [private]

Member Function Documentation

template<class TInputImage, class TOutputImage>
virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::AllocateUpdateBuffer ( ) [inline, private, virtual]

This method allocates a temporary update container in the subclass.

Implements itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Definition at line 306 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::ApplyUpdate ( const TimeStepType dt) [inline, private, virtual]

This method is defined by a subclass to apply changes to the output from an update buffer and a time step value "dt".

Parameters:
dtTime step value.

Implements itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Definition at line 323 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
virtual TimeStepType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::CalculateChange ( ) [inline, private, virtual]

This method is defined by a subclass to populate an update buffer with changes for the pixels in the output. It returns a time step value to be used for the update.

Returns:
A time step to use in updating the output with the changes calculated from this method.

Implements itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Definition at line 331 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::ClearNarrowBand ( ) [protected]
template<class TInputImage, class TOutputImage>
virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::CopyInputToOutput ( ) [virtual]

This method can be defined in subclasses as needed to copy the input to the output. See DenseFiniteDifferenceImageFilter for an implementation.

Implements itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage>
virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::CreateNarrowBand ( ) [inline, virtual]

This is the virtual method called by Initialize to set the band of operation. It is left to the subclasses to define this functionality. This function can make use of above InsertNarrowBandNode function to create a band.

Reimplemented in itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >, and itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

Definition at line 198 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::GenerateData ( ) [protected, virtual]
template<class TInputImage, class TOutputImage>
virtual ValueType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::GetIsoSurfaceValue ( ) const [virtual]

Set/Get IsoSurfaceValue to use in the input image

template<class TInputImage, class TOutputImage>
virtual const char* itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::GetNameOfClass ( ) const [virtual]
template<class TInputImage, class TOutputImage>
float itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::GetNarrowBandInnerRadius ( ) const [inline]

Get the narrow band inner radius.

Definition at line 188 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
float itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::GetNarrowBandTotalRadius ( ) const [inline]

Get the narrow band total radius.

Definition at line 170 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::GetSplitRegion ( const vcl_size_t &  i,
ThreadRegionType splitRegion 
) [protected]

This function returns a single region (of the narrow band list) for use in multi-threading

template<class TInputImage, class TOutputImage>
virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::Initialize ( ) [protected, virtual]

This function clears the existing narrow band, calls CreateNarrowBand to create a band, and calls the SplitRegions function of NarrowBand to pre-partition the band for multi-threading.

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage>
virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::InitializeIteration ( ) [protected, virtual]

This method check the narrow band state each iteration and reinitialize the narrow band if it is appropiate calling CreateNarrowBand and SplitRegions to pre-partion the band for multi-threading.

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >, and itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >.

template<class TInputImage, class TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::InsertNarrowBandNode ( const BandNodeType node) [inline]

Root Mean Square Change between successive iterations This function is used to insert a pixel index into the narrow band The entire narrow band can be constructed using this method. Usually, however, the narrow band is initialized and reinitialized automatically by the subclass.

Definition at line 126 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::InsertNarrowBandNode ( const IndexType index) [inline]

Definition at line 133 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::InsertNarrowBandNode ( const IndexType index,
const PixelType value,
const signed char &  nodestate 
) [inline]

Definition at line 142 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
static ITK_THREAD_RETURN_TYPE itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::IterateThreaderCallback ( void *  arg) [static, private]

This method gives support for a multithread iterative scheme.

template<class TInputImage, class TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::operator= ( const Self ) [private]
template<class TInputImage, class TOutputImage>
virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::PostProcessOutput ( ) [protected, virtual]

This method allows deallocation of data and further post processing

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]
template<class TInputImage, class TOutputImage>
virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetIsoSurfaceValue ( ValueType  _arg) [virtual]

Set/Get IsoSurfaceValue to use in the input image

template<class TInputImage, class TOutputImage>
virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBand ( NarrowBandType ptr) [inline, virtual]

Definition at line 200 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandInnerRadius ( const float &  val) [inline]

Set the narrow band inner radius. The inner radius is the safe are where the level set can be computed. The default value is 1.

Definition at line 177 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandTotalRadius ( const float &  val) [inline]

Set the narrow band total radius. The narrow band width will be twice this value (positive and negative distance to the zero level set). The default value is 3.

Definition at line 159 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::ThreadedApplyUpdate ( const TimeStepType dt,
const ThreadRegionType regionToProcess,
ThreadIdType  threadId 
) [private, virtual]

This method applies changes from the m_NarrowBand to the output using the ThreadedApplyUpdate() method and a multithreading mechanism. "dt" is the time step to use for the update of each pixel.

template<class TInputImage, class TOutputImage>
virtual TimeStepType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::ThreadedCalculateChange ( const ThreadRegionType regionToProcess,
ThreadIdType  threadId 
) [private, virtual]

This method populates m_NarrowBand with changes for each pixel in the output using the ThreadedCalculateChange() method and a multithreading mechanism. Returns value is a time step to be used for the update.

template<class TInputImage, class TOutputImage>
virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::ThreadedIterate ( void *  arg,
ThreadIdType  threadId 
) [private, virtual]

This method is a thread implementation of the iterative scheme implemented in itkFiniteDifferenceImageFilter::GenerateData. It relies on ThreadedApplyUpdate and ThreadedCalculateChange to update the solution at every iteration.

template<class TInputImage, class TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::WaitForAll ( ) [protected]

Thread synchronization methods.


Member Data Documentation

template<class TInputImage, class TOutputImage>
const unsigned int itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::ImageDimension = Superclass::ImageDimension [static]

Dimensionality of input and output data is assumed to be the same. It is inherited from the superclass.

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Definition at line 89 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
Barrier::Pointer itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_Barrier [protected]
template<class TInputImage, class TOutputImage>
ValueType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_IsoSurfaceValue [protected]
template<class TInputImage, class TOutputImage>
NarrowBandPointer itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_NarrowBand [protected]
template<class TInputImage, class TOutputImage>
std::vector< RegionType > itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_RegionList [protected]

A list of subregions of the narrowband which are passed to each thread for parallel processing.

Definition at line 243 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
IdentifierType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_ReinitializationFrequency [protected]
template<class TInputImage, class TOutputImage>
IdentifierType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_Step [protected]
template<class TInputImage, class TOutputImage>
bool itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_Touched [protected]
template<class TInputImage, class TOutputImage>
std::vector< bool > itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_TouchedForThread [protected]

Definition at line 282 of file itkNarrowBandImageFilterBase.h.


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