itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType > Class Template Reference

#include <itkFiniteDifferenceSparseImageFilter.h>

Inheritance diagram for itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >:

Collaboration diagram for itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >:

List of all members.

Classes
struct	FDThreadStruct
struct	ThreadRegionType

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::FiniteDifferenceFunctionType	FiniteDifferenceFunctionType
typedef SparseOutputImageType::IndexType	IndexType
typedef Superclass::InputImageType	InputImageType
typedef OutputNodeType::NodeDataType	NodeDataType
typedef SparseOutputImageType::NodeListType	NodeListType
typedef OutputNodeType::NodeValueType	NodeValueType
typedef SparseOutputImageType::NodeType	OutputNodeType
typedef Superclass::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef FiniteDifferenceSparseImageFilter	Self
typedef SparseOutputImageType::SizeType	SizeType
typedef FiniteDifferenceSparseImageFunction < SparseOutputImageType >	SparseFunctionType
typedef Superclass::OutputImageType	SparseOutputImageType
typedef FiniteDifferenceImageFilter < TInputImageType, TSparseOutputImageType >	Superclass
typedef Superclass::TimeStepType	TimeStepType
Public Types inherited from itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >
typedef TInputImageType::PixelType	InputPixelType
typedef NumericTraits < InputPixelType >::ValueType	InputPixelValueType
typedef FiniteDifferenceFunctionType::NeighborhoodScalesType	NeighborhoodScalesType
typedef TSparseOutputImageType	OutputImageType
typedef TSparseOutputImageType::PixelType	OutputPixelType
typedef NumericTraits < OutputPixelType >::ValueType	OutputPixelValueType
typedef FiniteDifferenceFunctionType::RadiusType	RadiusType
Public Types inherited from itk::InPlaceImageFilter< TInputImageType, TSparseOutputImageType >
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< TInputImageType, TSparseOutputImageType >
Public Types inherited from itk::ImageSource< TSparseOutputImageType >
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 char *	GetNameOfClass () const
virtual bool	GetPrecomputeFlag () const
virtual void	SetPrecomputeFlag (bool _arg)
void	SetSparseFunction (SparseFunctionType *sf)
Public Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >
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< TInputImageType, TSparseOutputImageType >
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< TInputImageType, TSparseOutputImageType >
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 TInputImageType *image)
Public Member Functions inherited from itk::ImageSource< TSparseOutputImageType >
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< TInputImageType, TSparseOutputImageType >
Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImageType, TSparseOutputImageType >
static const unsigned int	InputImageDimension
static const unsigned int	OutputImageDimension
Static Public Attributes inherited from itk::ImageToImageFilter< TInputImageType, TSparseOutputImageType >
Static Public Attributes inherited from itk::ImageSource< TSparseOutputImageType >

Protected Member Functions
virtual void	AllocateUpdateBuffer ()
virtual void	ApplyUpdate (const TimeStepType &dt)
virtual TimeStepType	CalculateChange ()
virtual NodeDataType	DataConstraint (const NodeDataType &data) const
	FiniteDifferenceSparseImageFilter ()
ThreadIdType	GetSplitRegion (ThreadIdType i, ThreadIdType num, ThreadRegionType &splitRegion)
virtual void	Initialize ()
virtual void	PrecalculateChange ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	ThreadedApplyUpdate (const TimeStepType &dt, const ThreadRegionType &regionToProcess, ThreadIdType threadId)
virtual TimeStepType	ThreadedCalculateChange (const ThreadRegionType &regionToProcess, ThreadIdType threadId)
virtual void	ThreadedPrecalculateChange (const ThreadRegionType &regionToProcess, ThreadIdType threadId)
	~FiniteDifferenceSparseImageFilter ()
Protected Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >
virtual void	ApplyUpdate (const TimeStepType &dt)=0
virtual void	CopyInputToOutput ()=0
	FiniteDifferenceImageFilter ()
virtual void	GenerateData ()
virtual void	GenerateInputRequestedRegion ()
virtual bool	Halt ()
virtual void	InitializeIteration ()
virtual void	PostProcessOutput ()
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< TInputImageType, TSparseOutputImageType >
virtual void	AllocateOutputs ()
virtual bool	GetRunningInPlace () const
	InPlaceImageFilter ()
virtual void	ReleaseInputs ()
	~InPlaceImageFilter ()
Protected Member Functions inherited from itk::ImageToImageFilter< TInputImageType, TSparseOutputImageType >
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< TSparseOutputImageType >
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 ()

Static Protected Member Functions
static ITK_THREAD_RETURN_TYPE	ApplyUpdateThreaderCallback (void *arg)
static ITK_THREAD_RETURN_TYPE	CalculateChangeThreaderCallback (void *arg)
static ITK_THREAD_RETURN_TYPE	PrecalculateChangeThreaderCallback (void *arg)

Private Member Functions
	FiniteDifferenceSparseImageFilter (const Self &)
void	operator= (const Self &)

Private Attributes
bool	m_PrecomputeFlag
NodeListType::RegionListType	m_RegionList
SparseFunctionType *	m_SparseFunction

Additional Inherited Members
Protected Attributes inherited from itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >
IdentifierType	m_ElapsedIterations
bool	m_IsInitialized
bool	m_ManualReinitialization
double	m_MaximumRMSError
IdentifierType	m_NumberOfIterations
double	m_RMSChange

---

Detailed Description

template<class TInputImageType, class TSparseOutputImageType>
class itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >

This class implements a multi-threaded base class for Image to SparseImage finite difference processes.

This class implements a multi-threading mechanism for implementing finite difference PDE's on sparse image types. The sparse image is a image of pointers to node variables at valid pixel locations and null pointers at others. The node variable type must have the following members: m_Index, m_Data and m_Update.

This class also adds precomputing support to the finite difference image filter scheme. This support can be used by certain filters to speed up the processing. The m_PrecomputeFlag should be set to true to use this and the Function object must provide a PrecomputeSparseUpdate method.

INPUTS

The input to this filter is either a regular or sparse image. Subclasses should provide a way of copying this information to the output sparse image or initializing the output image nodes from the input image.

OUTPUTS

The output is a sparse image. The output will be in the m_Data members of the nodes of the sparse image.

IMPORTANT

The output sparse image type must be templated with a node type that at least has the following member variables: m_Index, m_Data and m_Update.

Definition at line 63 of file itkFiniteDifferenceSparseImageFilter.h.

---

Member Typedef Documentation

template<class TInputImageType, class TSparseOutputImageType>

typedef SmartPointer< const Self > itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::ConstPointer

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >.

Reimplemented in itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >.

Definition at line 74 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

typedef Superclass::FiniteDifferenceFunctionType itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::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< TInputImageType, TSparseOutputImageType >.

Reimplemented in itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >.

Definition at line 84 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

typedef SparseOutputImageType::IndexType itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::IndexType

Typedefs from the sparse output image type.

Reimplemented in itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >.

Definition at line 92 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

typedef Superclass::InputImageType itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::InputImageType

Typedefs from the superclass

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >.

Reimplemented in itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >.

Definition at line 77 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

typedef OutputNodeType::NodeDataType itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::NodeDataType

The type for the data variable of OutputNodeType.

Definition at line 98 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

typedef SparseOutputImageType::NodeListType itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::NodeListType

Reimplemented in itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >.

Definition at line 95 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

typedef OutputNodeType::NodeValueType itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::NodeValueType

The basic scalar variable type used in OutputNodeType. Expected to be float or double. If NodeDataType is a scalar, then this is the same type as that.

Reimplemented in itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >.

Definition at line 103 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

typedef SparseOutputImageType::NodeType itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::OutputNodeType

Definition at line 94 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

typedef Superclass::PixelType itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::PixelType

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >.

Definition at line 82 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

typedef SmartPointer< Self > itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::Pointer

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >.

Reimplemented in itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >.

Definition at line 73 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

typedef FiniteDifferenceSparseImageFilter itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::Self

Standard class typedef

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >.

Reimplemented in itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >.

Definition at line 69 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

typedef SparseOutputImageType::SizeType itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::SizeType

Definition at line 93 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

typedef FiniteDifferenceSparseImageFunction< SparseOutputImageType > itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::SparseFunctionType

The sparse image finite difference function type used in this class.

Definition at line 107 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

typedef Superclass::OutputImageType itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::SparseOutputImageType

Reimplemented in itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >.

Definition at line 81 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

typedef FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType > itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::Superclass

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >.

Reimplemented in itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >.

Definition at line 71 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

typedef Superclass::TimeStepType itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::TimeStepType

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >.

Definition at line 83 of file itkFiniteDifferenceSparseImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImageType, class TSparseOutputImageType>

itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::FiniteDifferenceSparseImageFilter ( )

protected

template<class TInputImageType, class TSparseOutputImageType>

itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::~FiniteDifferenceSparseImageFilter ( )

inlineprotected

Definition at line 116 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::FiniteDifferenceSparseImageFilter ( const Self &  )

private

---

Member Function Documentation

template<class TInputImageType, class TSparseOutputImageType>

virtual void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::AllocateUpdateBuffer ( )

inlineprotectedvirtual

This class does not use AllocateUpdateBuffer to allocate memory for its narrow band. All memory is handled through the SparseImage class.

Implements itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >.

Definition at line 126 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

virtual void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::ApplyUpdate ( const TimeStepType &  dt )

protectedvirtual

This function updates the m_Data variable in the output image nodes using the update values computed by CalculateChange.

template<class TInputImageType, class TSparseOutputImageType>

static ITK_THREAD_RETURN_TYPE itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::ApplyUpdateThreaderCallback ( void *  arg )

staticprotected

Multi-threaded implementation of ApplyUpdate.

template<class TInputImageType, class TSparseOutputImageType>

virtual TimeStepType itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::CalculateChange ( )

protectedvirtual

This method computes changes to the output image using the ComputeSparseUpdate method in the Sparse Function object.

Implements itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >.

template<class TInputImageType, class TSparseOutputImageType>

static ITK_THREAD_RETURN_TYPE itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::CalculateChangeThreaderCallback ( void *  arg )

staticprotected

Multuthreaded implementation of CalculateChange

template<class TInputImageType, class TSparseOutputImageType>

virtual NodeDataType itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::DataConstraint ( const NodeDataType &  data ) const

inlineprotectedvirtual

This function can be used to implements constraints on the range of data values. Default is no constraint.

Definition at line 130 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

virtual const char* itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods)

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >.

Reimplemented in itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >.

template<class TInputImageType, class TSparseOutputImageType>

virtual bool itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::GetPrecomputeFlag ( ) const

virtual

template<class TInputImageType, class TSparseOutputImageType>

ThreadIdType itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::GetSplitRegion ( ThreadIdType  i, ThreadIdType  num, ThreadRegionType &  splitRegion  )

protected

This function returns a single region for use in multi-threading.

template<class TInputImageType, class TSparseOutputImageType>

virtual void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::Initialize ( )

protectedvirtual

This method splits the active pixels of the sparse image into equal size lists for multi-threading. These lists remain constant throughout the operation of this filter.

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >.

Reimplemented in itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >.

template<class TInputImageType, class TSparseOutputImageType>

void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::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< TInputImageType, TSparseOutputImageType >.

Reimplemented in itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >.

template<class TInputImageType, class TSparseOutputImageType>

virtual void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::PrecalculateChange ( )

protectedvirtual

This method provides a means of performing a first pass for computing the change and storing intermediate values that will then be used by CalculateChange. This can be used to speed up certain update rules.

template<class TInputImageType, class TSparseOutputImageType>

static ITK_THREAD_RETURN_TYPE itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::PrecalculateChangeThreaderCallback ( void *  arg )

staticprotected

Multi-threaded implementation of PrecalculateChange

template<class TInputImageType, class TSparseOutputImageType>

void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::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< TInputImageType, TSparseOutputImageType >.

Reimplemented in itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >.

template<class TInputImageType, class TSparseOutputImageType>

virtual void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::SetPrecomputeFlag ( bool  _arg )

virtual

template<class TInputImageType, class TSparseOutputImageType>

void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::SetSparseFunction

(

SparseFunctionType *

sf

)

Sets the function object that will be called for computing updates.

template<class TInputImageType, class TSparseOutputImageType>

virtual void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::ThreadedApplyUpdate ( const TimeStepType &  dt, const ThreadRegionType &  regionToProcess, ThreadIdType  threadId  )

protectedvirtual

template<class TInputImageType, class TSparseOutputImageType>

virtual TimeStepType itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::ThreadedCalculateChange ( const ThreadRegionType &  regionToProcess, ThreadIdType  threadId  )

protectedvirtual

template<class TInputImageType, class TSparseOutputImageType>

virtual void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::ThreadedPrecalculateChange ( const ThreadRegionType &  regionToProcess, ThreadIdType  threadId  )

protectedvirtual

---

Member Data Documentation

template<class TInputImageType, class TSparseOutputImageType>

const unsigned int itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::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< TInputImageType, TSparseOutputImageType >.

Reimplemented in itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >.

Definition at line 89 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

bool itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::m_PrecomputeFlag

private

Flag to let the class know whether or not to call PrecalculateChange.

Definition at line 189 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

NodeListType::RegionListType itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::m_RegionList

private

A list of subregions of the active set of pixels in the sparse image which are passed to each thread for parallel processing.

Definition at line 196 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

SparseFunctionType* itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::m_SparseFunction

private

The Sparse function type.

Definition at line 192 of file itkFiniteDifferenceSparseImageFilter.h.

---

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

• itkFiniteDifferenceSparseImageFilter.h