#include <itkFiniteDifferenceSparseImageFilter.h>

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

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

Detailed Description

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

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

typedef FiniteDifferenceFunction < TSparseOutputImageType >	FiniteDifferenceFunctionType

typedef TInputImageType	InputImageType

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

typedef SmartPointer< Self >	Pointer

typedef FiniteDifferenceFunctionType::RadiusType	RadiusType

typedef FiniteDifferenceImageFilter	Self

typedef InPlaceImageFilter < TInputImageType, TSparseOutputImageType >	Superclass

typedef FiniteDifferenceFunctionType::TimeStepType	TimeStepType

Public Types inherited from itk::InPlaceImageFilter< TInputImageType, TSparseOutputImageType >
typedef SmartPointer< const Self >	ConstPointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TInputImageType	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 < TInputImageType, TSparseOutputImageType >	Superclass

Public Types inherited from itk::ImageToImageFilter< TInputImageType, TSparseOutputImageType >
typedef SmartPointer< const Self >	ConstPointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TInputImageType	InputImageType

typedef Superclass::OutputImagePixelType	OutputImagePixelType

typedef Superclass::OutputImageRegionType	OutputImageRegionType

typedef SmartPointer< Self >	Pointer

typedef ImageToImageFilter	Self

typedef ImageSource < TSparseOutputImageType >	Superclass

Public Types inherited from itk::ImageSource< TSparseOutputImageType >
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 TSparseOutputImageType	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 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 () 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< 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 () 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 TInputImageType *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< TSparseOutputImageType >
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< TInputImageType, TSparseOutputImageType >
static const unsigned int	ImageDimension

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 const unsigned int	InputImageDimension

static const unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< TSparseOutputImageType >
static const unsigned int	OutputImageDimension

Protected Member Functions
virtual void	AllocateUpdateBuffer () override

virtual void	ApplyUpdate (const TimeStepType &dt) override

virtual TimeStepType	CalculateChange () override

virtual NodeDataType	DataConstraint (const NodeDataType &data) const

	FiniteDifferenceSparseImageFilter ()

ThreadIdType	GetSplitRegion (ThreadIdType i, ThreadIdType num, ThreadRegionType &splitRegion)

virtual void	Initialize () override

virtual void	PrecalculateChange ()

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

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

Protected Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >
virtual void	ApplyUpdate (const TimeStepType &dt)=0

virtual void	CopyInputToOutput ()=0

	FiniteDifferenceImageFilter ()

virtual void	GenerateData () override

virtual void	GenerateInputRequestedRegion () override

virtual bool	Halt ()

virtual void	InitializeIteration ()

virtual void	PostProcessOutput ()

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

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< TInputImageType, TSparseOutputImageType >
virtual void	AllocateOutputs () override

virtual bool	GetRunningInPlace () const

	InPlaceImageFilter ()

virtual void	ReleaseInputs () override

	~InPlaceImageFilter () override

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

	~ImageToImageFilter () override

void	PushBackInput (const DataObject *input) override

void	PushFrontInput (const DataObject *input) override

Protected Member Functions inherited from itk::ImageSource< TSparseOutputImageType >
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 ()

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)

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

static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

Private Attributes
bool	m_PrecomputeFlag

NodeListType::RegionListType	m_RegionList

SparseFunctionType *	m_SparseFunction

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< TInputImageType, TSparseOutputImageType >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType

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

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

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime

bool	m_Updating

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