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

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

#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 DataObject::Pointer DataObjectPointer

typedef std::vector
< DataObjectPointer > DataObjectPointerArray

typedef
DataObjectPointerArray::size_type DataObjectPointerArraySizeType

enum FilterStateType

typedef
Superclass::FiniteDifferenceFunctionType FiniteDifferenceFunctionType

typedef
SparseOutputImageType::IndexType IndexType

Public Member Functions

virtual void AbortGenerateDataOff ()

virtual void AbortGenerateDataOn ()

virtual bool CanRunInPlace () const

virtual LightObject::Pointer CreateAnother () const

virtual void DebugOff () const

virtual void DebugOn () const

virtual void Delete ()

virtual void EnlargeOutputRequestedRegion (DataObject *)

virtual const bool & GetAbortGenerateData ()

Command * GetCommand (unsigned long tag)

bool GetDebug () const

virtual const
FiniteDifferenceFunctionType::Pointer & GetDifferenceFunction () const

virtual const unsigned int & GetElapsedIterations ()

DataObjectPointerArray & GetInputs ()

const MetaDataDictionary & GetMetaDataDictionary (void) const

MetaDataDictionary & GetMetaDataDictionary (void)

virtual unsigned long GetMTime () const

MultiThreader * GetMultiThreader ()

virtual const char * GetNameOfClass () const

DataObjectPointerArraySizeType GetNumberOfInputs () const

virtual
DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const

virtual bool GetPrecomputeFlag () const

virtual const float & GetProgress ()

virtual int GetReferenceCount () const

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

virtual void GraftOutput (DataObject *output)

bool HasObserver (const EventObject &event) const

void InvokeEvent (const EventObject &) const

void InvokeEvent (const EventObject &)

itkStaticConstMacro (ImageDimension, unsigned int, OutputImageType::ImageDimension)

itkStaticConstMacro (ImageDimension, unsigned int, Superclass::ImageDimension)

virtual DataObjectPointer MakeOutput (unsigned int idx)

virtual void Modified () const

virtual void PrepareOutputs ()

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

virtual void PropagateRequestedRegion (DataObject *output)

virtual void Register () const

void RemoveAllObservers ()

void RemoveObserver (unsigned long tag)

virtual void ResetPipeline ()

virtual void SetAbortGenerateData (bool _arg)

void SetDebug (bool debugFlag) const

virtual void SetDifferenceFunction (FiniteDifferenceFunctionType *_arg)

void SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void SetPrecomputeFlag (bool _arg)

virtual void SetProgress (float _arg)

virtual void SetReferenceCount (int)

void SetSparseFunction (SparseFunctionType *sf)

void SetStateToInitialized ()

void SetStateToUninitialized ()

virtual void UnRegister () const

virtual void Update ()

virtual void UpdateLargestPossibleRegion ()

virtual void UpdateOutputData (DataObject *output)

virtual void UpdateOutputInformation ()

void UpdateProgress (float amount)

unsigned long AddObserver (const EventObject &event, Command *) const

unsigned long AddObserver (const EventObject &event, Command *)

virtual bool GetInPlace () const

virtual void InPlaceOff ()

virtual void InPlaceOn ()

virtual void SetInPlace (bool _arg)

const InputImageType * GetInput (unsigned int idx)

const InputImageType * GetInput (void)

virtual void SetInput (unsigned int, const TInputImageType *image)

virtual void SetInput (const InputImageType *image)

virtual const bool & GetManualReinitialization ()

virtual void ManualReinitializationOff ()

virtual void ManualReinitializationOn ()

virtual void SetManualReinitialization (bool _arg)

virtual const double & GetMaximumRMSError ()

virtual void SetMaximumRMSError (double _arg)

virtual const unsigned int & GetNumberOfIterations ()

virtual void SetNumberOfIterations (unsigned int _arg)

DataObjectPointerArraySizeType GetNumberOfOutputs () const

DataObjectPointerArray & GetOutputs ()

virtual const int & GetNumberOfThreads ()

virtual void SetNumberOfThreads (int _arg)

OutputImageType * GetOutput (unsigned int idx)

OutputImageType * GetOutput (void)

virtual const bool & GetReleaseDataBeforeUpdateFlag ()

virtual void ReleaseDataBeforeUpdateFlagOff ()

virtual void ReleaseDataBeforeUpdateFlagOn ()

virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual bool GetReleaseDataFlag () const

void ReleaseDataFlagOff ()

void ReleaseDataFlagOn ()

virtual void SetReleaseDataFlag (bool flag)

virtual const double & GetRMSChange ()

virtual void SetRMSChange (double _arg)

virtual const FilterStateType & GetState ()

virtual void SetState (FilterStateType _arg)

virtual const bool & GetUseImageSpacing ()

virtual void SetUseImageSpacing (bool _arg)

virtual void UseImageSpacingOff ()

virtual void UseImageSpacingOn ()

itkStaticConstMacro (OutputImageDimension, unsigned int, TSparseOutputImageType::ImageDimension)

itkStaticConstMacro (InputImageDimension, unsigned int, TInputImageType::ImageDimension)

virtual void PopBackInput ()

virtual void PopFrontInput ()

virtual void PushBackInput (const InputImageType *image)

virtual void PushFrontInput (const InputImageType *image)

Static Public Member Functions

static void BreakOnError ()

static Pointer New ()

static bool GetGlobalWarningDisplay ()

static void GlobalWarningDisplayOff ()

static void GlobalWarningDisplayOn ()

static void SetGlobalWarningDisplay (bool flag)

Protected Types

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

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

typedef int InternalReferenceCountType

Protected Member Functions

virtual void AfterThreadedGenerateData ()

virtual void AllocateOutputs ()

virtual void AllocateUpdateBuffer ()

virtual void ApplyUpdate (TimeStepType dt)=0

virtual void ApplyUpdate (TimeStepType dt)

virtual void BeforeThreadedGenerateData ()

virtual void CacheInputReleaseDataFlags ()

virtual TimeStepType CalculateChange ()

virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

virtual void CopyInputToOutput ()=0

virtual NodeDataType DataConstraint (const NodeDataType &data) const

FiniteDifferenceSparseImageFilter ()

virtual void GenerateData ()

virtual void GenerateInputRequestedRegion ()

virtual void GenerateOutputInformation ()

virtual void GenerateOutputRequestedRegion (DataObject *output)

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

virtual bool Halt ()

virtual void Initialize ()

virtual void InitializeIteration ()

virtual void PostProcessOutput ()

virtual void PrecalculateChange ()

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

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

virtual void PropagateResetPipeline ()

virtual void ReleaseInputs ()

virtual TimeStepType ResolveTimeStep (const TimeStepType *timeStepList, const bool *valid, int size)

virtual void RestoreInputReleaseDataFlags ()

virtual void SetElapsedIterations (unsigned int _arg)

void SetNumberOfInputs (unsigned int num)

void SetNumberOfOutputs (unsigned int num)

virtual int SplitRequestedRegion (int i, int num, OutputImageRegionType &splitRegion)

virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId) ITK_NO_RETURN

virtual bool ThreadedHalt (void *)

~FiniteDifferenceSparseImageFilter ()

virtual void AddInput (DataObject *input)

virtual const unsigned int & GetNumberOfRequiredInputs ()

virtual void RemoveInput (DataObject *input)

virtual void SetNthInput (unsigned int num, DataObject *input)

virtual void SetNumberOfRequiredInputs (unsigned int _arg)

virtual void AddOutput (DataObject *output)

virtual const unsigned int & GetNumberOfRequiredOutputs ()

virtual void RemoveOutput (DataObject *output)

virtual void SetNthOutput (unsigned int num, DataObject *output)

virtual void SetNumberOfRequiredOutputs (unsigned int _arg)

const DataObject * GetInput (unsigned int idx) const

const DataObject * GetOutput (unsigned int idx) const

virtual void PrintHeader (std::ostream &os, Indent indent) const

virtual void PrintTrailer (std::ostream &os, Indent indent) const

void PushBackInput (const DataObject *input)

void PushFrontInput (const DataObject *input)

Static Protected Member Functions

static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)

Protected Attributes

unsigned int m_ElapsedIterations

bool m_ManualReinitialization

double m_MaximumRMSError

unsigned int m_NumberOfIterations

TimeStamp m_OutputInformationMTime

InternalReferenceCountType m_ReferenceCount

SimpleFastMutexLock m_ReferenceCountLock

double m_RMSChange

bool m_Updating

virtual void ThreadedApplyUpdate (TimeStepType dt, const ThreadRegionType &regionToProcess, int threadId)

static ITK_THREAD_RETURN_TYPE ApplyUpdateThreaderCallback (void *arg)

virtual TimeStepType ThreadedCalculateChange (const ThreadRegionType &regionToProcess, int threadId)

static ITK_THREAD_RETURN_TYPE CalculateChangeThreaderCallback (void *arg)

virtual void ThreadedPrecalculateChange (const ThreadRegionType &regionToProcess, int threadId)

static ITK_THREAD_RETURN_TYPE PrecalculateChangeThreaderCallback (void *arg)

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

typedef DataObject::Pointer itk::ImageSource< TSparseOutputImageType >::DataObjectPointer [inherited]

Smart Pointer type to a DataObject.

Reimplemented from itk::ProcessObject.

Definition at line 62 of file itkImageSource.h.

typedef std::vector<DataObjectPointer> itk::ProcessObject::DataObjectPointerArray [inherited]

STL Array of SmartPointers to DataObjects

Definition at line 103 of file itkProcessObject.h.

typedef DataObjectPointerArray::size_type itk::ProcessObject::DataObjectPointerArraySizeType [inherited]

Size type of an std::vector

Definition at line 112 of file itkProcessObject.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 81 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 89 of file itkFiniteDifferenceSparseImageFilter.h.

typedef InputImageType::ConstPointer itk::InPlaceImageFilter< TInputImageType , TSparseOutputImageType >::InputImageConstPointer [inherited]

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

Definition at line 84 of file itkInPlaceImageFilter.h.

typedef InputImageType::PixelType itk::InPlaceImageFilter< TInputImageType , TSparseOutputImageType >::InputImagePixelType [inherited]

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

Definition at line 86 of file itkInPlaceImageFilter.h.

typedef InputImageType::Pointer itk::InPlaceImageFilter< TInputImageType , TSparseOutputImageType >::InputImagePointer [inherited]

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

Definition at line 83 of file itkInPlaceImageFilter.h.

typedef InputImageType::RegionType itk::InPlaceImageFilter< TInputImageType , TSparseOutputImageType >::InputImageRegionType [inherited]

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

Definition at line 85 of file itkInPlaceImageFilter.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 74 of file itkFiniteDifferenceSparseImageFilter.h.

typedef TInputImageType ::PixelType itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::InputPixelType [inherited]

Definition at line 145 of file itkFiniteDifferenceImageFilter.h.

typedef NumericTraits< InputPixelType >::ValueType itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::InputPixelValueType [inherited]

Definition at line 150 of file itkFiniteDifferenceImageFilter.h.

typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension)> itk::ImageToImageFilter< TInputImageType , TSparseOutputImageType >::InputToOutputRegionCopierType [protected, inherited]

Typedef for the region copier function object that converts an input region to an output region.

Definition at line 164 of file itkImageToImageFilter.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

typedef FiniteDifferenceFunctionType::NeighborhoodScalesType itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::NeighborhoodScalesType [inherited]

Definition at line 159 of file itkFiniteDifferenceImageFilter.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 95 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 92 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 100 of file itkFiniteDifferenceSparseImageFilter.h.

typedef Superclass::OutputImagePixelType itk::InPlaceImageFilter< TInputImageType , TSparseOutputImageType >::OutputImagePixelType [inherited]

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

Definition at line 79 of file itkInPlaceImageFilter.h.

typedef Superclass::OutputImagePointer itk::InPlaceImageFilter< TInputImageType , TSparseOutputImageType >::OutputImagePointer [inherited]

Reimplemented from itk::ImageSource< TSparseOutputImageType >.

Definition at line 77 of file itkInPlaceImageFilter.h.

typedef Superclass::OutputImageRegionType itk::InPlaceImageFilter< TInputImageType , TSparseOutputImageType >::OutputImageRegionType [inherited]

Superclass typedefs.

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

Definition at line 78 of file itkInPlaceImageFilter.h.

typedef TSparseOutputImageType itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::OutputImageType [inherited]

Superclass typedefs.

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

Definition at line 138 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

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

Definition at line 91 of file itkFiniteDifferenceSparseImageFilter.h.

typedef TSparseOutputImageType ::PixelType itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::OutputPixelType [inherited]

The pixel type of the output image will be used in computations.

Definition at line 144 of file itkFiniteDifferenceImageFilter.h.

typedef NumericTraits< OutputPixelType >::ValueType itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::OutputPixelValueType [inherited]

Extract value type in case the pixel is of vector type

Definition at line 149 of file itkFiniteDifferenceImageFilter.h.

typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)> itk::ImageToImageFilter< TInputImageType , TSparseOutputImageType >::OutputToInputRegionCopierType [protected, inherited]

Typedef for the region copier function object that converts an output region to an input region.

Definition at line 169 of file itkImageToImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

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

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

Definition at line 79 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 70 of file itkFiniteDifferenceSparseImageFilter.h.

typedef FiniteDifferenceFunctionType::RadiusType itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::RadiusType [inherited]

Definition at line 158 of file itkFiniteDifferenceImageFilter.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 67 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

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

Definition at line 90 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 104 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 78 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 69 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 80 of file itkFiniteDifferenceSparseImageFilter.h.

Member Enumeration Documentation

enum itk::FiniteDifferenceImageFilter::FilterStateType [inherited]

Definition at line 161 of file itkFiniteDifferenceImageFilter.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 ( ) [inline, protected]

Definition at line 114 of file itkFiniteDifferenceSparseImageFilter.h.

Member Function Documentation

virtual void itk::ProcessObject::AbortGenerateDataOff ( ) [virtual, inherited]

virtual void itk::ProcessObject::AbortGenerateDataOn ( ) [virtual, inherited]

Turn on and off the AbortGenerateData flag.

virtual void itk::ProcessObject::AddInput ( DataObject * input ) [protected, virtual, inherited]

Protected methods for setting inputs. Subclasses make use of them for setting input.

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

virtual void itk::ProcessObject::AddOutput ( DataObject * output ) [protected, virtual, inherited]

Protected methods for setting outputs. Subclasses make use of them for getting output.

virtual void itk::ImageSource< TSparseOutputImageType >::AfterThreadedGenerateData ( void ) [inline, protected, virtual, inherited]

If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Definition at line 265 of file itkImageSource.h.

virtual void itk::InPlaceImageFilter< TInputImageType , TSparseOutputImageType >::AllocateOutputs ( ) [protected, virtual, inherited]

The GenerateData method normally allocates the buffers for all of the outputs of a filter. Since InPlaceImageFilter's can use an overwritten version of the input for its output, the output buffer should not be allocated. When possible, we graft the input to the filter to the output. If an InPlaceFilter has multiple outputs, then it would need to override this method to graft one of its outputs and allocate the remaining. If a filter is threaded (i.e. it provides an implementation of ThreadedGenerateData()), this method is called automatically. If an InPlaceFilter is not threaded (i.e. it provides an implementation of GenerateData()), then this method (or equivalent) must be called in GenerateData().

Reimplemented from itk::ImageSource< TSparseOutputImageType >.

template<class TInputImageType, class TSparseOutputImageType>

virtual void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::AllocateUpdateBuffer ( ) [inline, protected, virtual]

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

virtual void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::ApplyUpdate ( TimeStepType dt ) [protected, pure virtual, inherited]

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

Parameters:

dt

Time step value.

template<class TInputImageType, class TSparseOutputImageType>

virtual void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::ApplyUpdate ( TimeStepType dt ) [protected, virtual]

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 ) [static, protected]

Multi-threaded implementation of ApplyUpdate.

virtual void itk::ImageSource< TSparseOutputImageType >::BeforeThreadedGenerateData ( void ) [inline, protected, virtual, inherited]

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Definition at line 253 of file itkImageSource.h.

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual void itk::ProcessObject::CacheInputReleaseDataFlags ( ) [protected, virtual, inherited]

Cache the state of any ReleaseDataFlag's on the inputs. While the filter is executing, we need to set the ReleaseDataFlag's on the inputs to false in case the current filter is implemented using a mini-pipeline (which will try to release the inputs). After the filter finishes, we restore the state of the ReleaseDataFlag's before the call to ReleaseInputs().

template<class TInputImageType, class TSparseOutputImageType>

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

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 ) [static, protected]

Multuthreaded implementation of CalculateChange

virtual void itk::ImageToImageFilter< TInputImageType , TSparseOutputImageType >::CallCopyInputRegionToOutputRegion	(	OutputImageRegionType &	destRegion,
		const InputImageRegionType &	srcRegion
	)			`[protected, virtual, inherited]`

This function calls the actual region copier to do the mapping from input image space to output image space. It uses a Function object used for dispatching to various routines to copy an input region (start index and size) to an output region. For most filters, this is a trivial copy because most filters require the input dimension to match the output dimension. However, some filters like itk::UnaryFunctorImageFilter can support output images of a higher dimension that the input.

This function object is used by the default implementation of GenerateOutputInformation(). It can also be used in routines like ThreadedGenerateData() where a filter may need to map an input region to an output region.

The default copier uses a "dispatch pattern" to call one of three overloaded functions depending on whether the input and output images are the same dimension, the input is a higher dimension that the output, or the input is of a lower dimension than the output. The use of an overloaded function is required for proper compilation of the various cases.

For the latter two cases, trivial implementations are used. If the input image is a higher dimension than the output, the first portion of the input region is copied to the output region. If the input region is a lower dimension than the output, the input region information is copied into the first portion of the output region and the rest of the output region is set to zero.

If a filter needs a different default behavior, it can override this method.

virtual void itk::ImageToImageFilter< TInputImageType , TSparseOutputImageType >::CallCopyOutputRegionToInputRegion	(	InputImageRegionType &	destRegion,
		const OutputImageRegionType &	srcRegion
	)			`[protected, virtual, inherited]`

This function calls the actual region copier to do the mapping from output image space to input image space. It uses a Function object used for dispatching to various routines to copy an output region (start index and size) to an input region. For most filters, this is a trivial copy because most filters require the input dimension to match the output dimension. However, some filters like itk::ExtractImageFilter can support output images of a lower dimension that the input.

This function object can be used by GenerateOutputInformation() to copy the input LargestPossibleRegion to the output LargestPossibleRegion and can also be used in GenerateData or ThreadedGenerateData() where a filter may need to map an output region to an input region.

The default copier uses a "dispatch pattern" to call one of three overloaded functions depending on whether the input and output images are the same dimension, the input is a higher dimension that the output, or the input is of a lower dimension than the output. The use of an overloaded function is required for proper compilation of the various cases.

For the latter two cases, trivial implementations are used. If the input image is a higher dimension than the output, the output region information is copied into the first portion of the input region and the rest of the input region is set to zero. If the input region is a lower dimension than the output, the first portion of the output region is copied to the input region.

If a filter needs a different default behavior, it can override this method. The ExtractImageFilter overrides this function object so that if the input image is a higher dimension than the output image, the filter can control "where" in the input image the output subimage is extracted (as opposed to mapping to first few dimensions of the input).

virtual bool itk::InPlaceImageFilter< TInputImageType , TSparseOutputImageType >::CanRunInPlace ( ) const [inline, virtual, inherited]

Can the filter run in place? To do so, the filter's first input and output must have the same dimension and pixel type. This method can be used in conjunction with the InPlace ivar to determine whether a particular use of the filter is really running in place. Some filters may be able to optimize their operation if the InPlace is true and CanRunInPlace is true. CanRunInPlace may also be overridded by InPlaceImageFilter subclasses to fine tune its behavior.

Definition at line 113 of file itkInPlaceImageFilter.h.

virtual void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::CopyInputToOutput ( ) [protected, pure virtual, inherited]

This method can be defined in subclasses as needed to copy the input to the output. See DenseFiniteDifferenceImageFilter for an implementation.

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightObject.

template<class TInputImageType, class TSparseOutputImageType>

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

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

Definition at line 128 of file itkFiniteDifferenceSparseImageFilter.h.

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

virtual void itk::ProcessObject::EnlargeOutputRequestedRegion ( DataObject * ) [inline, virtual, inherited]

Give the process object a chance to indictate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Definition at line 225 of file itkProcessObject.h.

virtual void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::GenerateData ( void ) [protected, virtual, inherited]

This is the default, high-level algorithm for calculating finite difference solutions. It calls virtual methods in its subclasses to implement the major steps of the algorithm.

Reimplemented from itk::ImageSource< TSparseOutputImageType >.

virtual void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::GenerateInputRequestedRegion ( void ) [protected, virtual, inherited]

FiniteDifferenceImageFilter needs a larger input requested region than the output requested region. As such, we need to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

: The filter will ask for a padded region to perform its neighborhood calculations. If no such region is available, the boundaries will be handled as described in the FiniteDifferenceFunction defined by the subclass.

See also:: ProcessObject::GenerateInputRequestedRegion()

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

virtual void itk::ProcessObject::GenerateOutputInformation ( ) [protected, virtual, inherited]

Generate the information decribing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

virtual void itk::ProcessObject::GenerateOutputRequestedRegion ( DataObject * output ) [protected, virtual, inherited]

Given one output whose requested region has been set, how should the requested regions for the remaining outputs of the process object be set? By default, all the outputs are set to the same requested region. If a filter needs to produce different requested regions for each output, for instance an image processing filter producing several outputs at different resolutions, then that filter may override this method and set the requested regions appropriatedly.

Note that a filter producing multiple outputs of different types is required to override this method. The default implementation can only correctly handle multiple outputs of the same type.

Reimplemented in itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >, itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >, itk::watershed::BoundaryResolver< TPixelType, TDimension >, itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >, itk::watershed::Relabeler< TScalarType, TImageDimension >, itk::watershed::Segmenter< TInputImage >, itk::watershed::SegmentTreeGenerator< TScalarType >, itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>, itk::watershed::Segmenter< InputImageType >, and itk::watershed::SegmentTreeGenerator< ScalarType >.

virtual const bool& itk::ProcessObject::GetAbortGenerateData ( ) [virtual, inherited]

Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

virtual const FiniteDifferenceFunctionType ::Pointer& itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::GetDifferenceFunction ( ) const [virtual, inherited]

This method returns a pointer to a FiniteDifferenceFunction object that will be used by the filter to calculate updates at image pixels.

Returns:: A FiniteDifferenceObject pointer.

virtual const unsigned int& itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::GetElapsedIterations ( ) [virtual, inherited]

Get the number of elapsed iterations of the filter.

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

virtual bool itk::InPlaceImageFilter< TInputImageType , TSparseOutputImageType >::GetInPlace ( ) const [virtual, inherited]

In place operation can be turned on and off. Asking for in-place operation, i.e. calling SetInplace(true) or InplaceOn(), will be effective only if CanRunInPlace also returns true. By default CanRunInPlace checks whether the input and output image type match.

const DataObject* itk::ProcessObject::GetInput ( unsigned int idx ) const [protected, inherited]

Method used internally for getting an input.

const InputImageType* itk::ImageToImageFilter< TInputImageType , TSparseOutputImageType >::GetInput ( unsigned int idx ) [inherited]

Set/Get the image input of this process object.

Reimplemented from itk::ProcessObject.

const InputImageType* itk::ImageToImageFilter< TInputImageType , TSparseOutputImageType >::GetInput ( void ) [inherited]

Set/Get the image input of this process object.

DataObjectPointerArray& itk::ProcessObject::GetInputs ( ) [inline, inherited]

Return an array with all the inputs of this process object. This is useful for tracing back in the pipeline to construct graphs etc.

Definition at line 108 of file itkProcessObject.h.

virtual const bool& itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::GetManualReinitialization ( ) [virtual, inherited]

Require the filter to be manually reinitialized (by calling SetStateToUninitialized()

virtual const double& itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::GetMaximumRMSError ( ) [virtual, inherited]

Set/Get the maximum error allowed in the solution. This may not be defined for all solvers and its meaning may change with the application.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

virtual unsigned long itk::Object::GetMTime ( ) const [virtual, inherited]

Return this objects modified time.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

MultiThreader* itk::ProcessObject::GetMultiThreader ( ) [inline, inherited]

Return the multithreader used by this class.

Definition at line 284 of file itkProcessObject.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 >.

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfInputs ( ) const [inline, inherited]

Get the size of the input vector. This is merely the size of the input vector, not the number of inputs that have valid DataObject's assigned. Use GetNumberOfValidRequiredInputs() to determine how many inputs are non-null.

Definition at line 118 of file itkProcessObject.h.

virtual const unsigned int& itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::GetNumberOfIterations ( ) [virtual, inherited]

Set/Get the number of iterations that the filter will run.

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfOutputs ( ) const [inline, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

Definition at line 135 of file itkProcessObject.h.

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredInputs ( ) [protected, virtual, inherited]

Protected methods for setting inputs. Subclasses make use of them for setting input.

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredOutputs ( ) [protected, virtual, inherited]

Protected methods for setting outputs. Subclasses make use of them for getting output.

virtual const int& itk::ProcessObject::GetNumberOfThreads ( ) [virtual, inherited]

Get/Set the number of threads to create when executing.

virtual DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfValidRequiredInputs ( ) const [virtual, inherited]

Get the number of valid inputs. This is the number of non-null entries in the input vector in the first NumberOfRequiredInputs slots. This method is used to determine whether the necessary required inputs have been set. Subclasses of ProcessObject may override this implementation if the required inputs are not the first slots in input vector.

Reimplemented in itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDeformationField, TRealType >, itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >, and itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

const DataObject* itk::ProcessObject::GetOutput ( unsigned int idx ) const [protected, inherited]

Method used internally for getting an output.

OutputImageType* itk::ImageSource< TSparseOutputImageType >::GetOutput ( unsigned int idx ) [inherited]

Get the output data of this process object. The output of this function is not valid until an appropriate Update() method has been called, either explicitly or implicitly. Both the filter itself and the data object have Update() methods, and both methods update the data. Here are three ways to use GetOutput() and make sure the data is valid. In these examples, image is a pointer to some Image object, and the particular ProcessObjects involved are filters. The same examples apply to non-image (e.g. Mesh) data as well.

   anotherFilter->SetInput( someFilter->GetOutput() );
   anotherFilter->Update();

In this situation, someFilter and anotherFilter are said to constitute a pipeline.

   image = someFilter->GetOutput();
   image->Update();

   someFilter->Update();
   image = someFilter->GetOutput();

(In the above example, the two lines of code can be in either order.)

Note that Update() is not called automatically except within a pipeline as in the first example. When streaming (using a StreamingImageFilter) is activated, it may be more efficient to use a pipeline than to call Update() once for each filter in turn.

For an image, the data generated is for the requested Region, which can be set using ImageBase::SetRequestedRegion(). By default, the largest possible region is requested.

For Filters which have multiple outputs of different types, the GetOutput() method assumes the output is of OutputImageType. For the GetOutput(unsigned int) method, a dynamic_cast is performed incase the filter has outputs of different types or image types. Derived classes should have names get methods for these outputs.

Reimplemented from itk::ProcessObject.

OutputImageType* itk::ImageSource< TSparseOutputImageType >::GetOutput ( void ) [inherited]

Get the output data of this process object. The output of this function is not valid until an appropriate Update() method has been called, either explicitly or implicitly. Both the filter itself and the data object have Update() methods, and both methods update the data. Here are three ways to use GetOutput() and make sure the data is valid. In these examples, image is a pointer to some Image object, and the particular ProcessObjects involved are filters. The same examples apply to non-image (e.g. Mesh) data as well.

   anotherFilter->SetInput( someFilter->GetOutput() );
   anotherFilter->Update();

In this situation, someFilter and anotherFilter are said to constitute a pipeline.

   image = someFilter->GetOutput();
   image->Update();

   someFilter->Update();
   image = someFilter->GetOutput();

(In the above example, the two lines of code can be in either order.)

Note that Update() is not called automatically except within a pipeline as in the first example. When streaming (using a StreamingImageFilter) is activated, it may be more efficient to use a pipeline than to call Update() once for each filter in turn.

For an image, the data generated is for the requested Region, which can be set using ImageBase::SetRequestedRegion(). By default, the largest possible region is requested.

For Filters which have multiple outputs of different types, the GetOutput() method assumes the output is of OutputImageType. For the GetOutput(unsigned int) method, a dynamic_cast is performed incase the filter has outputs of different types or image types. Derived classes should have names get methods for these outputs.

DataObjectPointerArray& itk::ProcessObject::GetOutputs ( ) [inline, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

Definition at line 133 of file itkProcessObject.h.

template<class TInputImageType, class TSparseOutputImageType>

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

virtual const float& itk::ProcessObject::GetProgress ( ) [virtual, inherited]

Get the execution progress of a process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution.

Referenced by itk::XMLFilterWatcher::ShowProgress().

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

virtual const bool& itk::ProcessObject::GetReleaseDataBeforeUpdateFlag ( ) [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released/reallocated during an Update(). In limited memory scenarios, a user may want to force the elements of a pipeline to release any bulk data that is going to be regenerated anyway during an Update() in order to control peak memory allocation. Note that this flag is different from the ReleaseDataFlag. ReleaseDataFlag manages the deallocation of a ProcessObject's bulk output data once that data has been consumed by a downstream ProcessObject. The ReleaseDataBeforeUpdateFlag manages the deallocation/reallocation of bulk data during a pipeline update to control peak memory utilization. Default value is on.

virtual bool itk::ProcessObject::GetReleaseDataFlag ( ) const [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released after being used by a downstream ProcessObject. Default value is off. Another options for controlling memory utilization is the ReleaseDataBeforeUpdateFlag.

virtual const double& itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::GetRMSChange ( ) [virtual, inherited]

Set/Get the root mean squared change of the previous iteration. May not be used by all solvers.

template<class TInputImageType, class TSparseOutputImageType>

int itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::GetSplitRegion	(	int	i,
		int	num,
		ThreadRegionType &	splitRegion
	)			`[protected]`

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

virtual const FilterStateType& itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::GetState ( ) [virtual, inherited]

Set/Get the state of the filter.

virtual const bool& itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::GetUseImageSpacing ( ) [virtual, inherited]

Use the image spacing information in calculations. Use this option if you want derivatives in physical space. Default is UseImageSpacingOff.

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

virtual void itk::ImageSource< TSparseOutputImageType >::GraftNthOutput	(	unsigned int	idx,
		DataObject *	output
	)			`[virtual, inherited]`

Graft the specified data object onto this ProcessObject's idx'th output. This is similar to the GraftOutput method except it allows you to specify which output is affected. The specified index must be a valid output number (less than ProcessObject::GetNumberOfOutputs()). See the GraftOutput for general usage information.

virtual void itk::ImageSource< TSparseOutputImageType >::GraftOutput ( DataObject * output ) [virtual, inherited]

Graft the specified DataObject onto this ProcessObject's output. This method grabs a handle to the specified DataObject's bulk data to used as its output's own bulk data. It also copies the region ivars (RequestedRegion, BufferedRegion, LargestPossibleRegion) and meta-data (Spacing, Origin) from the specified data object into this filter's output data object. Most importantly, however, it leaves the Source ivar untouched so the original pipeline routing is intact. This method is used when a process object is implemented using a mini-pipeline which is defined in its GenerateData() method. The usage is:

    // setup the mini-pipeline to process the input to this filter
    firstFilterInMiniPipeline->SetInput( this->GetInput() );

    // setup the mini-pipeline to calculate the correct regions
    // and write to the appropriate bulk data block
    lastFilterInMiniPipeline->GraftOutput( this->GetOutput() );

    // execute the mini-pipeline
    lastFilterInMiniPipeline->Update();

    // graft the mini-pipeline output back onto this filter's output.
    // this is needed to get the appropriate regions passed back.
    this->GraftOutput( lastFilterInMiniPipeline->GetOutput() );

For proper pipeline execution, a filter using a mini-pipeline must implement the GenerateInputRequestedRegion(), GenerateOutputRequestedRegion(), GenerateOutputInformation() and EnlargeOutputRequestedRegion() methods as necessary to reflect how the mini-pipeline will execute (in other words, the outer filter's pipeline mechanism must be consistent with what the mini-pipeline will do).

virtual bool itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::Halt ( ) [protected, virtual, inherited]

This method returns true when the current iterative solution of the equation has met the criteria to stop solving. Defined by a subclass.

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

template<class TInputImageType, class TSparseOutputImageType>

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

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

virtual void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::InitializeIteration ( ) [inline, protected, virtual, inherited]

This method is optionally defined by a subclass and is called immediately prior to each iterative CalculateChange-ApplyUpdate cycle. It can be used to set global variables needed for the next iteration (ie. average gradient magnitude of the image in anisotropic diffusion functions), or otherwise prepare for the next iteration.

Definition at line 318 of file itkFiniteDifferenceImageFilter.h.

virtual void itk::InPlaceImageFilter< TInputImageType , TSparseOutputImageType >::InPlaceOff ( ) [virtual, inherited]

In place operation can be turned on and off. Asking for in-place operation, i.e. calling SetInplace(true) or InplaceOn(), will be effective only if CanRunInPlace also returns true. By default CanRunInPlace checks whether the input and output image type match.

virtual void itk::InPlaceImageFilter< TInputImageType , TSparseOutputImageType >::InPlaceOn ( ) [virtual, inherited]

In place operation can be turned on and off. Asking for in-place operation, i.e. calling SetInplace(true) or InplaceOn(), will be effective only if CanRunInPlace also returns true. By default CanRunInPlace checks whether the input and output image type match.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

itk::InPlaceImageFilter< TInputImageType , TSparseOutputImageType >::itkStaticConstMacro	(	OutputImageDimension	,
		unsigned	int,
		TSparseOutputImageType ::ImageDimension
	)			`[inherited]`

ImageDimension constants

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

itk::InPlaceImageFilter< TInputImageType , TSparseOutputImageType >::itkStaticConstMacro	(	InputImageDimension	,
		unsigned	int,
		TInputImageType ::ImageDimension
	)			`[inherited]`

ImageDimension constants

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

itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::itkStaticConstMacro	(	ImageDimension	,
		unsigned	int,
		OutputImageType::ImageDimension
	)			`[inherited]`

Dimensionality of input and output data is assumed to be the same.

template<class TInputImageType, class TSparseOutputImageType>

itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::itkStaticConstMacro	(	ImageDimension	,
		unsigned	int,
		Superclass::ImageDimension
	)

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

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

virtual DataObjectPointer itk::ImageSource< TSparseOutputImageType >::MakeOutput ( unsigned int idx ) [virtual, inherited]

Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a SmartPointer to a DataObject. If a subclass of ImageSource has multiple outputs of different types, then that class must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

virtual void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::ManualReinitializationOff ( ) [virtual, inherited]

Require the filter to be manually reinitialized (by calling SetStateToUninitialized()

virtual void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::ManualReinitializationOn ( ) [virtual, inherited]

Require the filter to be manually reinitialized (by calling SetStateToUninitialized()

virtual void itk::Object::Modified ( ) const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

static Pointer itk::Object::New ( ) [static, inherited]

Method for creation through the object factory.

Reimplemented from itk::LightObject.

virtual void itk::ImageToImageFilter< TInputImageType , TSparseOutputImageType >::PopBackInput ( ) [virtual, inherited]

Push/Pop the input of this process object. These methods allow a filter to model its input vector as a queue or stack. These routines may not be appropriate for all filters, especially filters with different types of inputs. These routines follow the semantics of STL.

The routines are useful for applications that need to process "rolling" sets of images. For instance, if an application has 10 images and they need to run a filter on images 1, 2, 3, 4, then run the filter on images 2, 3, 4, 5, then run the filter on images 3, 4, 5, 6, the application can accomplish this by popping an input off the front of the input list and push a new image onto the back of input list. Again, this only makes sense for filters that single type of input.

Other uses are also possible. For a single input filter, pushing and popping inputs allow the application to temporarily replace an input to a filter.

Reimplemented from itk::ProcessObject.

virtual void itk::ImageToImageFilter< TInputImageType , TSparseOutputImageType >::PopFrontInput ( ) [virtual, inherited]

Push/Pop the input of this process object. These methods allow a filter to model its input vector as a queue or stack. These routines may not be appropriate for all filters, especially filters with different types of inputs. These routines follow the semantics of STL.

The routines are useful for applications that need to process "rolling" sets of images. For instance, if an application has 10 images and they need to run a filter on images 1, 2, 3, 4, then run the filter on images 2, 3, 4, 5, then run the filter on images 3, 4, 5, 6, the application can accomplish this by popping an input off the front of the input list and push a new image onto the back of input list. Again, this only makes sense for filters that single type of input.

Other uses are also possible. For a single input filter, pushing and popping inputs allow the application to temporarily replace an input to a filter.

Reimplemented from itk::ProcessObject.

virtual void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::PostProcessOutput ( ) [inline, protected, virtual, inherited]

This method is called after the solution has been generated to allow subclasses to apply some further processing to the output.

Definition at line 342 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

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

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 ) [static, protected]

Multithreaded implementation of PrecalculateChange

virtual void itk::ProcessObject::PrepareOutputs ( ) [virtual, inherited]

An opportunity to deallocate a ProcessObject's bulk data storage. Some filters may wish to reuse existing bulk data storage to avoid unnecessary deallocation/allocation sequences. The default implementation calls Initialize() on each output. DataObject::Initialize() frees its bulk data by default.

Reimplemented in itk::WatershedImageFilter< TInputImage >.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)			const `[inherited]`

Cause the object to print itself out.

Referenced by itk::WeakPointer< ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

template<class TInputImageType, class TSparseOutputImageType>

void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual]`

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

virtual void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

virtual void itk::ProcessObject::PropagateRequestedRegion ( DataObject * output ) [virtual, inherited]

Send the requested region information back up the pipeline (to the filters that preceed this one).

Reimplemented in itk::StreamingImageFilter< TInputImage, TOutputImage >, and itk::VTKImageImport< TOutputImage >.

virtual void itk::ProcessObject::PropagateResetPipeline ( ) [protected, virtual, inherited]

Called to allocate the input array. Copies old inputs. Propagate a call to ResetPipeline() up the pipeline. Called only from DataObject.

void itk::ImageToImageFilter< TInputImageType , TSparseOutputImageType >::PushBackInput ( const DataObject * input ) [inline, protected, virtual, inherited]

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

Definition at line 251 of file itkImageToImageFilter.h.

virtual void itk::ImageToImageFilter< TInputImageType , TSparseOutputImageType >::PushBackInput ( const InputImageType * image ) [virtual, inherited]

Push/Pop the input of this process object. These methods allow a filter to model its input vector as a queue or stack. These routines may not be appropriate for all filters, especially filters with different types of inputs. These routines follow the semantics of STL.

The routines are useful for applications that need to process "rolling" sets of images. For instance, if an application has 10 images and they need to run a filter on images 1, 2, 3, 4, then run the filter on images 2, 3, 4, 5, then run the filter on images 3, 4, 5, 6, the application can accomplish this by popping an input off the front of the input list and push a new image onto the back of input list. Again, this only makes sense for filters that single type of input.

Other uses are also possible. For a single input filter, pushing and popping inputs allow the application to temporarily replace an input to a filter.

void itk::ImageToImageFilter< TInputImageType , TSparseOutputImageType >::PushFrontInput ( const DataObject * input ) [inline, protected, virtual, inherited]

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

Definition at line 253 of file itkImageToImageFilter.h.

virtual void itk::ImageToImageFilter< TInputImageType , TSparseOutputImageType >::PushFrontInput ( const InputImageType * image ) [virtual, inherited]

Push/Pop the input of this process object. These methods allow a filter to model its input vector as a queue or stack. These routines may not be appropriate for all filters, especially filters with different types of inputs. These routines follow the semantics of STL.

The routines are useful for applications that need to process "rolling" sets of images. For instance, if an application has 10 images and they need to run a filter on images 1, 2, 3, 4, then run the filter on images 2, 3, 4, 5, then run the filter on images 3, 4, 5, 6, the application can accomplish this by popping an input off the front of the input list and push a new image onto the back of input list. Again, this only makes sense for filters that single type of input.

Other uses are also possible. For a single input filter, pushing and popping inputs allow the application to temporarily replace an input to a filter.

virtual void itk::Object::Register ( ) const [virtual, inherited]

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOff ( ) [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released/reallocated during an Update(). In limited memory scenarios, a user may want to force the elements of a pipeline to release any bulk data that is going to be regenerated anyway during an Update() in order to control peak memory allocation. Note that this flag is different from the ReleaseDataFlag. ReleaseDataFlag manages the deallocation of a ProcessObject's bulk output data once that data has been consumed by a downstream ProcessObject. The ReleaseDataBeforeUpdateFlag manages the deallocation/reallocation of bulk data during a pipeline update to control peak memory utilization. Default value is on.

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOn ( ) [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released/reallocated during an Update(). In limited memory scenarios, a user may want to force the elements of a pipeline to release any bulk data that is going to be regenerated anyway during an Update() in order to control peak memory allocation. Note that this flag is different from the ReleaseDataFlag. ReleaseDataFlag manages the deallocation of a ProcessObject's bulk output data once that data has been consumed by a downstream ProcessObject. The ReleaseDataBeforeUpdateFlag manages the deallocation/reallocation of bulk data during a pipeline update to control peak memory utilization. Default value is on.

void itk::ProcessObject::ReleaseDataFlagOff ( ) [inline, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released after being used by a downstream ProcessObject. Default value is off. Another options for controlling memory utilization is the ReleaseDataBeforeUpdateFlag.

Definition at line 257 of file itkProcessObject.h.

void itk::ProcessObject::ReleaseDataFlagOn ( ) [inline, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released after being used by a downstream ProcessObject. Default value is off. Another options for controlling memory utilization is the ReleaseDataBeforeUpdateFlag.

Definition at line 256 of file itkProcessObject.h.

virtual void itk::InPlaceImageFilter< TInputImageType , TSparseOutputImageType >::ReleaseInputs ( ) [protected, virtual, inherited]

InPlaceImageFilter may transfer ownership of the input bulk data to the output object. Once the output object owns the bulk data (done in AllocateOutputs()), the input object must release its hold on the bulk data. ProcessObject::ReleaseInputs() only releases the input bulk data when the user has set the ReleaseDataFlag. InPlaceImageFilter::ReleaseInputs() also releases the input that it has overwritten.

See also:: ProcessObject::ReleaseInputs()

Reimplemented from itk::ProcessObject.

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

virtual void itk::ProcessObject::RemoveInput ( DataObject * input ) [protected, virtual, inherited]

Protected methods for setting inputs. Subclasses make use of them for setting input.

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

virtual void itk::ProcessObject::RemoveOutput ( DataObject * output ) [protected, virtual, inherited]

Protected methods for setting outputs. Subclasses make use of them for getting output.

virtual void itk::ProcessObject::ResetPipeline ( ) [virtual, inherited]

Reset the pipeline. If an exception is thrown during an Update(), the pipeline may be in an inconsistent state. This method clears the internal state of the pipeline so Update() can be called.

virtual TimeStepType itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::ResolveTimeStep	(	const TimeStepType *	timeStepList,
		const bool *	valid,
		int	size
	)			`[protected, virtual, inherited]`

Virtual method for resolving a single time step from a set of time steps returned from processing threads.

Returns:: Time step (dt) for the iteration update based on a list of time steps generated from the threaded calculated change method (one for each region processed).

Parameters:

	timeStepList	The set of time changes compiled from all the threaded calls to ThreadedGenerateData.
	valid	The set of flags indicating which of "list" elements are valid
	size	The size of "list" and "valid"

The default is to return the minimum value in the list.

virtual void itk::ProcessObject::RestoreInputReleaseDataFlags ( ) [protected, virtual, inherited]

Restore the cached input ReleaseDataFlags.

virtual void itk::ProcessObject::SetAbortGenerateData ( bool _arg ) [virtual, inherited]

Set the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

virtual void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::SetDifferenceFunction ( FiniteDifferenceFunctionType * _arg ) [virtual, inherited]

This method sets the pointer to a FiniteDifferenceFunction object that will be used by the filter to calculate updates at image pixels.

Returns:: A FiniteDifferenceObject pointer.

virtual void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::SetElapsedIterations ( unsigned int _arg ) [protected, virtual, inherited]

Set the number of elapsed iterations of the filter.

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

virtual void itk::InPlaceImageFilter< TInputImageType , TSparseOutputImageType >::SetInPlace ( bool _arg ) [virtual, inherited]

In place operation can be turned on and off. Asking for in-place operation, i.e. calling SetInplace(true) or InplaceOn(), will be effective only if CanRunInPlace also returns true. By default CanRunInPlace checks whether the input and output image type match.

virtual void itk::ImageToImageFilter< TInputImageType , TSparseOutputImageType >::SetInput	(	unsigned	int,
		const TInputImageType *	image
	)			`[virtual, inherited]`

Set/Get the image input of this process object.

virtual void itk::ImageToImageFilter< TInputImageType , TSparseOutputImageType >::SetInput ( const InputImageType * image ) [virtual, inherited]

Set/Get the image input of this process object.

virtual void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::SetManualReinitialization ( bool _arg ) [virtual, inherited]

Require the filter to be manually reinitialized (by calling SetStateToUninitialized()

virtual void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::SetMaximumRMSError ( double _arg ) [virtual, inherited]

Set/Get the maximum error allowed in the solution. This may not be defined for all solvers and its meaning may change with the application.

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:: Set the MetaDataDictionary

virtual void itk::ProcessObject::SetNthInput	(	unsigned int	num,
		DataObject *	input
	)			`[protected, virtual, inherited]`

Protected methods for setting inputs. Subclasses make use of them for setting input.

Reimplemented in itk::ImageToVectorImageFilter< TInputImage >.

Referenced by itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryA(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryB(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetEquivalencyTable(), itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetFeatureImage(), itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetFeatureImage(), itk::WatershedImageFilter< TInputImage >::SetInput(), itk::watershed::SegmentTreeGenerator< ScalarType >::SetInputEquivalencyTable(), itk::watershed::Segmenter< InputImageType >::SetInputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetInputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetInputImage(), itk::watershed::SegmentTreeGenerator< ScalarType >::SetInputSegmentTable(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetInputSegmentTree(), itk::DiffusionTensor3DReconstructionImageFilter< TReferenceImagePixelType, TGradientImagePixelType, TTensorPixelType >::SetReferenceImage(), and itk::ChangeInformationImageFilter< TInputImage >::SetReferenceImage().

virtual void itk::ProcessObject::SetNthOutput	(	unsigned int	num,
		DataObject *	output
	)			`[protected, virtual, inherited]`

Protected methods for setting outputs. Subclasses make use of them for getting output.

Referenced by itk::watershed::BoundaryResolver< TPixelType, TDimension >::BoundaryResolver(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::EquivalenceRelabeler(), itk::watershed::Segmenter< InputImageType >::SetBoundary(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetEquivalencyTable(), itk::watershed::Segmenter< InputImageType >::SetOutputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetOutputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetOutputImage(), and itk::watershed::Segmenter< InputImageType >::SetSegmentTable().

void itk::ProcessObject::SetNumberOfInputs ( unsigned int num ) [protected, inherited]

Called to allocate the input array. Copies old inputs.

virtual void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::SetNumberOfIterations ( unsigned int _arg ) [virtual, inherited]

Set/Get the number of iterations that the filter will run.

void itk::ProcessObject::SetNumberOfOutputs ( unsigned int num ) [protected, inherited]

Called to allocate the output array. Copies old outputs.

virtual void itk::ProcessObject::SetNumberOfRequiredInputs ( unsigned int _arg ) [protected, virtual, inherited]

Protected methods for setting inputs. Subclasses make use of them for setting input.

virtual void itk::ProcessObject::SetNumberOfRequiredOutputs ( unsigned int _arg ) [protected, virtual, inherited]

Protected methods for setting outputs. Subclasses make use of them for getting output.

virtual void itk::ProcessObject::SetNumberOfThreads ( int _arg ) [virtual, inherited]

Get/Set the number of threads to create when executing.

template<class TInputImageType, class TSparseOutputImageType>

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

virtual void itk::ProcessObject::SetProgress ( float _arg ) [virtual, inherited]

Set the execution progress of a process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution. The ProgressEvent is NOT invoked.

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

virtual void itk::ProcessObject::SetReleaseDataBeforeUpdateFlag ( bool _arg ) [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released/reallocated during an Update(). In limited memory scenarios, a user may want to force the elements of a pipeline to release any bulk data that is going to be regenerated anyway during an Update() in order to control peak memory allocation. Note that this flag is different from the ReleaseDataFlag. ReleaseDataFlag manages the deallocation of a ProcessObject's bulk output data once that data has been consumed by a downstream ProcessObject. The ReleaseDataBeforeUpdateFlag manages the deallocation/reallocation of bulk data during a pipeline update to control peak memory utilization. Default value is on.

virtual void itk::ProcessObject::SetReleaseDataFlag ( bool flag ) [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released after being used by a downstream ProcessObject. Default value is off. Another options for controlling memory utilization is the ReleaseDataBeforeUpdateFlag.

virtual void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::SetRMSChange ( double _arg ) [virtual, inherited]

Set/Get the root mean squared change of the previous iteration. May not be used by all solvers.

template<class TInputImageType, class TSparseOutputImageType>

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

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

virtual void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::SetState ( FilterStateType _arg ) [virtual, inherited]

Set/Get the state of the filter.

void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::SetStateToInitialized ( ) [inline, inherited]

Set the state of the filter to INITIALIZED

Definition at line 203 of file itkFiniteDifferenceImageFilter.h.

void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::SetStateToUninitialized ( ) [inline, inherited]

Set the state of the filter to UNINITIALIZED

Definition at line 209 of file itkFiniteDifferenceImageFilter.h.

virtual void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::SetUseImageSpacing ( bool _arg ) [virtual, inherited]

Use the image spacing information in calculations. Use this option if you want derivatives in physical space. Default is UseImageSpacingOff.

virtual int itk::ImageSource< TSparseOutputImageType >::SplitRequestedRegion	(	int	i,
		int	num,
		OutputImageRegionType &	splitRegion
	)			`[protected, virtual, inherited]`

Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion". This method is called "num" times. The regions must not overlap. The method returns the number of pieces that the routine is capable of splitting the output RequestedRegion, i.e. return value is less than or equal to "num".

template<class TInputImageType, class TSparseOutputImageType>

virtual void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::ThreadedApplyUpdate	(	TimeStepType	dt,
		const ThreadRegionType &	regionToProcess,
		int	threadId
	)			`[protected, virtual]`

Multi-threaded implementation of ApplyUpdate.

template<class TInputImageType, class TSparseOutputImageType>

virtual TimeStepType itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::ThreadedCalculateChange	(	const ThreadRegionType &	regionToProcess,
		int	threadId
	)			`[protected, virtual]`

Multuthreaded implementation of CalculateChange

virtual void itk::ImageSource< TSparseOutputImageType >::ThreadedGenerateData	(	const OutputImageRegionType &	outputRegionForThread,
		int	threadId
	)			`[protected, virtual, inherited]`

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

See also:: GenerateData(), SplitRequestedRegion()

virtual bool itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::ThreadedHalt ( void * ) [inline, protected, virtual, inherited]

This method is similar to Halt(), and its default implementation in this class is simply to call Halt(). However, this method takes as a parameter a void pointer to the MultiThreader::ThreadInfoStruct structure. If you override this method instead of overriding Halt, you will be able to get the current thread ID and handle the Halt method accordingly. This is useful if you are doing a lot of processing in Halt that you don't want parallelized. Notice that ThreadedHalt is only called by the multithreaded filters, so you still should implement Halt, just in case a non-threaded filter is used.

Definition at line 303 of file itkFiniteDifferenceImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

virtual void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::ThreadedPrecalculateChange	(	const ThreadRegionType &	regionToProcess,
		int	threadId
	)			`[protected, virtual]`

Multithreaded implementation of PrecalculateChange

static ITK_THREAD_RETURN_TYPE itk::ImageSource< TSparseOutputImageType >::ThreaderCallback ( void * arg ) [static, protected, inherited]

Static function used as a "callback" by the MultiThreader. The threading library will call this routine for each thread, which will delegate the control to ThreadedGenerateData().

virtual void itk::Object::UnRegister ( ) const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

virtual void itk::ProcessObject::Update ( ) [virtual, inherited]

Bring this filter up-to-date. Update() checks modified times against last execution times, and re-executes objects if necessary. A side effect of this method is that the whole pipeline may execute in order to bring this filter up-to-date. This method updates the currently prescribed requested region. If no requested region has been set on the output, then the requested region will be set to the largest possible region. Once the requested region is set, Update() will make sure the specified requested region is up-to-date. This is a confusing side effect to users who are just calling Update() on a filter. A first call to Update() will cause the largest possible region to be updated. A second call to Update() will update that same region. If a modification to the upstream pipeline cause a filter to have a different largest possible region, this second call to Update() will not cause the output requested region to be reset to the new largest possible region. Instead, the output requested region will be the same as the last time Update() was called. To have a filter always to produce its largest possible region, users should call UpdateLargestPossibleRegion() instead.

Reimplemented in itk::CoreAtomImageToUnaryCorrespondenceMatrixProcess< TSourceImage >, itk::MedialNodePairCorrespondenceProcess< TSourceImage >, itk::MedialNodeTripletCorrespondenceProcess< TSourceImage >, itk::CoreAtomImageToDistanceMatrixProcess< TSourceImage >, itk::ImageFileWriter< TInputImage >, and itk::ImageSeriesWriter< TInputImage, TOutputImage >.

virtual void itk::ProcessObject::UpdateLargestPossibleRegion ( ) [virtual, inherited]

Like Update(), but sets the output requested region to the largest possible region for the output. This is the method users should call if they want the entire dataset to be processed. If a user wants to update the same output region as a previous call to Update() or a previous call to UpdateLargestPossibleRegion(), then they should call the method Update().

virtual void itk::ProcessObject::UpdateOutputData ( DataObject * output ) [virtual, inherited]

Actually generate new output

Reimplemented in itk::StreamingImageFilter< TInputImage, TOutputImage >.

virtual void itk::ProcessObject::UpdateOutputInformation ( ) [virtual, inherited]

Update the information decribing the output data. This method transverses up the pipeline gathering modified time information. On the way back down the pipeline, this method calls GenerateOutputInformation() to set any necessary information about the output data objects. For instance, a filter that shrinks an image will need to provide an implementation for GenerateOutputInformation() that changes the spacing of the pixels. Such filters should call their superclass' implementation of GenerateOutputInformation prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented in itk::watershed::Segmenter< TInputImage >, itk::VTKImageImport< TOutputImage >, and itk::watershed::Segmenter< InputImageType >.

void itk::ProcessObject::UpdateProgress ( float amount ) [inherited]

Update the progress of the process object.

Sets the Progress ivar to amount and invokes any observers for the ProgressEvent. The parameter amount should be in [0,1] and is the cumulative (not incremental) progress.

virtual void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::UseImageSpacingOff ( ) [virtual, inherited]

Use the image spacing information in calculations. Use this option if you want derivatives in physical space. Default is UseImageSpacingOff.

virtual void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::UseImageSpacingOn ( ) [virtual, inherited]

Use the image spacing information in calculations. Use this option if you want derivatives in physical space. Default is UseImageSpacingOff.

Member Data Documentation

unsigned int itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::m_ElapsedIterations [protected, inherited]

A counter for keeping track of the number of elapsed iterations during filtering.

Definition at line 349 of file itkFiniteDifferenceImageFilter.h.

bool itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::m_ManualReinitialization [protected, inherited]

Indicates whether the filter automatically resets to UNINITIALIZED state after completing, or whether filter must be manually reset

Definition at line 353 of file itkFiniteDifferenceImageFilter.h.

double itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::m_MaximumRMSError [protected, inherited]

Definition at line 356 of file itkFiniteDifferenceImageFilter.h.

unsigned int itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::m_NumberOfIterations [protected, inherited]

The maximum number of iterations this filter will run

Definition at line 345 of file itkFiniteDifferenceImageFilter.h.

TimeStamp itk::ProcessObject::m_OutputInformationMTime [protected, inherited]

Time when GenerateOutputInformation was last called.

Definition at line 431 of file itkProcessObject.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

double itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::m_RMSChange [protected, inherited]

Definition at line 355 of file itkFiniteDifferenceImageFilter.h.

bool itk::ProcessObject::m_Updating [protected, inherited]

These ivars are made protected so filters like itkStreamingImageFilter can access them directly. This flag indicates when the pipeline is executing. It prevents infinite recursion when pipelines have loops.

Definition at line 428 of file itkProcessObject.h.

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

itkFiniteDifferenceSparseImageFilter.h


Classes
struct	FDThreadStruct
struct	ThreadRegionType
Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
enum	FilterStateType
typedef Superclass::FiniteDifferenceFunctionType	FiniteDifferenceFunctionType
typedef SparseOutputImageType::IndexType	IndexType
Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual bool	CanRunInPlace () const
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual const FiniteDifferenceFunctionType::Pointer &	GetDifferenceFunction () const
virtual const unsigned int &	GetElapsedIterations ()
DataObjectPointerArray &	GetInputs ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
MultiThreader *	GetMultiThreader ()
virtual const char *	GetNameOfClass () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
virtual bool	GetPrecomputeFlag () const
virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
	itkStaticConstMacro (ImageDimension, unsigned int, OutputImageType::ImageDimension)
	itkStaticConstMacro (ImageDimension, unsigned int, Superclass::ImageDimension)
virtual DataObjectPointer	MakeOutput (unsigned int idx)
virtual void	Modified () const
virtual void	PrepareOutputs ()
void	Print (std::ostream &os, Indent indent=0) const
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
void	SetDebug (bool debugFlag) const
virtual void	SetDifferenceFunction (FiniteDifferenceFunctionType *_arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetPrecomputeFlag (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
void	SetSparseFunction (SparseFunctionType *sf)
void	SetStateToInitialized ()
void	SetStateToUninitialized ()
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)

unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)

virtual bool	GetInPlace () const
virtual void	InPlaceOff ()
virtual void	InPlaceOn ()
virtual void	SetInPlace (bool _arg)

const InputImageType *	GetInput (unsigned int idx)
const InputImageType *	GetInput (void)
virtual void	SetInput (unsigned int, const TInputImageType *image)
virtual void	SetInput (const InputImageType *image)

virtual const bool &	GetManualReinitialization ()
virtual void	ManualReinitializationOff ()
virtual void	ManualReinitializationOn ()
virtual void	SetManualReinitialization (bool _arg)

virtual const double &	GetMaximumRMSError ()
virtual void	SetMaximumRMSError (double _arg)

virtual const unsigned int &	GetNumberOfIterations ()
virtual void	SetNumberOfIterations (unsigned int _arg)

DataObjectPointerArraySizeType	GetNumberOfOutputs () const
DataObjectPointerArray &	GetOutputs ()

virtual const int &	GetNumberOfThreads ()
virtual void	SetNumberOfThreads (int _arg)

OutputImageType *	GetOutput (unsigned int idx)
OutputImageType *	GetOutput (void)

virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOff ()
void	ReleaseDataFlagOn ()
virtual void	SetReleaseDataFlag (bool flag)

virtual const double &	GetRMSChange ()
virtual void	SetRMSChange (double _arg)

virtual const FilterStateType &	GetState ()
virtual void	SetState (FilterStateType _arg)

virtual const bool &	GetUseImageSpacing ()
virtual void	SetUseImageSpacing (bool _arg)
virtual void	UseImageSpacingOff ()
virtual void	UseImageSpacingOn ()

	itkStaticConstMacro (OutputImageDimension, unsigned int, TSparseOutputImageType::ImageDimension)
	itkStaticConstMacro (InputImageDimension, unsigned int, TInputImageType::ImageDimension)

virtual void	PopBackInput ()
virtual void	PopFrontInput ()
virtual void	PushBackInput (const InputImageType *image)
virtual void	PushFrontInput (const InputImageType *image)
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Types
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension)>	InputToOutputRegionCopierType
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)>	OutputToInputRegionCopierType

typedef int	InternalReferenceCountType
Protected Member Functions
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	AllocateUpdateBuffer ()
virtual void	ApplyUpdate (TimeStepType dt)=0
virtual void	ApplyUpdate (TimeStepType dt)
virtual void	BeforeThreadedGenerateData ()
virtual void	CacheInputReleaseDataFlags ()
virtual TimeStepType	CalculateChange ()
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
virtual void	CopyInputToOutput ()=0
virtual NodeDataType	DataConstraint (const NodeDataType &data) const
	FiniteDifferenceSparseImageFilter ()
virtual void	GenerateData ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
int	GetSplitRegion (int i, int num, ThreadRegionType &splitRegion)
virtual bool	Halt ()
virtual void	Initialize ()
virtual void	InitializeIteration ()
virtual void	PostProcessOutput ()
virtual void	PrecalculateChange ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual TimeStepType	ResolveTimeStep (const TimeStepType timeStepList, const bool valid, int size)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetElapsedIterations (unsigned int _arg)
void	SetNumberOfInputs (unsigned int num)
void	SetNumberOfOutputs (unsigned int num)
virtual int	SplitRequestedRegion (int i, int num, OutputImageRegionType &splitRegion)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId) ITK_NO_RETURN
virtual bool	ThreadedHalt (void *)
	~FiniteDifferenceSparseImageFilter ()

virtual void	AddInput (DataObject *input)
virtual const unsigned int &	GetNumberOfRequiredInputs ()
virtual void	RemoveInput (DataObject *input)
virtual void	SetNthInput (unsigned int num, DataObject *input)
virtual void	SetNumberOfRequiredInputs (unsigned int _arg)

virtual void	AddOutput (DataObject *output)
virtual const unsigned int &	GetNumberOfRequiredOutputs ()
virtual void	RemoveOutput (DataObject *output)
virtual void	SetNthOutput (unsigned int num, DataObject *output)
virtual void	SetNumberOfRequiredOutputs (unsigned int _arg)

const DataObject *	GetInput (unsigned int idx) const

const DataObject *	GetOutput (unsigned int idx) const

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const

void	PushBackInput (const DataObject *input)
void	PushFrontInput (const DataObject *input)
Static Protected Member Functions
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
Protected Attributes
unsigned int	m_ElapsedIterations
bool	m_ManualReinitialization
double	m_MaximumRMSError
unsigned int	m_NumberOfIterations
TimeStamp	m_OutputInformationMTime
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
double	m_RMSChange
bool	m_Updating
virtual void	ThreadedApplyUpdate (TimeStepType dt, const ThreadRegionType &regionToProcess, int threadId)
static ITK_THREAD_RETURN_TYPE	ApplyUpdateThreaderCallback (void *arg)
virtual TimeStepType	ThreadedCalculateChange (const ThreadRegionType &regionToProcess, int threadId)
static ITK_THREAD_RETURN_TYPE	CalculateChangeThreaderCallback (void *arg)
virtual void	ThreadedPrecalculateChange (const ThreadRegionType &regionToProcess, int threadId)
static ITK_THREAD_RETURN_TYPE	PrecalculateChangeThreaderCallback (void *arg)

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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