#include <itkNarrowBandImageFilterBase.h>

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

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

Detailed Description

template<typename TInputImage, typename 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.

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 SmartPointer< const Self >	ConstPointer

typedef FiniteDifferenceFunction < TOutputImage >	FiniteDifferenceFunctionType

typedef TInputImage	InputImageType

typedef TInputImage::PixelType	InputPixelType

typedef NumericTraits < InputPixelType >::ValueType	InputPixelValueType

typedef FiniteDifferenceFunctionType::NeighborhoodScalesType	NeighborhoodScalesType

typedef TOutputImage	OutputImageType

typedef TOutputImage::PixelType	OutputPixelType

typedef NumericTraits < OutputPixelType >::ValueType	OutputPixelValueType

typedef OutputPixelType	PixelType

typedef SmartPointer< Self >	Pointer

typedef FiniteDifferenceFunctionType::RadiusType	RadiusType

typedef FiniteDifferenceImageFilter	Self

typedef InPlaceImageFilter < TInputImage, TOutputImage >	Superclass

typedef FiniteDifferenceFunctionType::TimeStepType	TimeStepType

Public Types inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const Self >	ConstPointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TInputImage	InputImageType

typedef Superclass::OutputImagePixelType	OutputImagePixelType

typedef Superclass::OutputImagePointer	OutputImagePointer

typedef Superclass::OutputImageRegionType	OutputImageRegionType

typedef Superclass::OutputImageType	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef InPlaceImageFilter	Self

typedef ImageToImageFilter < TInputImage, TOutputImage >	Superclass

Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const Self >	ConstPointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TInputImage	InputImageType

typedef Superclass::OutputImagePixelType	OutputImagePixelType

typedef Superclass::OutputImageRegionType	OutputImageRegionType

typedef SmartPointer< Self >	Pointer

typedef ImageToImageFilter	Self

typedef ImageSource< TOutputImage >	Superclass

Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

typedef OutputImageType::PixelType	OutputImagePixelType

typedef OutputImageType::Pointer	OutputImagePointer

typedef OutputImageType::RegionType	OutputImageRegionType

typedef TOutputImage	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef ImageSource	Self

typedef ProcessObject	Superclass

Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer

typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef std::vector < DataObjectPointer >	DataObjectPointerArray

typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType

typedef MultiThreader	MultiThreaderType

typedef std::vector < DataObjectIdentifierType >	NameArray

typedef SmartPointer< Self >	Pointer

typedef ProcessObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual void	CopyInputToOutput () override

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

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

virtual void	SetUseImageSpacing (bool _arg)

virtual void	UseImageSpacingOn ()

virtual void	UseImageSpacingOff ()

virtual const bool &	GetUseImageSpacing () const

virtual void	SetMaximumRMSError (double _arg)

virtual const double &	GetMaximumRMSError () const

virtual void	SetRMSChange (double _arg)

virtual const double &	GetRMSChange () const

virtual void	SetManualReinitialization (bool _arg)

virtual const bool &	GetManualReinitialization () const

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

const InputImageType *	GetInput (unsigned int idx) const

virtual void	PopBackInput () override

virtual void	PopFrontInput () override

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)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)

virtual void	GraftNthOutput (unsigned int idx, DataObject *output)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *output)

virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

virtual ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual const float &	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

void	SetProgress (float progress)

virtual void	SetReleaseDataFlag (bool flag)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfThreads (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfThreads () const

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

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () 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 const unsigned int	ImageDimension = OutputImageType::ImageDimension

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 const unsigned int	InputImageDimension = TInputImage::ImageDimension

static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions
void	ClearNarrowBand ()

virtual void	GenerateData () override

void	GetSplitRegion (const vcl_size_t &i, ThreadRegionType &splitRegion)

virtual void	Initialize () override

virtual void	InitializeIteration () override

	NarrowBandImageFilterBase ()

virtual void	PostProcessOutput () override

void	PrintSelf (std::ostream &os, Indent indent) const override

void	WaitForAll ()

virtual	~NarrowBandImageFilterBase () override

Protected Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
	FiniteDifferenceImageFilter ()

virtual void	GenerateInputRequestedRegion () override

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

Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual void	AllocateOutputs () override

virtual bool	GetRunningInPlace () const

	InPlaceImageFilter ()

virtual void	ReleaseInputs () override

	~InPlaceImageFilter () override

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

	~ImageToImageFilter () override

void	PushBackInput (const DataObject *input) override

void	PushFrontInput (const DataObject *input) override

Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()

virtual void	BeforeThreadedGenerateData ()

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)

virtual	~ImageSource () override

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))

	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))

	itkLegacyMacro (virtual void RemoveInput(DataObject *input))

	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) 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 () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName (void) const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName (void) 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 () 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
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

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime

bool	m_Updating

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Private Member Functions
virtual void	AllocateUpdateBuffer () override

virtual void	ApplyUpdate (const TimeStepType &) override

virtual TimeStepType	CalculateChange () override

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)

Additional Inherited Members
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType

typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType

Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

Member Typedef Documentation

template<typename TInputImage, typename 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<typename TInputImage, typename TOutputImage>

typedef SmartPointer< const Self > itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::ConstPointer

Definition at line 77 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename TOutputImage>

typedef Superclass::FiniteDifferenceFunctionType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::FiniteDifferenceFunctionType

Definition at line 85 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename TOutputImage>

typedef OutputImageType::IndexType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::IndexType

The index type for the output image.

Definition at line 99 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename TOutputImage>

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

Typedefs from the superclass

Definition at line 80 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename TOutputImage>

typedef NarrowBandType::Iterator itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::NarrowBandIterator

Definition at line 112 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename TOutputImage>

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

Definition at line 110 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename 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<typename TInputImage, typename TOutputImage>

typedef Superclass::OutputImageType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::OutputImageType

Definition at line 84 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename 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.

Definition at line 93 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename TOutputImage>

typedef SmartPointer< Self > itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::Pointer

Definition at line 76 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename TOutputImage>

typedef NarrowBandType::RegionType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::RegionType

Definition at line 111 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename TOutputImage>

typedef NarrowBandImageFilterBase itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::Self

Standard class typedefs

Definition at line 74 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename TOutputImage>

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

Definition at line 75 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename TOutputImage>

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

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

Definition at line 96 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename TOutputImage>

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

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

Definition at line 103 of file itkNarrowBandImageFilterBase.h.

Constructor & Destructor Documentation

template<typename TInputImage, typename TOutputImage>

itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::NarrowBandImageFilterBase ( )

inlineprotected

Definition at line 212 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename TOutputImage>

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

inlineoverrideprotectedvirtual

Definition at line 224 of file itkNarrowBandImageFilterBase.h.

Member Function Documentation

template<typename TInputImage, typename TOutputImage>

virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::AllocateUpdateBuffer ( )

inlineoverrideprivatevirtual

This method allocates a temporary update container in the subclass.

Implements itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Definition at line 305 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename TOutputImage>

virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::ApplyUpdate ( const TimeStepType & dt )

inlineoverrideprivatevirtual

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

Parameters

dt	Time step value.

Implements itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Definition at line 322 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename TOutputImage>

virtual TimeStepType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::CalculateChange ( )

inlineoverrideprivatevirtual

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 330 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename TOutputImage>

void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::ClearNarrowBand ( )

protected

template<typename TInputImage, typename TOutputImage>

virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::CopyInputToOutput ( )

overridevirtual

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<typename TInputImage, typename 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, TInputImage::ImageDimension > >.

Definition at line 198 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename TOutputImage>

virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::GenerateData ( )

overrideprotectedvirtual

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, TInputImage::ImageDimension > >, and itk::NarrowBandCurvesLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >.

template<typename TInputImage, typename TOutputImage>

virtual ValueType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::GetIsoSurfaceValue ( ) const

virtual

Set/Get IsoSurfaceValue to use in the input image

template<typename TInputImage, typename 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, TInputImage::ImageDimension > >, itk::NarrowBandCurvesLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, and itk::NarrowBandThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >.

template<typename TInputImage, typename TOutputImage>

float itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::GetNarrowBandInnerRadius ( ) const

inline

Get the narrow band inner radius.

Definition at line 188 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename TOutputImage>

float itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::GetNarrowBandTotalRadius ( ) const

inline

Get the narrow band total radius.

Definition at line 170 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename 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<typename TInputImage, typename TOutputImage>

virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::Initialize ( )

overrideprotectedvirtual

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<typename TInputImage, typename TOutputImage>

virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::InitializeIteration ( )

overrideprotectedvirtual

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, TInputImage::ImageDimension > >.

template<typename TInputImage, typename 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<typename TInputImage, typename TOutputImage>

void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::InsertNarrowBandNode ( const IndexType & index )

inline

Definition at line 133 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename 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<typename TInputImage, typename TOutputImage>

static ITK_THREAD_RETURN_TYPE itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::IterateThreaderCallback ( void * arg )

staticprivate

This method gives support for a multithread iterative scheme.

template<typename TInputImage, typename TOutputImage>

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

overrideprotectedvirtual

This method allows deallocation of data and further post processing

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

template<typename TInputImage, typename TOutputImage>

void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

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 >, and itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType, TInputImage::ImageDimension > >.

template<typename TInputImage, typename TOutputImage>

virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetIsoSurfaceValue ( ValueType _arg )

virtual

Set/Get IsoSurfaceValue to use in the input image

template<typename TInputImage, typename TOutputImage>

virtual void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBand ( NarrowBandType * ptr )

inlinevirtual

Definition at line 200 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename 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<typename TInputImage, typename 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<typename TInputImage, typename 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<typename TInputImage, typename 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<typename TInputImage, typename 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<typename TInputImage, typename TOutputImage>

void itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::WaitForAll ( )

protected

Thread synchronization methods.

Member Data Documentation

template<typename TInputImage, typename 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.

Definition at line 89 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename TOutputImage>

Barrier::Pointer itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_Barrier

protected

Definition at line 286 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename TOutputImage>

ValueType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_IsoSurfaceValue

protected

Definition at line 284 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename TOutputImage>

NarrowBandPointer itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_NarrowBand

protected

Definition at line 227 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename 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<typename TInputImage, typename TOutputImage>

IdentifierType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_ReinitializationFrequency

protected

Definition at line 277 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename TOutputImage>

IdentifierType itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_Step

protected

Definition at line 278 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename TOutputImage>

bool itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::m_Touched

protected

Definition at line 280 of file itkNarrowBandImageFilterBase.h.

template<typename TInputImage, typename 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:

itkNarrowBandImageFilterBase.h

Detailed Description

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

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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