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

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
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef Superclass::InputImageType	InputImageType
typedef TInputImageType::PixelType	InputPixelType
typedef NumericTraits < InputPixelType >::ValueType	InputPixelValueType
typedef FiniteDifferenceFunctionType::NeighborhoodScalesType	NeighborhoodScalesType
typedef OutputNodeType::NodeDataType	NodeDataType
typedef SparseOutputImageType::NodeListType	NodeListType
typedef OutputNodeType::NodeValueType	NodeValueType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImagePointer	OutputImagePointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef TSparseOutputImageType	OutputImageType
typedef SparseOutputImageType::NodeType	OutputNodeType
typedef TSparseOutputImageType::PixelType	OutputPixelType
typedef NumericTraits < OutputPixelType >::ValueType	OutputPixelValueType
typedef Superclass::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef FiniteDifferenceFunctionType::RadiusType	RadiusType
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 Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
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 ()
virtual bool	GetInPlace () const
const InputImageType *	GetInput (void)
const InputImageType *	GetInput (unsigned int idx)
DataObjectPointerArray &	GetInputs ()
virtual const bool &	GetManualReinitialization ()
virtual const double &	GetMaximumRMSError ()
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
MultiThreader *	GetMultiThreader ()
virtual const char *	GetNameOfClass () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
virtual const unsigned int &	GetNumberOfIterations ()
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual const int &	GetNumberOfThreads ()
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
OutputImageType *	GetOutput (void)
OutputImageType *	GetOutput (unsigned int idx)
DataObjectPointerArray &	GetOutputs ()
virtual bool	GetPrecomputeFlag () const
virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual bool	GetReleaseDataFlag () const
virtual const double &	GetRMSChange ()
virtual const FilterStateType &	GetState ()
virtual const bool &	GetUseImageSpacing ()
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
bool	HasObserver (const EventObject &event) const
virtual void	InPlaceOff ()
virtual void	InPlaceOn ()
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual DataObjectPointer	MakeOutput (unsigned int idx)
virtual void	ManualReinitializationOff ()
virtual void	ManualReinitializationOn ()
virtual void	Modified () const
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
virtual void	PrepareOutputs ()
void	Print (std::ostream &os, Indent indent=0) const
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	PushBackInput (const InputImageType *image)
virtual void	PushFrontInput (const InputImageType *image)
virtual void	Register () const
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
void	ReleaseDataFlagOff ()
void	ReleaseDataFlagOn ()
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)
virtual void	SetInPlace (bool _arg)
virtual void	SetInput (const InputImageType *image)
virtual void	SetInput (unsigned int, const TInputImageType *image)
virtual void	SetManualReinitialization (bool _arg)
virtual void	SetMaximumRMSError (double _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetNumberOfIterations (unsigned int _arg)
virtual void	SetNumberOfThreads (int _arg)
virtual void	SetPrecomputeFlag (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual void	SetReleaseDataFlag (bool flag)
virtual void	SetRMSChange (double _arg)
void	SetSparseFunction (SparseFunctionType *sf)
virtual void	SetState (FilterStateType _arg)
void	SetStateToInitialized ()
void	SetStateToUninitialized ()
virtual void	SetUseImageSpacing (bool _arg)
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
virtual void	UseImageSpacingOff ()
virtual void	UseImageSpacingOn ()

Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)

Static Public Attributes
static const unsigned int	ImageDimension = Superclass::ImageDimension
static const unsigned int	InputImageDimension
static const unsigned int	OutputImageDimension

Protected Types
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension)>	InputToOutputRegionCopierType
typedef int	InternalReferenceCountType
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)>	OutputToInputRegionCopierType

Protected Member Functions
	FiniteDifferenceSparseImageFilter ()
	~FiniteDifferenceSparseImageFilter ()
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	AllocateUpdateBuffer ()
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
virtual void	GenerateData ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
const DataObject *	GetInput (unsigned int idx) const
virtual const unsigned int &	GetNumberOfRequiredInputs ()
virtual const unsigned int &	GetNumberOfRequiredOutputs ()
const DataObject *	GetOutput (unsigned int idx) const
int	GetSplitRegion (int i, int num, ThreadRegionType &splitRegion)
virtual bool	Halt ()
virtual void	Initialize ()
virtual void	InitializeIteration ()
virtual void	PostProcessOutput ()
virtual void	PrecalculateChange ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()
void	PushBackInput (const DataObject *input)
void	PushFrontInput (const DataObject *input)
virtual void	ReleaseInputs ()
virtual void	RemoveInput (DataObject *input)
virtual void	RemoveOutput (DataObject *output)
virtual TimeStepType	ResolveTimeStep (const TimeStepType timeStepList, const bool valid, int size)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetElapsedIterations (unsigned int _arg)
virtual void	SetNthInput (unsigned int num, DataObject *input)
virtual void	SetNthOutput (unsigned int num, DataObject *output)
void	SetNumberOfInputs (unsigned int num)
void	SetNumberOfOutputs (unsigned int num)
virtual void	SetNumberOfRequiredInputs (unsigned int _arg)
virtual void	SetNumberOfRequiredOutputs (unsigned int _arg)
virtual int	SplitRequestedRegion (int i, int num, OutputImageRegionType &splitRegion)
virtual void	ThreadedApplyUpdate (TimeStepType dt, const ThreadRegionType &regionToProcess, int threadId)
virtual TimeStepType	ThreadedCalculateChange (const ThreadRegionType &regionToProcess, int threadId)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)
virtual bool	ThreadedHalt (void *)
virtual void	ThreadedPrecalculateChange (const ThreadRegionType &regionToProcess, int threadId)

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

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

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

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 144 of file itkFiniteDifferenceImageFilter.h.

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

inherited

Definition at line 149 of file itkFiniteDifferenceImageFilter.h.

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

protectedinherited

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

Definition at line 161 of file itkImageToImageFilter.h.

typedef int itk::LightObject::InternalReferenceCountType

protectedinherited

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

Definition at line 137 of file itkLightObject.h.

typedef FiniteDifferenceFunctionType::NeighborhoodScalesType itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::NeighborhoodScalesType

inherited

Definition at line 158 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 137 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 143 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 148 of file itkFiniteDifferenceImageFilter.h.

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

protectedinherited

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

Definition at line 166 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 157 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 160 of file itkFiniteDifferenceImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImageType , class TSparseOutputImageType >

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

protected

Definition at line 26 of file itkFiniteDifferenceSparseImageFilter.txx.

template<class TInputImageType, class TSparseOutputImageType>

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

inlineprotected

Definition at line 114 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType, class TSparseOutputImageType>

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

private

Member Function Documentation

virtual void itk::ProcessObject::AbortGenerateDataOff ( )

virtualinherited

virtual void itk::ProcessObject::AbortGenerateDataOn ( )

virtualinherited

Turn on and off the AbortGenerateData flag.

void itk::ProcessObject::AddInput ( DataObject * input )

protectedvirtualinherited

Adds an input to the first null position in the input list. Expands the list memory if necessary

Reimplemented in otb::ObjectDetectionClassifier< TInputImage, TOutputVectorData, TLabel, TFunctionPrecision, TCoordRep >, otb::DescriptorsListSampleGenerator< TInputImage, TVectorData, TListSample, TLabelListSample, TOutputPrecision, TCoordRep >, otb::PersistentDescriptorsListSampleGenerator< TInputImage, TVectorData, TFunctionType, TListSample, TLabelListSample >, and otb::PersistentObjectDetectionClassifier< TInputImage, TOutputVectorData, TLabel, TFunctionType >.

Definition at line 144 of file itkProcessObject.cxx.

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)

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

Definition at line 389 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)		const

inherited

Definition at line 401 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

void itk::ProcessObject::AddOutput ( DataObject * output )

protectedvirtualinherited

Adds an output to the first null position in the output list. Expands the list memory if necessary

Definition at line 390 of file itkProcessObject.cxx.

References itk::DataObject::ConnectSource().

virtual void itk::ImageSource< TSparseOutputImageType >::AfterThreadedGenerateData ( void )

inlineprotectedvirtualinherited

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 264 of file itkImageSource.h.

virtual void itk::InPlaceImageFilter< TInputImageType , TSparseOutputImageType >::AllocateOutputs ( )

protectedvirtualinherited

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

inlineprotectedvirtual

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

Implements itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >.

Definition at line 124 of file itkFiniteDifferenceSparseImageFilter.h.

template<class TInputImageType , class TSparseOutputImageType >

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

protectedvirtual

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

Implements itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >.

Definition at line 80 of file itkFiniteDifferenceSparseImageFilter.txx.

References itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::FDThreadStruct::Filter, and itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::FDThreadStruct::TimeStep.

template<class TInputImageType , class TSparseOutputImageType >

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

staticprotected

Multi-threaded implementation of ApplyUpdate.

Definition at line 96 of file itkFiniteDifferenceSparseImageFilter.txx.

References itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::FDThreadStruct::Filter, itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::GetSplitRegion(), ITK_THREAD_RETURN_VALUE, itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::ThreadedApplyUpdate(), and itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::FDThreadStruct::TimeStep.

virtual void itk::ImageSource< TSparseOutputImageType >::BeforeThreadedGenerateData ( void )

inlineprotectedvirtualinherited

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 252 of file itkImageSource.h.

void itk::LightObject::BreakOnError ( )

staticinherited

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

Definition at line 149 of file itkLightObject.cxx.

void itk::ProcessObject::CacheInputReleaseDataFlags ( )

protectedvirtualinherited

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

Definition at line 1050 of file itkProcessObject.cxx.

template<class TInputImageType , class TSparseOutputImageType >

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

protectedvirtual

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

Implements itk::FiniteDifferenceImageFilter< TInputImageType, TSparseOutputImageType >.

Definition at line 159 of file itkFiniteDifferenceSparseImageFilter.txx.

References itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::FDThreadStruct::Filter, itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::FDThreadStruct::TimeStep, itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::FDThreadStruct::TimeStepList, and itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::FDThreadStruct::ValidTimeStepList.

template<class TInputImageType , class TSparseOutputImageType >

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

staticprotected

Multuthreaded implementation of CalculateChange

Definition at line 208 of file itkFiniteDifferenceSparseImageFilter.txx.

References itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::FDThreadStruct::Filter, itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::GetSplitRegion(), ITK_THREAD_RETURN_VALUE, itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::ThreadedCalculateChange(), itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::FDThreadStruct::TimeStepList, and itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::FDThreadStruct::ValidTimeStepList.

virtual void itk::ImageToImageFilter< TInputImageType , TSparseOutputImageType >::CallCopyInputRegionToOutputRegion	(	OutputImageRegionType &	destRegion,
		const InputImageRegionType &	srcRegion
	)

protectedvirtualinherited

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
	)

protectedvirtualinherited

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

inlinevirtualinherited

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 111 of file itkInPlaceImageFilter.h.

virtual void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::CopyInputToOutput ( )

protectedpure virtualinherited

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

LightObject::Pointer itk::Object::CreateAnother ( void ) const

virtualinherited

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.

Definition at line 231 of file itkObject.cxx.

References itk::SmartPointer< TObjectType >::GetPointer(), and itk::Object::New().

template<class TInputImageType, class TSparseOutputImageType>

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

inlineprotectedvirtual

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

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

Definition at line 128 of file itkFiniteDifferenceSparseImageFilter.h.

void itk::Object::DebugOff ( ) const

virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const

virtualinherited

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

void itk::LightObject::Delete ( )

virtualinherited

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.

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

Definition at line 88 of file itkLightObject.cxx.

virtual void itk::ProcessObject::EnlargeOutputRequestedRegion ( DataObject * )

inlinevirtualinherited

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 224 of file itkProcessObject.h.

virtual void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::GenerateData ( void )

protectedvirtualinherited

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 )

protectedvirtualinherited

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

void itk::ProcessObject::GenerateOutputInformation ( void )

protectedvirtualinherited

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.

Default implementation - copy information from first input to all outputs

Examples:: Fusion/BayesianFusionImageFilter.cxx.

Definition at line 1095 of file itkProcessObject.cxx.

Referenced by main().

void itk::ProcessObject::GenerateOutputRequestedRegion ( DataObject * output )

protectedvirtualinherited

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.

By default we set all the output requested regions to be the same.

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

Definition at line 846 of file itkProcessObject.cxx.

virtual const bool& itk::ProcessObject::GetAbortGenerateData ( )

virtualinherited

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

Referenced by itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback().

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.

Definition at line 414 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

bool itk::Object::GetDebug ( ) const

inherited

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

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

virtualinherited

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

virtualinherited

Get the number of elapsed iterations of the filter.

bool itk::Object::GetGlobalWarningDisplay ( )

staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

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

virtualinherited

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

inherited

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

inherited

Method used internally for getting an input.

Reimplemented from itk::ProcessObject.

const DataObject * itk::ProcessObject::GetInput ( unsigned int idx ) const

protectedinherited

Reimplemented in otb::AngularProjectionSetImageFilter< TInputImage, TOutputImage, TAngleList, TPrecision >, otb::SparseUnmixingImageFilter< TInputImage, TOutputImage, VNbInputImage, TPrecision, TMotherWaveletOperator >, otb::AngularProjectionImageFilter< TInputImage, TOutputImage, TAngleArray, TPrecision >, otb::LabeledSampleLocalizationGenerator< TVectorData >, otb::ConcatenateVectorDataFilter< TVectorData >, itk::MeshToMeshFilter< TInputMesh, TOutputMesh >, and itk::MeshToMeshFilter< TInput, TOutput >.

Definition at line 482 of file itkProcessObject.cxx.

References NULL.

DataObjectPointerArray& itk::ProcessObject::GetInputs ( )

inlineinherited

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.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

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

virtualinherited

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

virtualinherited

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void )

inherited

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 532 of file itkObject.cxx.

References NULL.

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void ) const

inherited

Returns:: A constant reference to this objects MetaDataDictionary.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 543 of file itkObject.cxx.

References NULL.

unsigned long itk::Object::GetMTime ( void ) const

virtualinherited

Return this objects modified time.

Return the modification for this object.

Definition at line 286 of file itkObject.cxx.

Referenced by itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< TDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime(), otb::Function::NoStretchRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), itk::VTKImageExportBase::PipelineModifiedCallback(), and itk::ProcessObject::UpdateOutputInformation().

MultiThreader* itk::ProcessObject::GetMultiThreader ( )

inlineinherited

Return the multithreader used by this class.

Definition at line 280 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

inlineinherited

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.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

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

virtualinherited

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfOutputs ( ) const

inlineinherited

Reimplemented in otb::ImageSeriesFileReaderBase< TImage, TInternalImage >, otb::ImageSeriesFileReaderBase< VectorImage< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >, otb::ImageSeriesFileReaderBase< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >, and otb::ImageSeriesFileReaderBase< Image< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >.

Definition at line 135 of file itkProcessObject.h.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredInputs ( )

protectedvirtualinherited

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredOutputs ( )

protectedvirtualinherited

virtual const int& itk::ProcessObject::GetNumberOfThreads ( )

virtualinherited

Referenced by itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::SplitRequestedRegion().

ProcessObject::DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfValidRequiredInputs ( ) const

virtualinherited

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.

Get the number of specified inputs

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

Definition at line 112 of file itkProcessObject.cxx.

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.

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

inherited

Method used internally for getting an output.

Reimplemented from itk::ProcessObject.

const DataObject * itk::ProcessObject::GetOutput ( unsigned int idx ) const

protectedinherited

Definition at line 454 of file itkProcessObject.cxx.

References NULL.

DataObjectPointerArray& itk::ProcessObject::GetOutputs ( )

inlineinherited

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.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

template<class TInputImageType, class TSparseOutputImageType>

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

virtual

virtual const float& itk::ProcessObject::GetProgress ( )

virtualinherited

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::WatershedMiniPipelineProgressCommand::Execute(), otb::StreamingImageVirtualWriter< TInputImage >::ObserveSourceFilterProgress(), otb::ImageFileWriter< TInputImage >::ObserveSourceFilterProgress(), itk::LaplacianRecursiveGaussianImageFilter< TInputImage, TOutputImage >::ReportProgress(), and itk::XMLFilterWatcher::ShowProgress().

virtual int itk::LightObject::GetReferenceCount ( ) const

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

virtual const bool& itk::ProcessObject::GetReleaseDataBeforeUpdateFlag ( )

virtualinherited

bool itk::ProcessObject::GetReleaseDataFlag ( ) const

virtualinherited

Definition at line 512 of file itkProcessObject.cxx.

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

virtualinherited

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.

Definition at line 68 of file itkFiniteDifferenceSparseImageFilter.txx.

References itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::ThreadRegionType::first, and itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::ThreadRegionType::last.

Referenced by itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::ApplyUpdateThreaderCallback(), itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::CalculateChangeThreaderCallback(), and itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::PrecalculateChangeThreaderCallback().

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

virtualinherited

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

virtualinherited

static void itk::Object::GlobalWarningDisplayOff ( )

inlinestaticinherited

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

Referenced by itk::OutputWindow::DisplayText(), itk::Win32OutputWindow::PromptText(), and itk::Win32OutputWindow::WndProc().

static void itk::Object::GlobalWarningDisplayOn ( )

inlinestaticinherited

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

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

virtualinherited

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 )

virtualinherited

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

protectedvirtualinherited

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.

Definition at line 467 of file itkObject.cxx.

template<class TInputImageType , class TSparseOutputImageType >

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

protectedvirtual

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

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

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

Definition at line 53 of file itkFiniteDifferenceSparseImageFilter.txx.

virtual void itk::FiniteDifferenceImageFilter< TInputImageType , TSparseOutputImageType >::InitializeIteration ( )

inlineprotectedvirtualinherited

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 299 of file itkFiniteDifferenceImageFilter.h.

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

virtualinherited

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

virtualinherited

void itk::Object::InvokeEvent ( const EventObject & event )

inherited

Call Execute on all the Commands observing this event id.

Definition at line 446 of file itkObject.cxx.

Referenced by otb::Wrapper::Application::AddProcess(), itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback(), and itk::VTKImageExportBase::UpdateDataCallback().

void itk::Object::InvokeEvent ( const EventObject & event ) const

inherited

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

Definition at line 457 of file itkObject.cxx.

virtual DataObjectPointer itk::ImageSource< TSparseOutputImageType >::MakeOutput ( unsigned int idx )

virtualinherited

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

virtualinherited

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

virtualinherited

void itk::Object::Modified ( void ) const

virtualinherited

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

Make sure this object's modified time is greater than all others.

Definition at line 297 of file itkObject.cxx.

Object::Pointer itk::Object::New ( void )

staticinherited

Method for creation through the object factory.

Reimplemented from itk::LightObject.

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private 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

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