itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType > Class Template Reference

#include <itkGradientImageFilter.h>

Inheritance diagram for itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >:

Collaboration diagram for itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef CovariantVector < OutputValueType, itkGetStaticConstMacro(OutputImageDimension) >	CovariantVectorType
typedef InputImageType::Pointer	InputImagePointer
typedef TInputImage	InputImageType
typedef InputImageType::PixelType	InputPixelType
typedef TOperatorValueType	OperatorValueType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImageType	OutputImageType
typedef OutputImageType::PixelType	OutputPixelType
typedef TOutputValueType	OutputValueType
typedef SmartPointer< Self >	Pointer
typedef GradientImageFilter	Self
typedef ImageToImageFilter < InputImageType, OutputImageType >	Superclass
Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImageType >
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::RegionType	InputImageRegionType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
Public Types inherited from itk::ImageSource< TOutputImageType >
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
Public Types inherited from itk::ProcessObject
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef std::vector < DataObjectIdentifierType >	NameArray
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual void	GenerateInputRequestedRegion () throw ( InvalidRequestedRegionError )
virtual const char *	GetNameOfClass () const
void	SetUseImageSpacingOff ()
void	SetUseImageSpacingOn ()
	typedef (Concept::Convertible< InputPixelType, OutputValueType >) InputConvertibleToOutputCheck
	typedef (Concept::HasNumericTraits< OutputValueType >) OutputHasNumericTraitsCheck
virtual void	SetUseImageSpacing (bool _arg)
virtual bool	GetUseImageSpacing () const
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImageType >
const InputImageType *	GetInput (void) const
const InputImageType *	GetInput (unsigned int idx) const
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
virtual void	PushBackInput (const InputImageType *image)
virtual void	PushFrontInput (const InputImageType *image)
virtual void	SetInput (const InputImageType *image)
virtual void	SetInput (unsigned int, const TInputImage *image)
Public Member Functions inherited from itk::ImageSource< TOutputImageType >
OutputImageType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageType *	GetOutput (void)
const OutputImageType *	GetOutput (void) const
virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () 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 (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Attributes
static const unsigned int	InputImageDimension = TInputImage::ImageDimension
static const unsigned int	OutputImageDimension = TInputImage::ImageDimension
Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImageType >
Static Public Attributes inherited from itk::ImageSource< TOutputImageType >

Protected Member Functions
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImageType >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
	ImageToImageFilter ()
virtual void	VerifyInputInformation ()
	~ImageToImageFilter ()
void	PushBackInput (const DataObject *input)
void	PushFrontInput (const DataObject *input)
Protected Member Functions inherited from itk::ImageSource< TOutputImageType >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
virtual void	GenerateData ()
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual	~ImageSource ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType	MakeNameFromIndex (DataObjectPointerArraySizeType) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Member Functions
virtual void	GenerateOutputInformation ()
	GradientImageFilter (const Self &)
void	operator= (const Self &)
template<class TValueType >
void	SetOutputPixel (ImageRegionIterator< VectorImage< TValueType, OutputImageDimension > > &it, CovariantVectorType &gradient)
template<class T >
void	SetOutputPixel (ImageRegionIterator< T > &it, CovariantVectorType &gradient)

Private Attributes
bool	m_UseImageDirection
bool	m_UseImageSpacing
virtual void	SetUseImageDirection (bool _arg)
virtual bool	GetUseImageDirection () const
virtual void	UseImageDirectionOn ()
virtual void	UseImageDirectionOff ()
	GradientImageFilter ()
virtual	~GradientImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImageType >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType

---

Detailed Description

template<class TInputImage, class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>
class itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >

Computes the gradient of an image using directional derivatives.

Computes the gradient of an image using directional derivatives. The directional derivative at each pixel location is computed by convolution with a first-order derivative operator.

The second template parameter defines the value type used in the derivative operator (defaults to float). The third template parameter defines the value type used for output image (defaults to float). The output image is defined as a covariant vector image whose value type is specified as this third template parameter.

See also:

Image

Neighborhood

NeighborhoodOperator

NeighborhoodIterator

Definition at line 60 of file itkGradientImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

typedef SmartPointer< const Self > itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImageType >.

Definition at line 83 of file itkGradientImageFilter.h.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

typedef CovariantVector< OutputValueType, itkGetStaticConstMacro(OutputImageDimension) > itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::CovariantVectorType

Definition at line 98 of file itkGradientImageFilter.h.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

typedef InputImageType::Pointer itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::InputImagePointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImageType >.

Definition at line 76 of file itkGradientImageFilter.h.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

typedef TInputImage itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::InputImageType

Convenient typedefs for simplifying declarations.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImageType >.

Definition at line 75 of file itkGradientImageFilter.h.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

typedef InputImageType::PixelType itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::InputPixelType

Image typedef support.

Definition at line 89 of file itkGradientImageFilter.h.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

typedef TOperatorValueType itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::OperatorValueType

Definition at line 93 of file itkGradientImageFilter.h.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

typedef OutputImageType::Pointer itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImageType >.

Definition at line 78 of file itkGradientImageFilter.h.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

typedef OutputImageType::RegionType itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::OutputImageRegionType

Superclass typedefs.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImageType >.

Definition at line 99 of file itkGradientImageFilter.h.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

typedef TOutputImageType itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImageType >.

Definition at line 77 of file itkGradientImageFilter.h.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

typedef OutputImageType::PixelType itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::OutputPixelType

Definition at line 95 of file itkGradientImageFilter.h.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

typedef TOutputValueType itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::OutputValueType

Definition at line 94 of file itkGradientImageFilter.h.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

typedef SmartPointer< Self > itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::Pointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImageType >.

Definition at line 82 of file itkGradientImageFilter.h.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

typedef GradientImageFilter itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::Self

Standard class typedefs.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImageType >.

Definition at line 72 of file itkGradientImageFilter.h.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

typedef ImageToImageFilter< InputImageType, OutputImageType > itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::Superclass

Standard class typedefs.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImageType >.

Definition at line 81 of file itkGradientImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::GradientImageFilter ( )

protected

End concept checking The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coodinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

virtual itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::~GradientImageFilter ( )

protectedvirtual

End concept checking The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coodinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::GradientImageFilter ( const Self &  )

private

---

Member Function Documentation

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

virtual::itk::LightObject::Pointer itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::CreateAnother ( void  ) const

virtual

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

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

virtual void itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::GenerateInputRequestedRegion ( ) throw ( InvalidRequestedRegionError )

virtual

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

See also:

ImageToImageFilter::GenerateInputRequestedRegion()

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImageType >.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

virtual void itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::GenerateOutputInformation ( )

privatevirtual

Generate the information describing 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.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

virtual const char* itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImageType >.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

virtual bool itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::GetUseImageDirection ( ) const

virtual

End concept checking The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coodinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

virtual bool itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::GetUseImageSpacing ( ) const

virtual

Set/Get whether or not the filter will use the spacing of the input image in its calculations

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

static Pointer itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::New ( )

static

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

void itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::operator= ( const Self &  )

private

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImageType >.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

void itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

protectedvirtual

End concept checking The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coodinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImageType >.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

template<class TValueType >

void itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::SetOutputPixel ( ImageRegionIterator< VectorImage< TValueType, OutputImageDimension > > &  it, CovariantVectorType &  gradient  )

inlineprivate

Definition at line 177 of file itkGradientImageFilter.h.

References itk::FixedArray< TValueType, VLength >::GetDataPointer().

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

template<class T >

void itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::SetOutputPixel ( ImageRegionIterator< T > &  it, CovariantVectorType &  gradient  )

inlineprivate

Definition at line 192 of file itkGradientImageFilter.h.

References itk::ImageConstIterator< TImage >::GetImage(), and itk::ImageRegionIterator< TImage >::Value().

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

virtual void itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::SetUseImageDirection ( bool  _arg )

virtual

End concept checking The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coodinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

virtual void itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::SetUseImageSpacing ( bool  _arg )

virtual

Set/Get whether or not the filter will use the spacing of the input image in its calculations

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

void itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::SetUseImageSpacingOff ( )

inline

Ignore the image spacing. Use this option if you want derivatives in isotropic pixel space. Default is UseImageSpacingOn.

Definition at line 117 of file itkGradientImageFilter.h.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

void itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::SetUseImageSpacingOn ( )

inline

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

Definition at line 112 of file itkGradientImageFilter.h.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

void itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread, ThreadIdType  threadId  )

protectedvirtual

GradientImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See also:

ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Reimplemented from itk::ImageSource< TOutputImageType >.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::typedef

(

Concept::Convertible< InputPixelType, OutputValueType >

)

Begin concept checking This class requires InputConvertibleToOutputCheck in the form of ( Concept::Convertible< InputPixelType, OutputValueType > )

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::typedef

(

Concept::HasNumericTraits< OutputValueType >

)

This class requires OutputHasNumericTraitsCheck in the form of ( Concept::HasNumericTraits< OutputValueType > )

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

virtual void itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::UseImageDirectionOff ( )

virtual

End concept checking The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coodinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

virtual void itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::UseImageDirectionOn ( )

virtual

End concept checking The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coodinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.

---

Member Data Documentation

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

const unsigned int itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::InputImageDimension = TInputImage::ImageDimension

static

Extract dimension from input image.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImageType >.

Definition at line 66 of file itkGradientImageFilter.h.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

bool itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::m_UseImageDirection

private

Definition at line 210 of file itkGradientImageFilter.h.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

bool itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::m_UseImageSpacing

private

Definition at line 206 of file itkGradientImageFilter.h.

template<class TInputImage , class TOperatorValueType = float, class TOutputValueType = float, class TOutputImageType = Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension >>

const unsigned int itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::OutputImageDimension = TInputImage::ImageDimension

static

Extract dimension from input image.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImageType >.

Definition at line 68 of file itkGradientImageFilter.h.

---

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

• itkGradientImageFilter.h