ITK  4.8.0
Insight Segmentation and Registration Toolkit
Classes | Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType > Class Template Reference

#include <itkFiniteDifferenceSparseImageFilter.h>

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

Detailed Description

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

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

This class implements a multi-threading mechanism for implementing finite difference PDE's on sparse image types. The sparse image is a image of pointers to node variables at valid pixel locations and null pointers at others. The node variable type must have the following members: m_Index, m_Data and m_Update.
This class also adds precomputing support to the finite difference image filter scheme. This support can be used by certain filters to speed up the processing. The m_PrecomputeFlag should be set to true to use this and the Function object must provide a PrecomputeSparseUpdate method.
INPUTS
The input to this filter is either a regular or sparse image. Subclasses should provide a way of copying this information to the output sparse image or initializing the output image nodes from the input image.
OUTPUTS
The output is a sparse image. The output will be in the m_Data members of the nodes of the sparse image.
IMPORTANT
The output sparse image type must be templated with a node type that at least has the following member variables: m_Index, m_Data and m_Update.

Definition at line 63 of file itkFiniteDifferenceSparseImageFilter.h.

Classes

struct  FDThreadStruct
 
struct  ThreadRegionType
 

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::FiniteDifferenceFunctionType 
FiniteDifferenceFunctionType
 
typedef
SparseOutputImageType::IndexType 
IndexType
 
typedef Superclass::InputImageType InputImageType
 
typedef
OutputNodeType::NodeDataType 
NodeDataType
 
typedef
SparseOutputImageType::NodeListType 
NodeListType
 
typedef
OutputNodeType::NodeValueType 
NodeValueType
 
typedef
SparseOutputImageType::NodeType 
OutputNodeType
 
typedef Superclass::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef
FiniteDifferenceSparseImageFilter 
Self
 
typedef
SparseOutputImageType::SizeType 
SizeType
 
typedef
FiniteDifferenceSparseImageFunction
< SparseOutputImageType
SparseFunctionType
 
typedef Superclass::OutputImageType SparseOutputImageType
 
typedef
FiniteDifferenceImageFilter
< TInputImageType,
TSparseOutputImageType > 
Superclass
 
typedef Superclass::TimeStepType TimeStepType
 
- Public Types inherited from itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >
typedef SmartPointer< const SelfConstPointer
 
typedef
FiniteDifferenceFunction
< TSparseOutputImageType > 
FiniteDifferenceFunctionType
 
typedef TInputImageType InputImageType
 
typedef TInputImageType::PixelType InputPixelType
 
typedef NumericTraits
< InputPixelType >::ValueType 
InputPixelValueType
 
typedef
FiniteDifferenceFunctionType::NeighborhoodScalesType 
NeighborhoodScalesType
 
typedef TSparseOutputImageType OutputImageType
 
typedef
TSparseOutputImageType::PixelType 
OutputPixelType
 
typedef NumericTraits
< OutputPixelType >::ValueType 
OutputPixelValueType
 
typedef OutputPixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef
FiniteDifferenceFunctionType::RadiusType 
RadiusType
 
typedef FiniteDifferenceImageFilter Self
 
typedef InPlaceImageFilter
< TInputImageType,
TSparseOutputImageType > 
Superclass
 
typedef
FiniteDifferenceFunctionType::TimeStepType 
TimeStepType
 
- Public Types inherited from itk::InPlaceImageFilter< TInputImageType, TSparseOutputImageType >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImageType InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImagePointer 
OutputImagePointer
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef Superclass::OutputImageType OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef InPlaceImageFilter Self
 
typedef ImageToImageFilter
< TInputImageType,
TSparseOutputImageType > 
Superclass
 
- Public Types inherited from itk::ImageToImageFilter< TInputImageType, TSparseOutputImageType >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImageType InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToImageFilter Self
 
typedef ImageSource
< TSparseOutputImageType > 
Superclass
 
- Public Types inherited from itk::ImageSource< TSparseOutputImageType >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TSparseOutputImageType OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual const char * GetNameOfClass () const
 
virtual bool GetPrecomputeFlag () const
 
virtual void SetPrecomputeFlag (bool _arg)
 
void SetSparseFunction (SparseFunctionType *sf)
 
- Public Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >
virtual const
FiniteDifferenceFunctionType::Pointer
GetDifferenceFunction () const
 
virtual const IdentifierTypeGetElapsedIterations () const
 
virtual bool GetIsInitialized ()
 
virtual void SetDifferenceFunction (FiniteDifferenceFunctionType *_arg)
 
virtual void SetIsInitialized (bool _arg)
 
void SetStateToInitialized ()
 
void SetStateToUninitialized ()
 
virtual void SetNumberOfIterations (IdentifierType _arg)
 
virtual const IdentifierTypeGetNumberOfIterations () const
 
virtual void SetUseImageSpacing (bool _arg)
 
virtual void UseImageSpacingOn ()
 
virtual void UseImageSpacingOff ()
 
virtual const bool & GetUseImageSpacing () const
 
virtual void SetMaximumRMSError (double _arg)
 
virtual const double & GetMaximumRMSError () const
 
virtual void SetRMSChange (double _arg)
 
virtual const double & GetRMSChange () const
 
virtual void SetManualReinitialization (bool _arg)
 
virtual const bool & GetManualReinitialization () const
 
virtual void ManualReinitializationOn ()
 
virtual void ManualReinitializationOff ()
 
- Public Member Functions inherited from itk::InPlaceImageFilter< TInputImageType, TSparseOutputImageType >
virtual bool CanRunInPlace () const
 
virtual void SetInPlace (bool _arg)
 
virtual bool GetInPlace () const
 
virtual void InPlaceOn ()
 
virtual void InPlaceOff ()
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImageType, TSparseOutputImageType >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
virtual void PopBackInput () override
 
virtual void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TInputImageType *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< TSparseOutputImageType >
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *output)
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Attributes

static const unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >
static const unsigned int ImageDimension
 
- Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImageType, TSparseOutputImageType >
static const unsigned int InputImageDimension
 
static const unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImageType, TSparseOutputImageType >
static const unsigned int InputImageDimension
 
static const unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TSparseOutputImageType >
static const unsigned int OutputImageDimension
 

Protected Member Functions

virtual void AllocateUpdateBuffer () override
 
virtual void ApplyUpdate (const TimeStepType &dt) override
 
virtual TimeStepType CalculateChange () override
 
virtual NodeDataType DataConstraint (const NodeDataType &data) const
 
 FiniteDifferenceSparseImageFilter ()
 
ThreadIdType GetSplitRegion (ThreadIdType i, ThreadIdType num, ThreadRegionType &splitRegion)
 
virtual void Initialize () override
 
virtual void PrecalculateChange ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void ThreadedApplyUpdate (const TimeStepType &dt, const ThreadRegionType &regionToProcess, ThreadIdType threadId)
 
virtual TimeStepType ThreadedCalculateChange (const ThreadRegionType &regionToProcess, ThreadIdType threadId)
 
virtual void ThreadedPrecalculateChange (const ThreadRegionType &regionToProcess, ThreadIdType threadId)
 
 ~FiniteDifferenceSparseImageFilter ()
 
- Protected Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >
virtual void ApplyUpdate (const TimeStepType &dt)=0
 
virtual void CopyInputToOutput ()=0
 
 FiniteDifferenceImageFilter ()
 
virtual void GenerateData () override
 
virtual void GenerateInputRequestedRegion () override
 
virtual bool Halt ()
 
virtual void InitializeIteration ()
 
virtual void PostProcessOutput ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual TimeStepType ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const std::vector< bool > &valid) const
 
virtual void SetElapsedIterations (IdentifierType _arg)
 
virtual bool ThreadedHalt (void *)
 
virtual ~FiniteDifferenceImageFilter ()
 
- Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImageType, TSparseOutputImageType >
virtual void AllocateOutputs () override
 
virtual bool GetRunningInPlace () const
 
 InPlaceImageFilter ()
 
virtual void ReleaseInputs () override
 
 ~InPlaceImageFilter ()
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImageType, TSparseOutputImageType >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
 ImageToImageFilter ()
 
virtual void VerifyInputInformation () override
 
 ~ImageToImageFilter ()
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TSparseOutputImageType >
virtual void AfterThreadedGenerateData ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual ~ImageSource ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Static Protected Member Functions

static ITK_THREAD_RETURN_TYPE ApplyUpdateThreaderCallback (void *arg)
 
static ITK_THREAD_RETURN_TYPE CalculateChangeThreaderCallback (void *arg)
 
static ITK_THREAD_RETURN_TYPE PrecalculateChangeThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ImageSource< TSparseOutputImageType >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 

Private Member Functions

 FiniteDifferenceSparseImageFilter (const Self &)
 
void operator= (const Self &)
 

Private Attributes

bool m_PrecomputeFlag
 
NodeListType::RegionListType m_RegionList
 
SparseFunctionTypem_SparseFunction
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Types inherited from itk::ImageToImageFilter< TInputImageType, TSparseOutputImageType >
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) > 
InputToOutputRegionCopierType
 
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) > 
OutputToInputRegionCopierType
 
- Protected Attributes inherited from itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >
IdentifierType m_ElapsedIterations
 
bool m_IsInitialized
 
bool m_ManualReinitialization
 
double m_MaximumRMSError
 
IdentifierType m_NumberOfIterations
 
double m_RMSChange
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

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

Definition at line 74 of file itkFiniteDifferenceSparseImageFilter.h.

template<typename TInputImageType, typename TSparseOutputImageType>
typedef Superclass::FiniteDifferenceFunctionType itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::FiniteDifferenceFunctionType

Definition at line 84 of file itkFiniteDifferenceSparseImageFilter.h.

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

Typedefs from the sparse output image type.

Definition at line 92 of file itkFiniteDifferenceSparseImageFilter.h.

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

Typedefs from the superclass

Definition at line 77 of file itkFiniteDifferenceSparseImageFilter.h.

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

The type for the data variable of OutputNodeType.

Definition at line 98 of file itkFiniteDifferenceSparseImageFilter.h.

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

Definition at line 95 of file itkFiniteDifferenceSparseImageFilter.h.

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

Definition at line 103 of file itkFiniteDifferenceSparseImageFilter.h.

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

Definition at line 94 of file itkFiniteDifferenceSparseImageFilter.h.

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

Definition at line 82 of file itkFiniteDifferenceSparseImageFilter.h.

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

Definition at line 73 of file itkFiniteDifferenceSparseImageFilter.h.

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

Standard class typedef

Definition at line 69 of file itkFiniteDifferenceSparseImageFilter.h.

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

Definition at line 93 of file itkFiniteDifferenceSparseImageFilter.h.

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

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

Definition at line 107 of file itkFiniteDifferenceSparseImageFilter.h.

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

Definition at line 81 of file itkFiniteDifferenceSparseImageFilter.h.

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

Definition at line 71 of file itkFiniteDifferenceSparseImageFilter.h.

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

Definition at line 83 of file itkFiniteDifferenceSparseImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImageType, typename TSparseOutputImageType>
itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::FiniteDifferenceSparseImageFilter ( )
protected
template<typename TInputImageType, typename TSparseOutputImageType>
itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::~FiniteDifferenceSparseImageFilter ( )
inlineprotected

Definition at line 117 of file itkFiniteDifferenceSparseImageFilter.h.

template<typename TInputImageType, typename TSparseOutputImageType>
itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::FiniteDifferenceSparseImageFilter ( const Self )
private

Member Function Documentation

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

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

Implements itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >.

Definition at line 127 of file itkFiniteDifferenceSparseImageFilter.h.

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

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

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

Multi-threaded implementation of ApplyUpdate.

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

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

Implements itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >.

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

Multuthreaded implementation of CalculateChange

template<typename TInputImageType, typename TSparseOutputImageType>
virtual NodeDataType itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::DataConstraint ( const NodeDataType data) const
inlineprotectedvirtual

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

Definition at line 131 of file itkFiniteDifferenceSparseImageFilter.h.

template<typename TInputImageType, typename TSparseOutputImageType>
virtual const char* itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::GetNameOfClass ( ) const
virtual
template<typename TInputImageType, typename TSparseOutputImageType>
virtual bool itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::GetPrecomputeFlag ( ) const
virtual
template<typename TInputImageType, typename TSparseOutputImageType>
ThreadIdType itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::GetSplitRegion ( ThreadIdType  i,
ThreadIdType  num,
ThreadRegionType splitRegion 
)
protected

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

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

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

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

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

template<typename TInputImageType, typename TSparseOutputImageType>
void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::operator= ( const Self )
private
template<typename TInputImageType, typename TSparseOutputImageType>
virtual void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::PrecalculateChange ( )
protectedvirtual

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

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

Multi-threaded implementation of PrecalculateChange

template<typename TInputImageType, typename TSparseOutputImageType>
void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

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

template<typename TInputImageType, typename TSparseOutputImageType>
virtual void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::SetPrecomputeFlag ( bool  _arg)
virtual
template<typename TInputImageType, typename TSparseOutputImageType>
void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::SetSparseFunction ( SparseFunctionType sf)

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

template<typename TInputImageType, typename TSparseOutputImageType>
virtual void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::ThreadedApplyUpdate ( const TimeStepType dt,
const ThreadRegionType regionToProcess,
ThreadIdType  threadId 
)
protectedvirtual
template<typename TInputImageType, typename TSparseOutputImageType>
virtual TimeStepType itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::ThreadedCalculateChange ( const ThreadRegionType regionToProcess,
ThreadIdType  threadId 
)
protectedvirtual
template<typename TInputImageType, typename TSparseOutputImageType>
virtual void itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::ThreadedPrecalculateChange ( const ThreadRegionType regionToProcess,
ThreadIdType  threadId 
)
protectedvirtual

Member Data Documentation

template<typename TInputImageType, typename TSparseOutputImageType>
const unsigned int itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::ImageDimension = Superclass::ImageDimension
static

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

Definition at line 89 of file itkFiniteDifferenceSparseImageFilter.h.

template<typename TInputImageType, typename TSparseOutputImageType>
bool itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::m_PrecomputeFlag
private

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

Definition at line 190 of file itkFiniteDifferenceSparseImageFilter.h.

template<typename TInputImageType, typename TSparseOutputImageType>
NodeListType::RegionListType itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::m_RegionList
private

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

Definition at line 197 of file itkFiniteDifferenceSparseImageFilter.h.

template<typename TInputImageType, typename TSparseOutputImageType>
SparseFunctionType* itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::m_SparseFunction
private

The Sparse function type.

Definition at line 193 of file itkFiniteDifferenceSparseImageFilter.h.


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