itk::DerivativeImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkDerivativeImageFilter.h>

Inheritance diagram for itk::DerivativeImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::DerivativeImageFilter< TInputImage, TOutputImage >:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
typedef TInputImage::InternalPixelType	InputInternalPixelType
typedef TInputImage::PixelType	InputPixelType
typedef TOutputImage	OutputImageType
typedef TOutputImage::InternalPixelType	OutputInternalPixelType
typedef TOutputImage::PixelType	OutputPixelType
typedef SmartPointer< Self >	Pointer
typedef DerivativeImageFilter	Self
typedef ImageToImageFilter < TInputImage, TOutputImage >	Superclass
Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
Public Types inherited from itk::ImageSource< TOutputImage >
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef OutputImageType::Pointer	OutputImagePointer
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::Signed< OutputPixelType >) SignedOutputPixelType
virtual void	SetOrder (unsigned int _arg)
virtual unsigned int	GetOrder () const
virtual void	SetDirection (unsigned int _arg)
virtual unsigned int	GetDirection () const
virtual void	SetUseImageSpacing (bool _arg)
virtual bool	GetUseImageSpacing () const
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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< TOutputImage >
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	ImageDimension = TOutputImage::ImageDimension
Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static const unsigned int	InputImageDimension = TInputImage::ImageDimension
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Static Public Attributes inherited from itk::ImageSource< TOutputImage >

Protected Member Functions
	DerivativeImageFilter ()
void	GenerateData ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~DerivativeImageFilter ()
Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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< TOutputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual	~ImageSource ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateOutputInformation ()
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
	DerivativeImageFilter (const Self &)
void	operator= (const Self &)

Private Attributes
unsigned int	m_Direction
unsigned int	m_Order
bool	m_UseImageSpacing

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

---

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::DerivativeImageFilter< TInputImage, TOutputImage >

Computes the directional derivative of an image. The directional derivative at each pixel location is computed by convolution with a derivative operator of user-specified order.

SetOrder specifies the order of the derivative.

SetDirection specifies the direction of the derivative with respect to the coordinate axes of the image.

See also:

Image

Neighborhood

NeighborhoodOperator

NeighborhoodIterator

Wiki Examples:

• All Examples

• Compute the derivative of an image in a particular direction

Examples:

itkOrthogonalSwath2DPathFilterTest.cxx.

Definition at line 48 of file itkDerivativeImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage , class TOutputImage >

typedef SmartPointer< const Self > itk::DerivativeImageFilter< TInputImage, TOutputImage >::ConstPointer

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

Definition at line 56 of file itkDerivativeImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TInputImage itk::DerivativeImageFilter< TInputImage, TOutputImage >::InputImageType

Image typedef support.

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

Definition at line 71 of file itkDerivativeImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TInputImage::InternalPixelType itk::DerivativeImageFilter< TInputImage, TOutputImage >::InputInternalPixelType

Definition at line 63 of file itkDerivativeImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TInputImage::PixelType itk::DerivativeImageFilter< TInputImage, TOutputImage >::InputPixelType

Definition at line 62 of file itkDerivativeImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TOutputImage itk::DerivativeImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 72 of file itkDerivativeImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TOutputImage::InternalPixelType itk::DerivativeImageFilter< TInputImage, TOutputImage >::OutputInternalPixelType

Definition at line 61 of file itkDerivativeImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TOutputImage::PixelType itk::DerivativeImageFilter< TInputImage, TOutputImage >::OutputPixelType

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Definition at line 60 of file itkDerivativeImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef SmartPointer< Self > itk::DerivativeImageFilter< TInputImage, TOutputImage >::Pointer

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

Definition at line 55 of file itkDerivativeImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef DerivativeImageFilter itk::DerivativeImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

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

Definition at line 53 of file itkDerivativeImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef ImageToImageFilter< TInputImage, TOutputImage > itk::DerivativeImageFilter< TInputImage, TOutputImage >::Superclass

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

Definition at line 54 of file itkDerivativeImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >

itk::DerivativeImageFilter< TInputImage, TOutputImage >::DerivativeImageFilter ( )

inlineprotected

Definition at line 124 of file itkDerivativeImageFilter.h.

template<class TInputImage , class TOutputImage >

virtual itk::DerivativeImageFilter< TInputImage, TOutputImage >::~DerivativeImageFilter ( )

inlineprotectedvirtual

Definition at line 131 of file itkDerivativeImageFilter.h.

template<class TInputImage , class TOutputImage >

itk::DerivativeImageFilter< TInputImage, TOutputImage >::DerivativeImageFilter ( const Self &  )

private

---

Member Function Documentation

template<class TInputImage , class TOutputImage >

virtual::itk::LightObject::Pointer itk::DerivativeImageFilter< TInputImage, TOutputImage >::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 TOutputImage >

void itk::DerivativeImageFilter< TInputImage, TOutputImage >::GenerateData ( )

protectedvirtual

Standard pipeline method. While this class does not implement a ThreadedGenerateData(), its GenerateData() delegates all calculations to an NeighborhoodOperatorImageFilter. Since the NeighborhoodOperatorImageFilter is multithreaded, this filter is multithreaded by default.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage >

virtual void itk::DerivativeImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( ) throw ( InvalidRequestedRegionError )

virtual

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

See also:

ImageToImageFilter::GenerateInputRequestedRegion()

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

template<class TInputImage , class TOutputImage >

virtual unsigned int itk::DerivativeImageFilter< TInputImage, TOutputImage >::GetDirection ( ) const

virtual

End concept checking Standard get/set macros for filter parameters.

template<class TInputImage , class TOutputImage >

virtual const char* itk::DerivativeImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

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

template<class TInputImage , class TOutputImage >

virtual unsigned int itk::DerivativeImageFilter< TInputImage, TOutputImage >::GetOrder ( ) const

virtual

End concept checking Standard get/set macros for filter parameters.

template<class TInputImage , class TOutputImage >

virtual bool itk::DerivativeImageFilter< TInputImage, TOutputImage >::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 TOutputImage >

static Pointer itk::DerivativeImageFilter< TInputImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputImage , class TOutputImage >

void itk::DerivativeImageFilter< TInputImage, TOutputImage >::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, TOutputImage >.

template<class TInputImage , class TOutputImage >

void itk::DerivativeImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

protectedvirtual

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::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

virtual void itk::DerivativeImageFilter< TInputImage, TOutputImage >::SetDirection ( unsigned int  _arg )

virtual

End concept checking Standard get/set macros for filter parameters.

template<class TInputImage , class TOutputImage >

virtual void itk::DerivativeImageFilter< TInputImage, TOutputImage >::SetOrder ( unsigned int  _arg )

virtual

End concept checking Standard get/set macros for filter parameters.

template<class TInputImage , class TOutputImage >

virtual void itk::DerivativeImageFilter< TInputImage, TOutputImage >::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 TOutputImage >

void itk::DerivativeImageFilter< TInputImage, TOutputImage >::SetUseImageSpacingOff ( )

inline

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

Definition at line 104 of file itkDerivativeImageFilter.h.

template<class TInputImage , class TOutputImage >

void itk::DerivativeImageFilter< TInputImage, TOutputImage >::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 99 of file itkDerivativeImageFilter.h.

template<class TInputImage , class TOutputImage >

itk::DerivativeImageFilter< TInputImage, TOutputImage >::typedef

(

Concept::Signed< OutputPixelType >

)

The output pixel type must be signed. Begin concept checking This class requires SignedOutputPixelType in the form of ( Concept::Signed< OutputPixelType > )

---

Member Data Documentation

template<class TInputImage , class TOutputImage >

const unsigned int itk::DerivativeImageFilter< TInputImage, TOutputImage >::ImageDimension = TOutputImage::ImageDimension

static

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Definition at line 68 of file itkDerivativeImageFilter.h.

template<class TInputImage , class TOutputImage >

unsigned int itk::DerivativeImageFilter< TInputImage, TOutputImage >::m_Direction

private

The direction of the derivative.

Definition at line 149 of file itkDerivativeImageFilter.h.

template<class TInputImage , class TOutputImage >

unsigned int itk::DerivativeImageFilter< TInputImage, TOutputImage >::m_Order

private

The order of the derivative.

Definition at line 146 of file itkDerivativeImageFilter.h.

template<class TInputImage , class TOutputImage >

bool itk::DerivativeImageFilter< TInputImage, TOutputImage >::m_UseImageSpacing

private

Definition at line 151 of file itkDerivativeImageFilter.h.

---

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

• itkDerivativeImageFilter.h