Image filter which provides a B-spline output approximation. More...

#include <itkBSplineScatteredDataPointSetToImageFilter.h>

Inheritance diagram for itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >:

Collaboration diagram for itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef ImageType::PointType	ContinuousIndexType
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef TOutputImage::DirectionType	DirectionType
typedef TOutputImage	ImageType
typedef ImageType::IndexType	IndexType
typedef InputPointSetType::ConstPointer	InputPointSetConstPointer
typedef InputPointSetType::Pointer	InputPointSetPointer
typedef TInputPointSet	InputPointSetType
typedef BSplineKernelFunction< 0 >	KernelOrder0Type
typedef BSplineKernelFunction< 1 >	KernelOrder1Type
typedef BSplineKernelFunction< 2 >	KernelOrder2Type
typedef BSplineKernelFunction< 3 >	KernelOrder3Type
typedef CoxDeBoorBSplineKernelFunction< 3 >	KernelType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef ImageType::PixelType	PixelType
typedef PointSetType::PointDataContainer	PointDataContainerType
typedef PointSetType::PixelType	PointDataType
typedef SmartPointer< Self >	Pointer
typedef TInputPointSet	PointSetType
typedef PointSetType::PointType	PointType
typedef ImageType::RegionType	RegionType
typedef BSplineScatteredDataPointSetToImageFilter	Self
typedef ImageType::SizeType	SizeType
typedef TOutputImage::SpacingType	SpacingType
typedef PointSetToImageFilter < TInputPointSet, TOutputImage >	Superclass
typedef OutputImageType::ValueType	ValueType


typedef float	RealType
typedef VectorContainer < unsigned, RealType >	WeightsContainerType
typedef Image< PointDataType, itkGetStaticConstMacro(ImageDimension)>	PointDataImageType
typedef PointDataImageType::Pointer	PointDataImagePointer
typedef Image< RealType, itkGetStaticConstMacro(ImageDimension)>	RealImageType
typedef RealImageType::Pointer	RealImagePointer
typedef FixedArray< unsigned, itkGetStaticConstMacro(ImageDimension)>	ArrayType
typedef VariableSizeMatrix < RealType >	GradientType
Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
void	Evaluate (PointType, PointDataType &)
void	EvaluateGradient (PointType, GradientType &)
virtual void	GenerateOutputImageOff ()
virtual void	GenerateOutputImageOn ()
virtual const bool &	GetAbortGenerateData ()
Command *	GetCommand (unsigned long tag)
virtual const ArrayType &	GetCurrentNumberOfControlPoints ()
bool	GetDebug () const
virtual const bool &	GetGenerateOutputImage ()
DataObjectPointerArray &	GetInputs ()
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
MultiThreader *	GetMultiThreader ()
virtual const char *	GetNameOfClass () const
virtual const ArrayType &	GetNumberOfControlPoints ()
DataObjectPointerArraySizeType	GetNumberOfInputs () const
virtual const ArrayType &	GetNumberOfLevels ()
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
virtual const PointType &	GetOrigin ()
virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
virtual const SpacingType &	GetSpacing ()
virtual const ArrayType &	GetSplineOrder ()
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual DataObjectPointer	MakeOutput (unsigned int idx)
virtual void	Modified () const
virtual void	PrepareOutputs ()
void	Print (std::ostream &os, Indent indent=0) const
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
void	SetDebug (bool debugFlag) const
virtual void	SetGenerateOutputImage (bool _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetNumberOfControlPoints (ArrayType _arg)
void	SetNumberOfLevels (unsigned int)
void	SetNumberOfLevels (ArrayType)
void	SetPointWeights (WeightsContainerType *weights)
virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
void	SetSplineOrder (ArrayType)
void	SetSplineOrder (unsigned int)
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)


virtual void	SetCloseDimension (ArrayType _arg)
virtual const ArrayType &	GetCloseDimension ()


virtual void	SetPhiLattice (PointDataImagePointer _arg)
virtual PointDataImagePointer	GetPhiLattice () const


void	EvaluateAtPoint (PointType, PointDataType &)
void	EvaluateAtIndex (IndexType, PointDataType &)
void	EvaluateAtContinuousIndex (ContinuousIndexType, PointDataType &)


void	EvaluateGradientAtPoint (PointType, GradientType &)
void	EvaluateGradientAtIndex (IndexType, GradientType &)
void	EvaluateGradientAtContinuousIndex (ContinuousIndexType, GradientType &)


virtual void	SetInput (const InputPointSetType *pointset)
virtual void	SetInput (unsigned int, const InputPointSetType *pointset)
const InputPointSetType *	GetInput (void)
const InputPointSetType *	GetInput (unsigned int idx)


virtual void	SetSpacing (SpacingType _arg)
virtual void	SetSpacing (const double *spacing)
virtual void	SetSpacing (const float *spacing)


virtual void	SetDirection (DirectionType _arg)
virtual const DirectionType &	GetDirection ()


virtual void	SetOrigin (PointType _arg)
virtual void	SetOrigin (const double *origin)
virtual void	SetOrigin (const float *origin)


virtual void	SetInsideValue (ValueType _arg)
virtual ValueType	GetInsideValue () const


virtual void	SetOutsideValue (ValueType _arg)
virtual ValueType	GetOutsideValue () const


virtual void	SetSize (SizeType _arg)
virtual SizeType	GetSize () const


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


DataObjectPointerArray &	GetOutputs ()
DataObjectPointerArraySizeType	GetNumberOfOutputs () const


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


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


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


unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()


static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
Static Public Attributes
static const unsigned int	ImageDimension = TOutputImage::ImageDimension


static const unsigned int	InputPointSetDimension = InputPointSetType::PointDimension
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Protected Types


typedef int	InternalReferenceCountType
Protected Member Functions
virtual void	AllocateOutputs ()
	BSplineScatteredDataPointSetToImageFilter ()
virtual void	CacheInputReleaseDataFlags ()
void	GenerateData ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RestoreInputReleaseDataFlags ()
void	SetNumberOfInputs (unsigned int num)
void	SetNumberOfOutputs (unsigned int num)
virtual int	SplitRequestedRegion (int i, int num, OutputImageRegionType &splitRegion)
int	SplitRequestedRegion (int, int, RegionType &)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId) ITK_NO_RETURN
virtual	~BSplineScatteredDataPointSetToImageFilter ()


void	ThreadedGenerateData (const RegionType &, int)
void	BeforeThreadedGenerateData ()
void	AfterThreadedGenerateData ()


const DataObject *	GetInput (unsigned int idx) const


const DataObject *	GetOutput (unsigned int idx) const


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


virtual void	PushBackInput (const DataObject *input)
virtual void	PopBackInput ()
virtual void	PushFrontInput (const DataObject *input)
virtual void	PopFrontInput ()


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


virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Static Protected Member Functions
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
Protected Attributes
DirectionType	m_Direction
ValueType	m_InsideValue
PointType	m_Origin
TimeStamp	m_OutputInformationMTime
ValueType	m_OutsideValue
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
SizeType	m_Size
SpacingType	m_Spacing
bool	m_Updating

Detailed Description

template<class TInputPointSet, class TOutputImage>
class itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >

Image filter which provides a B-spline output approximation.

Given an n-D image with scattered data, this filter finds a fast approximation to that irregularly spaced data using uniform B-splines. The traditional method of inverting the observation matrix to find a least-squares fit is made obsolete. Therefore, memory issues are not a concern and inverting large matrices is not applicable. In addition, this allows fitting to be multi-threaded. This class generalizes from Lee's original paper to encompass n-D data in m-D parametric space and any *feasible* B-spline order as well as the option of specifying a confidence value for each point.

In addition to specifying the input point set, one must specify the number of control points. The specified number of control points must be > m_SplineOrder. If one wishes to use the multilevel component of this algorithm, one must also specify the number of levels in the hierarchy. If this is desired, the number of control points becomes the number of control points for the coarsest level. The algorithm then increases the number of control points at each level so that the B-spline n-D grid is refined to twice the previous level.

Author:: Nicholas J. Tustison

Contributed by Nicholas J. Tustison, James C. Gee in the Insight Journal paper: http://hdl.handle.net/1926/140

REFERENCE: S. Lee, G. Wolberg, and S. Y. Shin, "Scattered Data Interpolation with Multilevel B-Splines", IEEE Transactions on Visualization and Computer Graphics, 3(3):228-244, 1997.

REFERENCE: N.J. Tustison and J.C. Gee, "Generalized n-D C^k Scattered Data Approximation with COnfidence Values", Proceedings of the MIAR conference, August 2006.

Definition at line 72 of file itkBSplineScatteredDataPointSetToImageFilter.h.

Member Typedef Documentation

template<class TInputPointSet , class TOutputImage >

typedef FixedArray<unsigned, itkGetStaticConstMacro( ImageDimension )> itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::ArrayType

Other typedef

Definition at line 114 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef SmartPointer<const Self> itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::ConstPointer

Reimplemented from itk::PointSetToImageFilter< TInputPointSet, TOutputImage >.

Definition at line 80 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef ImageType::PointType itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::ContinuousIndexType

Definition at line 97 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TOutputImage>

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

Smart Pointer type to a DataObject.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::BayesianClassifierImageFilter< TInputVectorImage, TLabelsType, TPosteriorsPrecisionType, TPriorsPrecisionType >, itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::MinimumMaximumImageFilter< TInputImage >, itk::SignedDanielssonDistanceMapImageFilter< TInputImage, TOutputImage >, itk::StatisticsImageFilter< TInputImage >, itk::StreamingImageFilter< TInputImage, TOutputImage >, itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >, and itk::MultiScaleHessianBasedMeasureImageFilter< TInputImage, THessianImage, TOutputImage >.

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 TInputPointSet , class TOutputImage >

typedef TOutputImage::DirectionType itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::DirectionType [inherited]

Definition at line 69 of file itkPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef VariableSizeMatrix<RealType> itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::GradientType

Other typedef

Definition at line 115 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef TOutputImage itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::ImageType

Definition at line 89 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef ImageType::IndexType itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::IndexType

Definition at line 96 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef InputPointSetType::ConstPointer itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::InputPointSetConstPointer [inherited]

Definition at line 58 of file itkPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef InputPointSetType::Pointer itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::InputPointSetPointer [inherited]

Definition at line 57 of file itkPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef TInputPointSet itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::InputPointSetType [inherited]

Some convenient typedefs.

Definition at line 56 of file itkPointSetToImageFilter.h.

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

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

Definition at line 139 of file itkLightObject.h.

template<class TInputPointSet , class TOutputImage >

typedef BSplineKernelFunction<0> itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::KernelOrder0Type

Definition at line 122 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef BSplineKernelFunction<1> itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::KernelOrder1Type

Definition at line 123 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef BSplineKernelFunction<2> itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::KernelOrder2Type

Definition at line 124 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef BSplineKernelFunction<3> itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::KernelOrder3Type

Definition at line 125 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef CoxDeBoorBSplineKernelFunction<3> itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::KernelType

Interpolation kernel type (default spline order = 3)

Definition at line 121 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TOutputImage>

typedef OutputImageType::PixelType itk::ImageSource< TOutputImage >::OutputImagePixelType [inherited]

Definition at line 71 of file itkImageSource.h.

template<class TInputPointSet , class TOutputImage >

typedef OutputImageType::Pointer itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::OutputImagePointer [inherited]

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 43 of file itkPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef Superclass::OutputImageRegionType itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::OutputImageRegionType [inherited]

Superclass typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 50 of file itkPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef TOutputImage itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::OutputImageType [inherited]

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 42 of file itkPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef ImageType::PixelType itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::PixelType

Image typedef support.

Definition at line 93 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef PointSetType::PointDataContainer itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::PointDataContainerType

Definition at line 102 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef PointDataImageType::Pointer itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::PointDataImagePointer

Other typedef

Definition at line 109 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef Image<PointDataType, itkGetStaticConstMacro( ImageDimension )> itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::PointDataImageType

Other typedef

Definition at line 108 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef PointSetType::PixelType itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::PointDataType

Definition at line 101 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef SmartPointer<Self> itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::Pointer

Reimplemented from itk::PointSetToImageFilter< TInputPointSet, TOutputImage >.

Definition at line 79 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef TInputPointSet itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::PointSetType

Definition at line 90 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef PointSetType::PointType itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::PointType

PointSet typedef support.

Reimplemented from itk::PointSetToImageFilter< TInputPointSet, TOutputImage >.

Definition at line 100 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef RealImageType::Pointer itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::RealImagePointer

Other typedef

Definition at line 112 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef Image<RealType, itkGetStaticConstMacro( ImageDimension )> itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::RealImageType

Other typedef

Definition at line 111 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef float itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::RealType

Other typedef

Definition at line 105 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef ImageType::RegionType itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::RegionType

Definition at line 94 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef BSplineScatteredDataPointSetToImageFilter itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::Self

Standard class typedefs.

Reimplemented from itk::PointSetToImageFilter< TInputPointSet, TOutputImage >.

Definition at line 76 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef ImageType::SizeType itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::SizeType

Reimplemented from itk::PointSetToImageFilter< TInputPointSet, TOutputImage >.

Definition at line 95 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef TOutputImage::SpacingType itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::SpacingType [inherited]

Image spacing and origin typedefs

Definition at line 68 of file itkPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef PointSetToImageFilter<TInputPointSet, TOutputImage> itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::Superclass

Reimplemented from itk::PointSetToImageFilter< TInputPointSet, TOutputImage >.

Definition at line 78 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef OutputImageType::ValueType itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::ValueType [inherited]

Definition at line 44 of file itkPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

typedef VectorContainer<unsigned, RealType> itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::WeightsContainerType

Other typedef

Definition at line 106 of file itkBSplineScatteredDataPointSetToImageFilter.h.

Constructor & Destructor Documentation

template<class TInputPointSet , class TOutputImage >

itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::BSplineScatteredDataPointSetToImageFilter ( ) [protected]

template<class TInputPointSet , class TOutputImage >

virtual itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::~BSplineScatteredDataPointSetToImageFilter ( ) [protected, virtual]

Member Function Documentation

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

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

Turn on and off the AbortGenerateData flag.

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

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

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

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

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

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

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

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

template<class TInputPointSet , class TOutputImage >

void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::AfterThreadedGenerateData ( ) [protected, virtual]

Multithreaded function which generates the control point lattice.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::AllocateOutputs ( ) [protected, virtual, inherited]

The GenerateData method normally allocates the buffers for all of the outputs of a filter. Some filters may want to override this default behavior. For example, a filter may have multiple outputs with varying resolution. Or a filter may want to process data in place by grafting its input to its output.

template<class TInputPointSet , class TOutputImage >

void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::BeforeThreadedGenerateData ( ) [protected, virtual]

Multithreaded function which generates the control point lattice.

Reimplemented from itk::ImageSource< TOutputImage >.

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

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

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

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

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

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

Reimplemented from itk::LightObject.

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

Turn debugging output off.

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

Turn debugging output on.

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

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

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

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

Definition at line 225 of file itkProcessObject.h.

template<class TInputPointSet , class TOutputImage >

void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::Evaluate	(	PointType	,
		PointDataType &
	)

Evaluate the resulting B-spline object at a specified parametric point. Note that the parameterization over each dimension of the B-spline object is [0, 1].

template<class TInputPointSet , class TOutputImage >

void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::EvaluateAtContinuousIndex	(	ContinuousIndexType	,
		PointDataType &
	)

Evaluate the resulting B-spline object at a specified point or index within the image domain.

template<class TInputPointSet , class TOutputImage >

void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::EvaluateAtIndex	(	IndexType	,
		PointDataType &
	)

Evaluate the resulting B-spline object at a specified point or index within the image domain.

template<class TInputPointSet , class TOutputImage >

void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::EvaluateAtPoint	(	PointType	,
		PointDataType &
	)

Evaluate the resulting B-spline object at a specified point or index within the image domain.

template<class TInputPointSet , class TOutputImage >

void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::EvaluateGradient	(	PointType	,
		GradientType &
	)

Evaluate the gradient of the resulting B-spline object at a specified parametric point. Note that the parameterization over each dimension of the B-spline object is [0, 1].

template<class TInputPointSet , class TOutputImage >

void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::EvaluateGradientAtContinuousIndex	(	ContinuousIndexType	,
		GradientType &
	)

Evaluate the gradient of the resulting B-spline object at a specified point or index within the image domain.

template<class TInputPointSet , class TOutputImage >

void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::EvaluateGradientAtIndex	(	IndexType	,
		GradientType &
	)

Evaluate the gradient of the resulting B-spline object at a specified point or index within the image domain.

template<class TInputPointSet , class TOutputImage >

void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::EvaluateGradientAtPoint	(	PointType	,
		GradientType &
	)

Evaluate the gradient of the resulting B-spline object at a specified point or index within the image domain.

template<class TInputPointSet , class TOutputImage >

void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::GenerateData ( ) [protected, virtual]

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See also:: ThreadedGenerateData()

Reimplemented from itk::PointSetToImageFilter< TInputPointSet, TOutputImage >.

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

What is the input requested region that is required to produce the output requested region? By default, the largest possible region is always required but this is overridden in many subclasses. For instance, for an image processing filter where an output pixel is a simple function of an input pixel, the input requested region will be set to the output requested region. For an image processing filter where an output pixel is a function of the pixels in a neighborhood of an input pixel, then the input requested region will need to be larger than the output requested region (to avoid introducing artificial boundary conditions). This function should never request an input region that is outside the the input largest possible region (i.e. implementations of this method should crop the input requested region at the boundaries of the input largest possible region).

template<class TInputPointSet , class TOutputImage >

virtual void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::GenerateOutputImageOff ( ) [virtual]

template<class TInputPointSet , class TOutputImage >

virtual void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::GenerateOutputImageOn ( ) [virtual]

template<class TInputPointSet , class TOutputImage >

virtual void itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::GenerateOutputInformation ( ) [inline, protected, virtual, inherited]

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

Reimplemented from itk::ProcessObject.

Definition at line 145 of file itkPointSetToImageFilter.h.

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

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

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

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

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

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

template<class TInputPointSet , class TOutputImage >

virtual const ArrayType& itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::GetCloseDimension ( ) [virtual]

This array of 0/1 values defines whether a particular dimension of the parametric space is to be considered periodic or not. For example, if you are using interpolating along a 1D closed curve, the array type will have size 1, and you should set the first element of this array to the value "1". In the case that you were interpolating in a planar surface with cylindrical topology, the array type will have two components, and you should set to "1" the component that goes around the cylinder, and set to "0" the component that goes from the top of the cylinder to the bottom. This will indicate the periodity of that parameter to the filter. Internally, in order to make periodic the domain of the parameter, the filter will reuse some of the points at the beginning of the domain as if they were also located at the end of the domain. The number of points to be reused will depend on the spline order. As a user, you don't need to replicate the points, the filter will do this for you.

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.

template<class TInputPointSet , class TOutputImage >

virtual const ArrayType& itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::GetCurrentNumberOfControlPoints ( ) [virtual]

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

Get the value of the debug flag.

template<class TInputPointSet , class TOutputImage >

virtual const DirectionType& itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::GetDirection ( ) [virtual, inherited]

Get/Set the direction of the image. The direction is the relationship of the grid to physical coordinates.

template<class TInputPointSet , class TOutputImage >

virtual const bool& itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::GetGenerateOutputImage ( ) [virtual]

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

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

template<class TInputPointSet , class TOutputImage >

const InputPointSetType* itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::GetInput ( void ) [inherited]

Set/Get the input point-set of this process object.

template<class TInputPointSet , class TOutputImage >

const InputPointSetType* itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::GetInput ( unsigned int idx ) [inherited]

Set/Get the input point-set of this process object.

Reimplemented from itk::ProcessObject.

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

Method used internally for getting an input.

Reimplemented in itk::MeshToMeshFilter< TInputMesh, TOutputMesh >, and itk::MeshToMeshFilter< TInput, TOutput >.

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

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

Definition at line 108 of file itkProcessObject.h.

template<class TInputPointSet , class TOutputImage >

virtual ValueType itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::GetInsideValue ( ) const [virtual, inherited]

Set/Get the value for pixels in the point-set. By default, this filter will return an image that contains values from the point-set specified as input. If this "inside" value is changed to a non-null value, the output produced by this filter will be a mask with inside/outside values specified by the user.

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

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

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

Returns:: A constant reference to this objects MetaDataDictionary.

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

Return this objects modified time.

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

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

Return the multithreader used by this class.

Definition at line 284 of file itkProcessObject.h.

template<class TInputPointSet , class TOutputImage >

virtual const char* itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::GetNameOfClass ( ) const [virtual, inherited]

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputPointSet , class TOutputImage >

virtual const ArrayType& itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::GetNumberOfControlPoints ( ) [virtual]

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

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

Definition at line 118 of file itkProcessObject.h.

template<class TInputPointSet , class TOutputImage >

virtual const ArrayType& itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::GetNumberOfLevels ( ) [virtual]

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

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

Definition at line 135 of file itkProcessObject.h.

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

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

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

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

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

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

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

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

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

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

template<class TInputPointSet , class TOutputImage >

virtual const PointType& itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::GetOrigin ( ) [virtual, inherited]

Get the origin of the image. The origin is the geometric coordinates of the index (0,0). The value returned is a pointer to a double array. For ImageBase and Image, the default origin is 0.

template<class TOutputImage>

OutputImageType* itk::ImageSource< TOutputImage >::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.

template<class TOutputImage>

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

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

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

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

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

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

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

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

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

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

Reimplemented from itk::ProcessObject.

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

Method used internally for getting an output.

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

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

Definition at line 133 of file itkProcessObject.h.

template<class TInputPointSet , class TOutputImage >

virtual ValueType itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::GetOutsideValue ( ) const [virtual, inherited]

Set/Get the value for pixels outside the point-set. By default, this filter will return an image that contains values from the point specified as input. If this "outside" value is changed to a non-null value, the output produced by this filter will be a mask with inside/outside values specified by the user.

template<class TInputPointSet , class TOutputImage >

virtual PointDataImagePointer itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::GetPhiLattice ( ) const [virtual]

Get the control point lattice.

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

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

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

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

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

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

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

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

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

template<class TInputPointSet , class TOutputImage >

virtual SizeType itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::GetSize ( ) const [virtual, inherited]

Set/Get Size

template<class TInputPointSet , class TOutputImage >

virtual const SpacingType& itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::GetSpacing ( ) [virtual, inherited]

Get the spacing (size of a pixel) of the image. The spacing is the geometric distance between image samples. The value returned is a pointer to a double array. For ImageBase and Image, the default data spacing is unity.

template<class TInputPointSet , class TOutputImage >

virtual const ArrayType& itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::GetSplineOrder ( ) [virtual]

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

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

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

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

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

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

template<class TOutputImage>

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

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

template<class TOutputImage>

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

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

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

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

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

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

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

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

Return true if an observer is registered for this event.

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

Call Execute on all the Commands observing this event id.

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

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

template<class TOutputImage>

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

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

Reimplemented from itk::ProcessObject.

Reimplemented in itk::BayesianClassifierImageFilter< TInputVectorImage, TLabelsType, TPosteriorsPrecisionType, TPriorsPrecisionType >, itk::EigenAnalysis2DImageFilter< TInputImage, TEigenValueImage, TEigenVectorImage >, itk::MinimumMaximumImageFilter< TInputImage >, itk::SignedDanielssonDistanceMapImageFilter< TInputImage, TOutputImage >, itk::StatisticsImageFilter< TInputImage >, itk::MaskedMovingHistogramImageFilter< TInputImage, TMaskImage, TOutputImage, TKernel, THistogram >, itk::MultiScaleHessianBasedMeasureImageFilter< TInputImage, THessianImage, TOutputImage >, and itk::MaskedMovingHistogramImageFilter< TInputImage, TMaskImage, TOutputImage, TKernel, MaskedRankHistogram< TInputImage::PixelType > >.

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

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

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

template<class TInputPointSet , class TOutputImage >

static Pointer itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::PointSetToImageFilter< TInputPointSet, TOutputImage >.

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

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

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

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

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

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

Reimplemented in itk::WatershedImageFilter< TInputImage >.

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

Cause the object to print itself out.

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

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

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

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

template<class TInputPointSet , class TOutputImage >

void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual]`

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

Reimplemented from itk::PointSetToImageFilter< TInputPointSet, TOutputImage >.

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

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

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

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

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

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

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

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

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

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

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

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

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

Reimplemented from itk::LightObject.

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

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

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

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

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

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

Definition at line 257 of file itkProcessObject.h.

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

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

Definition at line 256 of file itkProcessObject.h.

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

A filter may need to release its input's bulk data after it has finished calculating a new output. The filter may need to release the inputs because the user has turned on the ReleaseDataFlag or it may need to release the inputs because the filter is an "in place" filter and it has overwritten its input with its output data. The implementation here simply checks the ReleaseDataFlag of the inputs. InPlaceImageFilter overrides this method so release the input it has overwritten.

See also:: InPlaceImageFilter::ReleaseInputs()

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

Remove all observers .

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

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

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

Remove the observer with this tag value.

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

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

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

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

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

Restore the cached input ReleaseDataFlags.

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

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

template<class TInputPointSet , class TOutputImage >

virtual void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::SetCloseDimension ( ArrayType _arg ) [virtual]

This array of 0/1 values defines whether a particular dimension of the parametric space is to be considered periodic or not. For example, if you are using interpolating along a 1D closed curve, the array type will have size 1, and you should set the first element of this array to the value "1". In the case that you were interpolating in a planar surface with cylindrical topology, the array type will have two components, and you should set to "1" the component that goes around the cylinder, and set to "0" the component that goes from the top of the cylinder to the bottom. This will indicate the periodity of that parameter to the filter. Internally, in order to make periodic the domain of the parameter, the filter will reuse some of the points at the beginning of the domain as if they were also located at the end of the domain. The number of points to be reused will depend on the spline order. As a user, you don't need to replicate the points, the filter will do this for you.

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

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

template<class TInputPointSet , class TOutputImage >

virtual void itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::SetDirection ( DirectionType _arg ) [virtual, inherited]

Get/Set the direction of the image. The direction is the relationship of the grid to physical coordinates.

template<class TInputPointSet , class TOutputImage >

virtual void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::SetGenerateOutputImage ( bool _arg ) [virtual]

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

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

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

template<class TInputPointSet , class TOutputImage >

virtual void itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::SetInput	(	unsigned	int,
		const InputPointSetType *	pointset
	)			`[virtual, inherited]`

Set/Get the input point-set of this process object.

template<class TInputPointSet , class TOutputImage >

virtual void itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::SetInput ( const InputPointSetType * pointset ) [virtual, inherited]

Set/Get the input point-set of this process object.

template<class TInputPointSet , class TOutputImage >

virtual void itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::SetInsideValue ( ValueType _arg ) [virtual, inherited]

Set/Get the value for pixels in the point-set. By default, this filter will return an image that contains values from the point-set specified as input. If this "inside" value is changed to a non-null value, the output produced by this filter will be a mask with inside/outside values specified by the user.

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

Returns:: Set the MetaDataDictionary

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

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

Reimplemented in itk::ImageToVectorImageFilter< TInputImage >.

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

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

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

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

template<class TInputPointSet , class TOutputImage >

virtual void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::SetNumberOfControlPoints ( ArrayType _arg ) [virtual]

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

Called to allocate the input array. Copies old inputs.

template<class TInputPointSet , class TOutputImage >

void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::SetNumberOfLevels ( unsigned int )

Helper functions

template<class TInputPointSet , class TOutputImage >

void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::SetNumberOfLevels ( ArrayType )

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

Called to allocate the output array. Copies old outputs.

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

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

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

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

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

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

template<class TInputPointSet , class TOutputImage >

virtual void itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::SetOrigin ( const float * origin ) [virtual, inherited]

Set the origin of the image. The origin is the geometric coordinates of the image origin. It is stored internally as double but may be set from float.

See also:: GetOrigin()

template<class TInputPointSet , class TOutputImage >

virtual void itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::SetOrigin ( PointType _arg ) [virtual, inherited]

Set the origin of the image. The origin is the geometric coordinates of the image origin. It is stored internally as double but may be set from float.

See also:: GetOrigin()

template<class TInputPointSet , class TOutputImage >

virtual void itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::SetOrigin ( const double * origin ) [virtual, inherited]

Set the origin of the image. The origin is the geometric coordinates of the image origin. It is stored internally as double but may be set from float.

See also:: GetOrigin()

template<class TInputPointSet , class TOutputImage >

virtual void itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::SetOutsideValue ( ValueType _arg ) [virtual, inherited]

Set/Get the value for pixels outside the point-set. By default, this filter will return an image that contains values from the point specified as input. If this "outside" value is changed to a non-null value, the output produced by this filter will be a mask with inside/outside values specified by the user.

template<class TInputPointSet , class TOutputImage >

virtual void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::SetPhiLattice ( PointDataImagePointer _arg ) [virtual]

Get the control point lattice.

template<class TInputPointSet , class TOutputImage >

void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::SetPointWeights ( WeightsContainerType * weights )

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

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

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

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

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

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

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

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

template<class TInputPointSet , class TOutputImage >

virtual void itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::SetSize ( SizeType _arg ) [virtual, inherited]

Set/Get Size

template<class TInputPointSet , class TOutputImage >

virtual void itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::SetSpacing ( const float * spacing ) [virtual, inherited]

Set the spacing (size of a pixel) of the image. The spacing is the geometric distance between image samples. It is stored internally as double, but may be set from float.

See also:: GetSpacing()

template<class TInputPointSet , class TOutputImage >

virtual void itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::SetSpacing ( const double * spacing ) [virtual, inherited]

Set the spacing (size of a pixel) of the image. The spacing is the geometric distance between image samples. It is stored internally as double, but may be set from float.

See also:: GetSpacing()

template<class TInputPointSet , class TOutputImage >

virtual void itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::SetSpacing ( SpacingType _arg ) [virtual, inherited]

Set the spacing (size of a pixel) of the image. The spacing is the geometric distance between image samples. It is stored internally as double, but may be set from float.

See also:: GetSpacing()

template<class TInputPointSet , class TOutputImage >

void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::SetSplineOrder ( ArrayType )

template<class TInputPointSet , class TOutputImage >

void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::SetSplineOrder ( unsigned int )

template<class TOutputImage>

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

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

template<class TInputPointSet , class TOutputImage >

int itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::SplitRequestedRegion	(	int	,
		int	,
		RegionType &
	)			`[inline, protected]`

Only the points are divided among the threads, so always return a valid number

Definition at line 218 of file itkBSplineScatteredDataPointSetToImageFilter.h.

References itk::ProcessObject::GetNumberOfThreads().

template<class TOutputImage>

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

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

See also:: GenerateData(), SplitRequestedRegion()

template<class TInputPointSet , class TOutputImage >

void itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::ThreadedGenerateData	(	const RegionType &	,
		int
	)			`[protected]`

Multithreaded function which generates the control point lattice.

template<class TOutputImage>

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

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

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

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

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

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

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

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

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

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

Actually generate new output

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

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

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

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

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

Update the progress of the process object.

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

Member Data Documentation

template<class TInputPointSet , class TOutputImage >

const unsigned int itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::ImageDimension = TOutputImage::ImageDimension [static]

Extract dimension from input and output image.

Definition at line 87 of file itkBSplineScatteredDataPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

const unsigned int itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::InputPointSetDimension = InputPointSetType::PointDimension [static, inherited]

Dimension constants

Definition at line 62 of file itkPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

DirectionType itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::m_Direction [protected, inherited]

Definition at line 151 of file itkPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

ValueType itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::m_InsideValue [protected, inherited]

Definition at line 152 of file itkPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

PointType itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::m_Origin [protected, inherited]

Definition at line 149 of file itkPointSetToImageFilter.h.

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

Time when GenerateOutputInformation was last called.

Definition at line 431 of file itkProcessObject.h.

template<class TInputPointSet , class TOutputImage >

ValueType itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::m_OutsideValue [protected, inherited]

Definition at line 153 of file itkPointSetToImageFilter.h.

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

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

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

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

template<class TInputPointSet , class TOutputImage >

SizeType itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::m_Size [protected, inherited]

Definition at line 148 of file itkPointSetToImageFilter.h.

template<class TInputPointSet , class TOutputImage >

SpacingType itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::m_Spacing [protected, inherited]

Definition at line 150 of file itkPointSetToImageFilter.h.

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

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

Definition at line 428 of file itkProcessObject.h.

template<class TInputPointSet , class TOutputImage >

const unsigned int itk::PointSetToImageFilter< TInputPointSet, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension [static, inherited]

Dimension constants

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 64 of file itkPointSetToImageFilter.h.

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

itkBSplineScatteredDataPointSetToImageFilter.h

itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage > Class Template Reference

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

template<class TInputPointSet, class TOutputImage> class itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TInputPointSet, class TOutputImage>
class itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >