#include <itkFiniteDifferenceSparseImageFilter.h>

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 64 of file itkFiniteDifferenceSparseImageFilter.h.

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

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

Classes
struct	FDThreadStruct

struct	ThreadRegionType

Public Types
using	ConstPointer = SmartPointer< const Self >

using	IndexType = typename SparseOutputImageType::IndexType

using	NodeDataType = typename OutputNodeType::NodeDataType

using	NodeListType = typename SparseOutputImageType::NodeListType

using	NodeValueType = typename OutputNodeType::NodeValueType

using	OutputNodeType = typename SparseOutputImageType::NodeType

using	Pointer = SmartPointer< Self >

using	Self = FiniteDifferenceSparseImageFilter

using	SizeType = typename SparseOutputImageType::SizeType

using	SparseFunctionType = FiniteDifferenceSparseImageFunction< SparseOutputImageType >

using	SparseOutputImageType = typename Superclass::OutputImageType

using	Superclass = FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >

Public Types inherited from itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >
using	ConstPointer = SmartPointer< const Self >

using	FiniteDifferenceFunctionType = FiniteDifferenceFunction< TSparseOutputImageType >

using	InputImageType = TInputImageType

using	InputPixelType = typename TInputImage::PixelType

using	InputPixelValueType = typename NumericTraits< InputPixelType >::ValueType

using	NeighborhoodScalesType = typename FiniteDifferenceFunctionType::NeighborhoodScalesType

using	OutputImageType = TSparseOutputImageType

using	OutputPixelType = typename TOutputImage::PixelType

using	OutputPixelValueType = typename NumericTraits< OutputPixelType >::ValueType

using	PixelType = OutputPixelType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename FiniteDifferenceFunctionType::RadiusType

using	Self = FiniteDifferenceImageFilter

using	Superclass = InPlaceImageFilter< TInputImageType, TSparseOutputImageType >

using	TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType

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

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImageType

using	Pointer = SmartPointer< Self >

using	Self = InPlaceImageFilter

using	Superclass = ImageToImageFilter< TInputImageType, TSparseOutputImageType >

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

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImageType

using	Pointer = SmartPointer< Self >

using	Self = ImageToImageFilter

using	Superclass = ImageSource< TSparseOutputImageType >

Public Types inherited from itk::ImageSource< TSparseOutputImageType >
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TSparseOutputImageType

using	Pointer = SmartPointer< Self >

using	Self = ImageSource

using	Superclass = ProcessObject

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

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

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

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
const char *	GetNameOfClass () const override

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

const char *	GetNameOfClass () const override

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

Public Member Functions inherited from itk::InPlaceImageFilter< TInputImageType, TSparseOutputImageType >
virtual bool	CanRunInPlace () const

const char *	GetNameOfClass () const override

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

Public Member Functions inherited from itk::ImageToImageFilter< TInputImageType, TSparseOutputImageType >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

const char *	GetNameOfClass () const override

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetInput (const InputImageType *input)

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 >
const char *	GetNameOfClass () const override

OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

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

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

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

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

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

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

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

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Attributes
static constexpr unsigned int	ImageDimension = Superclass::ImageDimension

Static Public Attributes inherited from itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >
static constexpr unsigned int	ImageDimension

Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImageType, TSparseOutputImageType >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImageType, TSparseOutputImageType >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

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

Protected Member Functions
void	AllocateUpdateBuffer () override

void	ApplyUpdate (const TimeStepType &dt) override

TimeStepType	CalculateChange () override

virtual NodeDataType	DataConstraint (const NodeDataType &data) const

	FiniteDifferenceSparseImageFilter ()

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

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

Protected Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >
virtual void	AllocateUpdateBuffer ()=0

virtual void	ApplyUpdate (const TimeStepType &dt)=0

virtual TimeStepType	CalculateChange ()=0

virtual void	CopyInputToOutput ()=0

	FiniteDifferenceImageFilter ()

void	GenerateData () override

void	GenerateInputRequestedRegion () override

virtual bool	Halt ()

virtual void	Initialize ()

virtual void	InitializeIteration ()

virtual void	PostProcessOutput ()

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

virtual TimeStepType	ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const BooleanStdVectorType &valid) const

virtual void	SetElapsedIterations (IdentifierType _arg)

virtual bool	ThreadedHalt (void *)

	~FiniteDifferenceImageFilter () override=default

Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImageType, TSparseOutputImageType >
virtual bool	GetRunningInPlace () const

	InPlaceImageFilter ()=default

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

void	ReleaseInputs () override

	~InPlaceImageFilter () override=default

void	AllocateOutputs () 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)

void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

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

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

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

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

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

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

	~ImageSource () override=default

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

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

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

virtual void	GenerateInputRequestedRegion ()

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

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

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

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

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 idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation () const

virtual void	VerifyPreconditions () const

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

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~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	PrintSelf (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_FUNCTION_CALL_CONVENTION	ApplyUpdateThreaderCallback (void *arg)

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	CalculateChangeThreaderCallback (void *arg)

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	PrecalculateChangeThreaderCallback (void *arg)

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

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Private Attributes
bool	m_PrecomputeFlag {}

NodeListType::RegionListType	m_RegionList {}

SparseFunctionType *	m_SparseFunction {}

Additional Inherited Members
Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImageType, TSparseOutputImageType >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

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

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

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

static Pointer	New ()

Protected Types inherited from itk::ImageToImageFilter< TInputImageType, TSparseOutputImageType >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

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::ImageSource< TSparseOutputImageType >
bool	m_DynamicMultiThreading

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImageType , typename TSparseOutputImageType >

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

Definition at line 75 of file itkFiniteDifferenceSparseImageFilter.h.

◆ IndexType

template<typename TInputImageType , typename TSparseOutputImageType >

using itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::IndexType = typename SparseOutputImageType::IndexType

Typedefs from the sparse output image type.

Definition at line 93 of file itkFiniteDifferenceSparseImageFilter.h.

◆ NodeDataType

template<typename TInputImageType , typename TSparseOutputImageType >

using itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::NodeDataType = typename OutputNodeType::NodeDataType

The type for the data variable of OutputNodeType.

Definition at line 99 of file itkFiniteDifferenceSparseImageFilter.h.

◆ NodeListType

template<typename TInputImageType , typename TSparseOutputImageType >

using itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::NodeListType = typename SparseOutputImageType::NodeListType

Definition at line 96 of file itkFiniteDifferenceSparseImageFilter.h.

◆ NodeValueType

template<typename TInputImageType , typename TSparseOutputImageType >

using itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::NodeValueType = typename OutputNodeType::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.

Definition at line 104 of file itkFiniteDifferenceSparseImageFilter.h.

◆ OutputNodeType

template<typename TInputImageType , typename TSparseOutputImageType >

using itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::OutputNodeType = typename SparseOutputImageType::NodeType

Definition at line 95 of file itkFiniteDifferenceSparseImageFilter.h.

◆ Pointer

template<typename TInputImageType , typename TSparseOutputImageType >

using itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::Pointer = SmartPointer<Self>

Definition at line 74 of file itkFiniteDifferenceSparseImageFilter.h.

◆ Self

template<typename TInputImageType , typename TSparseOutputImageType >

using itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::Self = FiniteDifferenceSparseImageFilter

Standard class type alias

Definition at line 71 of file itkFiniteDifferenceSparseImageFilter.h.

◆ SizeType

template<typename TInputImageType , typename TSparseOutputImageType >

using itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::SizeType = typename SparseOutputImageType::SizeType

Definition at line 94 of file itkFiniteDifferenceSparseImageFilter.h.

◆ SparseFunctionType

template<typename TInputImageType , typename TSparseOutputImageType >

using itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::SparseFunctionType = FiniteDifferenceSparseImageFunction<SparseOutputImageType>

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

Definition at line 107 of file itkFiniteDifferenceSparseImageFilter.h.

◆ SparseOutputImageType

template<typename TInputImageType , typename TSparseOutputImageType >

using itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::SparseOutputImageType = typename Superclass::OutputImageType

Definition at line 82 of file itkFiniteDifferenceSparseImageFilter.h.

◆ Superclass

template<typename TInputImageType , typename TSparseOutputImageType >

using itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::Superclass = FiniteDifferenceImageFilter<TInputImageType, TSparseOutputImageType>

Definition at line 72 of file itkFiniteDifferenceSparseImageFilter.h.

Constructor & Destructor Documentation

◆ FiniteDifferenceSparseImageFilter()

template<typename TInputImageType , typename TSparseOutputImageType >

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

protected

◆ ~FiniteDifferenceSparseImageFilter()

template<typename TInputImageType , typename TSparseOutputImageType >

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

overrideprotecteddefault

Member Function Documentation

◆ AllocateUpdateBuffer()

template<typename TInputImageType , typename TSparseOutputImageType >

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

inlineoverrideprotectedvirtual

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 131 of file itkFiniteDifferenceSparseImageFilter.h.

◆ ApplyUpdate()

template<typename TInputImageType , typename TSparseOutputImageType >

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

overrideprotectedvirtual

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

Implements itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >.

◆ ApplyUpdateThreaderCallback()

template<typename TInputImageType , typename TSparseOutputImageType >

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

staticprotected

Multi-threaded implementation of ApplyUpdate.

◆ CalculateChange()

template<typename TInputImageType , typename TSparseOutputImageType >

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

overrideprotectedvirtual

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

Implements itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >.

◆ CalculateChangeThreaderCallback()

template<typename TInputImageType , typename TSparseOutputImageType >

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

staticprotected

Multithreaded implementation of CalculateChange

◆ DataConstraint()

template<typename TInputImageType , typename 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 137 of file itkFiniteDifferenceSparseImageFilter.h.

◆ GetNameOfClass()

template<typename TInputImageType , typename TSparseOutputImageType >

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

◆ GetPrecomputeFlag()

template<typename TInputImageType , typename TSparseOutputImageType >

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

virtual

◆ GetSplitRegion()

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

◆ Initialize()

template<typename TInputImageType , typename TSparseOutputImageType >

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

overrideprotectedvirtual

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

◆ PrecalculateChange()

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

◆ PrecalculateChangeThreaderCallback()

template<typename TInputImageType , typename TSparseOutputImageType >

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

staticprotected

Multi-threaded implementation of PrecalculateChange

◆ PrintSelf()

template<typename TInputImageType , typename TSparseOutputImageType >

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

◆ SetPrecomputeFlag()

template<typename TInputImageType , typename TSparseOutputImageType >

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

virtual

◆ SetSparseFunction()

template<typename TInputImageType , typename TSparseOutputImageType >

void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::SetSparseFunction ( SparseFunctionType * sf )

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

◆ ThreadedApplyUpdate()

template<typename TInputImageType , typename TSparseOutputImageType >

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

protectedvirtual

◆ ThreadedCalculateChange()

template<typename TInputImageType , typename TSparseOutputImageType >

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

protectedvirtual

◆ ThreadedPrecalculateChange()

template<typename TInputImageType , typename TSparseOutputImageType >

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

protectedvirtual

Member Data Documentation

◆ ImageDimension

template<typename TInputImageType , typename TSparseOutputImageType >

constexpr unsigned int itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::ImageDimension = Superclass::ImageDimension

staticconstexpr

Dimensionality of input and output data is assumed to be the same. It is inherited from the superclass.

Definition at line 90 of file itkFiniteDifferenceSparseImageFilter.h.

◆ m_PrecomputeFlag

template<typename TInputImageType , typename TSparseOutputImageType >

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

private

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

Definition at line 206 of file itkFiniteDifferenceSparseImageFilter.h.

◆ m_RegionList

template<typename TInputImageType , typename 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 213 of file itkFiniteDifferenceSparseImageFilter.h.

◆ m_SparseFunction

template<typename TInputImageType , typename TSparseOutputImageType >

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

private

The Sparse function type.

Definition at line 209 of file itkFiniteDifferenceSparseImageFilter.h.

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

itkFiniteDifferenceSparseImageFilter.h

Detailed Description

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ IndexType

◆ NodeDataType

◆ NodeListType

◆ NodeValueType

◆ OutputNodeType

◆ Pointer

◆ Self

◆ SizeType

◆ SparseFunctionType

◆ SparseOutputImageType

◆ Superclass

Constructor & Destructor Documentation

◆ FiniteDifferenceSparseImageFilter()

◆ ~FiniteDifferenceSparseImageFilter()

Member Function Documentation

◆ AllocateUpdateBuffer()

◆ ApplyUpdate()

◆ ApplyUpdateThreaderCallback()

◆ CalculateChange()

◆ CalculateChangeThreaderCallback()

◆ DataConstraint()

◆ GetNameOfClass()

◆ GetPrecomputeFlag()

◆ GetSplitRegion()

◆ Initialize()

◆ PrecalculateChange()

◆ PrecalculateChangeThreaderCallback()

◆ PrintSelf()

◆ SetPrecomputeFlag()

◆ SetSparseFunction()

◆ ThreadedApplyUpdate()

◆ ThreadedCalculateChange()

◆ ThreadedPrecalculateChange()

Member Data Documentation

◆ ImageDimension

◆ m_PrecomputeFlag

◆ m_RegionList

◆ m_SparseFunction