ITK  4.2.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
Module ITKNarrowBand

#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 Self > ConstPointer
typedef
Superclass::FiniteDifferenceFunctionType 		FiniteDifferenceFunctionType
typedef OutputImageType::IndexType IndexType
typedef Superclass::InputImageType InputImageType
typedef NarrowBandType::Iterator NarrowBandIterator
typedef NarrowBandType::Pointer NarrowBandPointer
typedef NarrowBand< BandNodeType > NarrowBandType
typedef Superclass::OutputImageType OutputImageType
typedef Superclass::PixelType PixelType
typedef SmartPointer< Self > Pointer
typedef NarrowBandType::RegionType RegionType
typedef NarrowBandImageFilterBase Self
typedef
FiniteDifferenceImageFilter
< TInputImage, TOutputImage > 		Superclass
typedef Superclass::TimeStepType TimeStepType
typedef OutputImageType::ValueType ValueType
- Public Types inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
typedef TInputImage::PixelType InputPixelType
typedef NumericTraits
< InputPixelType >::ValueType 		InputPixelValueType
typedef
FiniteDifferenceFunctionType::NeighborhoodScalesType 		NeighborhoodScalesType
typedef TOutputImage::PixelType OutputPixelType
typedef NumericTraits
< OutputPixelType >::ValueType 		OutputPixelValueType
typedef
FiniteDifferenceFunctionType::RadiusType 		RadiusType
- Public Types inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
typedef
InputImageType::ConstPointer 		InputImageConstPointer
typedef InputImageType::PixelType InputImagePixelType
typedef InputImageType::Pointer InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef
Superclass::OutputImagePixelType 		OutputImagePixelType
typedef
Superclass::OutputImagePointer 		OutputImagePointer
typedef
Superclass::OutputImageRegionType 		OutputImageRegionType
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef
Superclass::DataObjectIdentifierType 		DataObjectIdentifierType
typedef DataObject::Pointer DataObjectPointer
typedef
Superclass::DataObjectPointerArraySizeType 		DataObjectPointerArraySizeType
- Public Types inherited from itk::ProcessObject
typedef std::vector
< DataObjectPointer > 		DataObjectPointerArray
typedef std::vector
< DataObjectIdentifierType > 		NameArray
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

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)
- Public Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
virtual const
FiniteDifferenceFunctionType::Pointer & 		GetDifferenceFunction () const
virtual const IdentifierType & GetElapsedIterations ()
virtual bool GetIsInitialized ()
virtual void SetDifferenceFunction (FiniteDifferenceFunctionType *_arg)
virtual void SetIsInitialized (bool _arg)
void SetStateToInitialized ()
void SetStateToUninitialized ()
virtual void SetNumberOfIterations (IdentifierType _arg)
virtual const IdentifierType & GetNumberOfIterations ()
virtual void SetUseImageSpacing (bool _arg)
virtual void UseImageSpacingOn ()
virtual void UseImageSpacingOff ()
virtual const bool & GetUseImageSpacing ()
virtual void SetMaximumRMSError (double _arg)
virtual const double & GetMaximumRMSError ()
virtual void SetRMSChange (double _arg)
virtual const double & GetRMSChange ()
virtual void SetManualReinitialization (bool _arg)
virtual const bool & GetManualReinitialization ()
virtual void ManualReinitializationOn ()
virtual void ManualReinitializationOff ()
- Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool CanRunInPlace () const
virtual void SetInPlace (bool _arg)
virtual bool GetInPlace () const
virtual void InPlaceOn ()
virtual void InPlaceOff ()
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType * GetInput (void) const
const InputImageType * GetInput (unsigned int idx) const
virtual void PopBackInput ()
virtual void PopFrontInput ()
virtual void PushBackInput (const InputImageType *image)
virtual void PushFrontInput (const InputImageType *image)
virtual void SetInput (const InputImageType *image)
virtual void SetInput (unsigned int, const TInputImage *image)
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType * GetOutput (unsigned int idx)
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
virtual void GraftOutput (DataObject *output)
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageType * GetOutput (void)
const OutputImageType * GetOutput (void) const
virtual
ProcessObject::DataObjectPointer 		MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
virtual void AbortGenerateDataOn ()
virtual void EnlargeOutputRequestedRegion (DataObject *)
virtual const bool & GetAbortGenerateData ()
NameArray GetInputNames () const
MultiThreader * GetMultiThreader () const
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType GetNumberOfInputs () const
DataObjectPointerArraySizeType GetNumberOfOutputs () const
virtual
DataObjectPointerArraySizeType 		GetNumberOfValidRequiredInputs () const
NameArray GetOutputNames () const
virtual const float & GetProgress ()
NameArray GetRequiredInputNames () const
bool HasInput (const DataObjectIdentifierType &key) const
bool HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
virtual void PrepareOutputs ()
virtual void PropagateRequestedRegion (DataObject *output)
virtual void ResetPipeline ()
virtual void SetAbortGenerateData (bool _arg)
virtual void SetProgress (float _arg)
virtual void Update ()
virtual void UpdateLargestPossibleRegion ()
virtual void UpdateOutputData (DataObject *output)
virtual void UpdateOutputInformation ()
void UpdateProgress (float amount)
DataObjectPointerArray GetInputs ()
DataObjectPointerArray GetOutputs ()
DataObjectPointerArray GetIndexedInputs ()
DataObjectPointerArray GetIndexedOutputs ()
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
virtual void SetReleaseDataFlag (bool flag)
virtual bool GetReleaseDataFlag () const
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool & GetReleaseDataBeforeUpdateFlag ()
virtual void ReleaseDataBeforeUpdateFlagOn ()
virtual void ReleaseDataBeforeUpdateFlagOff ()
virtual void SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType & GetNumberOfThreads ()
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
unsigned long AddObserver (const EventObject &event, Command *) const
virtual LightObject::Pointer CreateAnother () const
virtual void DebugOff () const
virtual void DebugOn () const
Command * GetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionary & GetMetaDataDictionary (void)
const MetaDataDictionary & GetMetaDataDictionary (void) const
virtual unsigned long 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
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () const
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
virtual int GetReferenceCount () const
 itkCloneMacro (Self)
void Print (std::ostream &os, Indent indent=0) const

Static Public Attributes

static const unsigned int ImageDimension = Superclass::ImageDimension
- Static Public Attributes inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
- Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
static const unsigned int InputImageDimension = TInputImage::ImageDimension
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >

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 Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
 FiniteDifferenceImageFilter ()
virtual void GenerateInputRequestedRegion ()
virtual bool Halt ()
virtual TimeStepType ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const std::vector< bool > &valid) const
virtual void SetElapsedIterations (IdentifierType _arg)
virtual bool ThreadedHalt (void *)
virtual ~FiniteDifferenceImageFilter ()
- Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual void AllocateOutputs ()
virtual bool GetRunningInPlace () const
 InPlaceImageFilter ()
virtual void ReleaseInputs ()
 ~InPlaceImageFilter ()
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 ImageToImageFilter ()
virtual void VerifyInputInformation ()
 ~ImageToImageFilter ()
void PushBackInput (const DataObject *input)
void PushFrontInput (const DataObject *input)
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
virtual void BeforeThreadedGenerateData ()
 ImageSource ()
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual ~ImageSource ()
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
virtual void AddOutput (DataObject *output)
bool AddRequiredInputName (const DataObjectIdentifierType &)
virtual void CacheInputReleaseDataFlags ()
virtual void GenerateOutputInformation ()
virtual void GenerateOutputRequestedRegion (DataObject *output)
virtual const
DataObjectPointerArraySizeType & 		GetNumberOfRequiredInputs ()
virtual const
DataObjectPointerArraySizeType & 		GetNumberOfRequiredOutputs ()
bool IsIndexedName (const DataObjectIdentifierType &) const
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType MakeNameFromIndex (DataObjectPointerArraySizeType) const
 ProcessObject ()
virtual void PropagateResetPipeline ()
virtual void RemoveInput (const DataObjectIdentifierType &key)
virtual void RemoveInput (DataObjectPointerArraySizeType)
virtual void RemoveOutput (const DataObjectIdentifierType &key)
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void RestoreInputReleaseDataFlags ()
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void SetPrimaryInput (DataObject *input)
virtual void SetPrimaryOutput (DataObject *output)
void SetRequiredInputNames (const NameArray &)
virtual void VerifyPreconditions ()
 ~ProcessObject ()
DataObject * GetInput (const DataObjectIdentifierType &key)
const DataObject * GetInput (const DataObjectIdentifierType &key) const
DataObject * GetInput (DataObjectPointerArraySizeType)
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
DataObject * GetPrimaryInput ()
const DataObject * GetPrimaryInput () const
DataObject * GetOutput (const DataObjectIdentifierType &key)
const DataObject * GetOutput (const DataObjectIdentifierType &key) const
DataObject * GetOutput (DataObjectPointerArraySizeType idx)
const DataObject * GetOutput (DataObjectPointerArraySizeType idx) const
DataObject * GetPrimaryOutput ()
const DataObject * GetPrimaryOutput () const
- Protected Member Functions inherited from itk::Object
 Object ()
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void SetTimeStamp (const TimeStamp &time)
virtual ~Object ()
- 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

Barrier::Pointer m_Barrier
ValueType m_IsoSurfaceValue
NarrowBandPointer m_NarrowBand
std::vector< RegionType > m_RegionList
IdentifierType m_ReinitializationFrequency
IdentifierType m_Step
bool m_Touched
std::vector< bool > m_TouchedForThread
- Protected Attributes inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
IdentifierType m_ElapsedIterations
bool m_IsInitialized
bool m_ManualReinitialization
double m_MaximumRMSError
IdentifierType m_NumberOfIterations
double m_RMSChange

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

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

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

Definition at line 77 of file itkNarrowBandImageFilterBase.h.

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

The index type for the output image.

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

Definition at line 99 of file itkNarrowBandImageFilterBase.h.

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

Typedefs from the superclass

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 > >.

Definition at line 80 of file itkNarrowBandImageFilterBase.h.

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

Superclass typedefs.

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

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

Definition at line 84 of file itkNarrowBandImageFilterBase.h.

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

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

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

Definition at line 76 of file itkNarrowBandImageFilterBase.h.

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

Standard class typedefs

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

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

Definition at line 74 of file itkNarrowBandImageFilterBase.h.

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

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

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

Definition at line 75 of file itkNarrowBandImageFilterBase.h.

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

The value type of a time step. Inherited from the superclass.

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 > >.

Definition at line 96 of file itkNarrowBandImageFilterBase.h.

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

The data type used in numerical computations. Derived from the output image type.

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

Definition at line 103 of file itkNarrowBandImageFilterBase.h.

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage>
itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::NarrowBandImageFilterBase ( )
inlineprotected

Definition at line 212 of file itkNarrowBandImageFilterBase.h.

template<class TInputImage, class TOutputImage>
virtual itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::~NarrowBandImageFilterBase ( )
inlineprotectedvirtual

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

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

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

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

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

This is the default, high-level algorithm for calculating finite difference solutions. It calls virtual methods in its subclasses to implement the major steps of the algorithm.

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

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

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

Run-time type information (and related methods)

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

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

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

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

This method check the narrow band state each iteration and reinitialize the narrow band if it is appropriate 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)
staticprivate

This method gives support for a multithread iterative scheme.

template<class TInputImage, class TOutputImage>
void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::operator= ( const Self &  )
private

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

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

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

template<class TInputImage, class TOutputImage>
virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::PostProcessOutput ( )
protectedvirtual

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
protectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

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

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

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

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

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

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

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

Definition at line 286 of file itkNarrowBandImageFilterBase.h.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::NarrowBandImageFilterBase().

template<class TInputImage, class TOutputImage>
ValueType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_IsoSurfaceValue
protected

Definition at line 284 of file itkNarrowBandImageFilterBase.h.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::NarrowBandImageFilterBase().

template<class TInputImage, class TOutputImage>
NarrowBandPointer itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_NarrowBand
protected

Definition at line 227 of file itkNarrowBandImageFilterBase.h.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::GetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::GetNarrowBandTotalRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::NarrowBandImageFilterBase(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), and itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius().

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

Definition at line 277 of file itkNarrowBandImageFilterBase.h.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::NarrowBandImageFilterBase().

template<class TInputImage, class TOutputImage>
IdentifierType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_Step
protected

Definition at line 278 of file itkNarrowBandImageFilterBase.h.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::NarrowBandImageFilterBase().

template<class TInputImage, class TOutputImage>
bool itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_Touched
protected

Definition at line 280 of file itkNarrowBandImageFilterBase.h.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::NarrowBandImageFilterBase().

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:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Wed Jul 11 2012 00:18:00 for ITK by doxygen 1.8.1