#include <itkNarrowBandLevelSetImageFilter.h>

Inheritance diagram for itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >:

Collaboration diagram for itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TFeatureImage	FeatureImageType
typedef Superclass::IndexType	IndexType
typedef Superclass::InputImageType	InputImageType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef SegmentationLevelSetFunction < OutputImageType, FeatureImageType >	SegmentationFunctionType
typedef NarrowBandLevelSetImageFilter	Self
typedef NarrowBandImageFilterBase < TInputImage, TOutputImage >	Superclass
typedef Superclass::TimeStepType	TimeStepType
typedef Superclass::ValueType	ValueType
typedef SegmentationFunctionType::VectorImageType	VectorImageType
Public Types inherited from itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >
typedef BandNode< IndexType, PixelType >	BandNodeType
typedef Superclass::FiniteDifferenceFunctionType	FiniteDifferenceFunctionType
typedef NarrowBandType::Iterator	NarrowBandIterator
typedef NarrowBandType::Pointer	NarrowBandPointer
typedef NarrowBand< BandNodeType >	NarrowBandType
typedef Superclass::PixelType	PixelType
typedef NarrowBandType::RegionType	RegionType
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 const SegmentationFunctionType::VectorImageType *	GetAdvectionImage () const
ValueType	GetAdvectionScaling () const
ValueType	GetCurvatureScaling () const
virtual FeatureImageType *	GetFeatureImage ()
unsigned int	GetMaximumIterations ()
virtual const char *	GetNameOfClass () const
ValueType	GetPropagationScaling () const
virtual SegmentationFunctionType *	GetSegmentationFunction ()
virtual const SegmentationFunctionType::ImageType *	GetSpeedImage () const
bool	GetUseNegativeFeatures () const
virtual void	SetInitialImage (InputImageType *f)
virtual void	SetMaximumRMSError (const double)
virtual void	SetSegmentationFunction (SegmentationFunctionType *s)
void	SetUseNegativeFeaturesOff ()
	typedef (Concept::HasNumericTraits< typename TOutputImage::PixelType >) OutputHasNumericTraitsCheck

virtual void	SetFeatureImage (const FeatureImageType *f)

void	SetUseNegativeFeaturesOn ()

void	SetUseNegativeFeatures (bool u)

virtual void	SetReverseExpansionDirection (bool _arg)
virtual bool	GetReverseExpansionDirection () const
virtual void	ReverseExpansionDirectionOn ()
virtual void	ReverseExpansionDirectionOff ()

void	SetFeatureScaling (ValueType v)

void	SetPropagationScaling (ValueType v)

void	SetAdvectionScaling (ValueType v)

void	SetCurvatureScaling (ValueType v)

void	SetMaximumIterations (unsigned int i)
Public Member Functions inherited from itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >
virtual void	CopyInputToOutput ()
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 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

Protected Types
typedef FastChamferDistanceImageFilter < OutputImageType, OutputImageType >	ChamferFilterType
typedef IsoContourDistanceImageFilter < OutputImageType, OutputImageType >	IsoFilterType

Protected Member Functions
virtual void	CreateNarrowBand ()
void	GenerateData ()
void	operator= (const Self &)
virtual void	PrintSelf (std::ostream &os, Indent indent) const

virtual	~NarrowBandLevelSetImageFilter ()
	NarrowBandLevelSetImageFilter ()
	NarrowBandLevelSetImageFilter (const Self &)

virtual void	InitializeIteration ()
Protected Member Functions inherited from itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >
void	ClearNarrowBand ()
void	GetSplitRegion (const vcl_size_t &i, ThreadRegionType &splitRegion)
virtual void	Initialize ()
	NarrowBandImageFilterBase ()
virtual void	PostProcessOutput ()
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
ChamferFilterType::Pointer	m_ChamferFilter
IsoFilterType::Pointer	m_IsoFilter
bool	m_ReverseExpansionDirection
Protected Attributes inherited from itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >
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 Attributes
SegmentationFunctionType *	m_SegmentationFunction

Additional Inherited Members
Static Public Attributes inherited from itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >
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 >

Detailed Description

template<class TInputImage, class TFeatureImage, class TOutputPixelType = float, class TOutputImage = Image< TOutputPixelType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
class itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >

A base class which defines the API for implementing a special class of image segmentation filters using level set methods.

OVERVIEW: This object defines the framework for a class of segmentation filters which use level set methods. These filters work by constructing a ``feature image'' onto which the evolving level set locks as it moves. In the feature image, values that are close to zero are associated with object boundaries. An original (or preprocessed) image is given to the filter as the feature image and a seed for the level set is given as the input of the filter. The seed is converted into a level set embedding which propagates according to the features calculated from the original image.

TEMPLATE PARAMETERS: There are two required and two optional template parameter for these filters. Of the optional parameters, the last, TOutputImage, should not be changed from its default. It is only there to instantiate the parent class correctly.

TInputImage is the image type of the initial model you will input to the filter using SetInput() or SetInitialImage().

TFeatureImage is the image type of the image from which the filter will calculate the speed term for segmentation (see INPUTS).

TOutputPixelType is the data type used for the output image phi, the implicit level set image. This should really only ever be set as float (default) or double.

INPUTS: The input to any subclass of this filter is the seed image for the initial level set embedding. As with other subclasses of the SparseLevelSetImageFilter, the type of the input image is is not important. The (RequestedRegion) size of the seed image must, however, match the (RequestedRegion) size of the feature image.

You must identify the initial front (surface) in the input image. You do this by specifying its isovalue through the method SetIsoSurfaceValue(float f). The algorithm will then initialize its solution using the front represented by value f. Note that the front is always represented by isosurface zero in the output and not the isosurface you specified for the input. This is because, for simplicity, the filter will shift your input image so that the active front has zero values.

: Depending on the particular application and filter that you are using, the feature image should be preprocessed with some type of noise reduction filtering. The feature image input can be of any type, but it will be cast to floating point before calculations are done.

OUTPUTS: The output of any subclass of this filter is a level set embedding as described in SparseFieldLevelSetImageFilter. The zero crossings of the output image give the pixels closest to the level set boundary. By ITK convention, NEGATIVE values are pixels INSIDE the segmented region and POSITIVE values are pixels OUTSIDE the segmented region.

PARAMETERS: The MaximumRMSChange parameter is used to determine when the solution has converged. A lower value will result in a tighter-fitting solution, but will require more computations. Too low a value could put the solver into an infinite loop unless a reasonable NumberOfIterations parameter is set. Values should always be greater than 0.0 and less than 1.0.

: The NumberOfIterations parameter can be used to halt the solution after a specified number of iterations, overriding the MaximumRMSChange halting criteria.

: The standard convention for ITK level-set segmentation filters is that POSITIVE propagation (speed) and advection terms cause the surface to EXPAND while negative terms cause the surface to CONTRACT. When the ReverseExpansionDirection parameter is set to TRUE (on), it tells the function object to reverse the standard ITK convention so that NEGATIVE terms cause EXPANSION and positive terms cause CONTRACTION.

This parameter can be safely changed as appropriate for a particular application or data set to achieve the desired behavior.

: The FeatureScaling parameter controls the magnitude of the features calculated for use in the level set propagation and advection speeds. This value simply sets both parameters to equal values at once. Some filters may only use on of these two terms and this method is a generic way to set either or both without having to know which is in use.

: The CurvatureScaling parameter controls the magnitude of the curvature values which are calculated on the evolving isophote. This is important in controlling the relative effect of curvature in the calculation. Default value is 1.0. Higher values relative to the other level set equation terms (propagation and advection) will give a smoother result.

: The PropagationScaling parameter controls the scaling of the scalar propagation (speed) term relative to other terms in the level set equation. Setting this value will override any value already set by FeatureScaling.

: The AdvectionScaling parameter controls the scaling of the vector advection field term relative to other terms in the level set equation. Setting this value will override any value already set by FeatureScaling.

: See LevelSetFunction for more information.

Definition at line 147 of file itkNarrowBandLevelSetImageFilter.h.