#include <itkGradientImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOperatorValueType = float, typename TOutputValueType = float, typename 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

ITK Sphinx Examples:

<a href=
<a href=
<a href=

Definition at line 68 of file itkGradientImageFilter.h.

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	CovariantVectorType = CovariantVector< OutputValueType, Self::OutputImageDimension >

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageType = TInputImage

using	InputPixelType = typename InputImageType::PixelType

using	OperatorValueType = TOperatorValueType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImageType

using	OutputPixelType = typename OutputImageType::PixelType

using	OutputValueType = TOutputValueType

using	Pointer = SmartPointer< Self >

using	Self = GradientImageFilter

using	Superclass = ImageToImageFilter< InputImageType, OutputImageType >

Public Types inherited from itk::ImageToImageFilter< TInputImage, Image< CovariantVector< float, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
using	ConstPointer = SmartPointer< const Self >

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageToImageFilter

using	Superclass = ImageSource< Image< CovariantVector< float, TInputImage::ImageDimension >, TInputImage::ImageDimension > >

Public Types inherited from itk::ImageSource< Image< CovariantVector< float, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = Image< CovariantVector< float, TInputImage::ImageDimension >, TInputImage::ImageDimension >

using	Pointer = SmartPointer< Self >

using	Self = ImageSource

using	Superclass = ProcessObject

Public Types inherited from itk::ProcessObject
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
void	GenerateInputRequestedRegion () override

const char *	GetNameOfClass () const override

void	OverrideBoundaryCondition (ImageBoundaryCondition< TInputImage > *boundaryCondition)


virtual void	SetUseImageSpacing (bool _arg)

virtual bool	GetUseImageSpacing () const

virtual void	UseImageSpacingOn ()


virtual void	SetUseImageDirection (bool _arg)

virtual bool	GetUseImageDirection () const

virtual void	UseImageDirectionOn ()

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, Image< CovariantVector< float, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

const char *	GetNameOfClass () const override

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (unsigned int, const TInputImage *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< Image< CovariantVector< float, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
const char *	GetNameOfClass () const override

OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, Image< CovariantVector< float, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImageType::ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, Image< CovariantVector< float, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< Image< CovariantVector< float, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
static constexpr unsigned int	OutputImageDimension

Protected Member Functions
void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

	GradientImageFilter ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	~GradientImageFilter () override=default

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, Image< CovariantVector< float, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

void	PrintSelf (std::ostream &os, Indent indent) const override

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

Protected Member Functions inherited from itk::ImageSource< Image< CovariantVector< float, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateData ()

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

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 idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation () const

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintSelf (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Member Functions
void	GenerateOutputInformation () override

template<typename T >
void	SetOutputPixel (ImageRegionIterator< T > &it, CovariantVectorType &gradient)

template<typename TValue >
void	SetOutputPixel (ImageRegionIterator< VectorImage< TValue, OutputImageDimension > > &it, CovariantVectorType &gradient)

Private Attributes
std::unique_ptr< ImageBoundaryCondition< TInputImage, TInputImage > >	m_BoundaryCondition

bool	m_UseImageDirection { true }

bool	m_UseImageSpacing { true }

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, Image< CovariantVector< float, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

Static Protected Member Functions inherited from itk::ImageSource< Image< CovariantVector< float, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ImageSource< Image< CovariantVector< float, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
bool	m_DynamicMultiThreading

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

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

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

Definition at line 88 of file itkGradientImageFilter.h.

◆ CovariantVectorType

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

using itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::CovariantVectorType = CovariantVector<OutputValueType, Self::OutputImageDimension>

Definition at line 101 of file itkGradientImageFilter.h.

◆ InputImagePointer

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

using itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::InputImagePointer = typename InputImageType::Pointer

Definition at line 80 of file itkGradientImageFilter.h.

◆ InputImageType

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

using itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::InputImageType = TInputImage

Convenient type alias for simplifying declarations.

Definition at line 79 of file itkGradientImageFilter.h.

◆ InputPixelType

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

using itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::InputPixelType = typename InputImageType::PixelType

Image type alias support

Definition at line 97 of file itkGradientImageFilter.h.

◆ OperatorValueType

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

using itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::OperatorValueType = TOperatorValueType

Definition at line 98 of file itkGradientImageFilter.h.

◆ OutputImagePointer

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

using itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 82 of file itkGradientImageFilter.h.

◆ OutputImageRegionType

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

using itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 102 of file itkGradientImageFilter.h.

◆ OutputImageType

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

using itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::OutputImageType = TOutputImageType

Definition at line 81 of file itkGradientImageFilter.h.

◆ OutputPixelType

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

using itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::OutputPixelType = typename OutputImageType::PixelType

Definition at line 100 of file itkGradientImageFilter.h.

◆ OutputValueType

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

using itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::OutputValueType = TOutputValueType

Definition at line 99 of file itkGradientImageFilter.h.

◆ Pointer

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

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

Definition at line 87 of file itkGradientImageFilter.h.

◆ Self

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

using itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::Self = GradientImageFilter

Standard class type aliases.

Definition at line 85 of file itkGradientImageFilter.h.

◆ Superclass

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

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

Definition at line 86 of file itkGradientImageFilter.h.

Constructor & Destructor Documentation

◆ GradientImageFilter()

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

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

protected

◆ ~GradientImageFilter()

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

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

overrideprotecteddefault

Member Function Documentation

◆ DynamicThreadedGenerateData()

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

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

overrideprotected

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

See also: ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

◆ GenerateInputRequestedRegion()

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

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

overridevirtual

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

◆ GenerateOutputInformation()

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

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

overrideprivatevirtual

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.

◆ GetNameOfClass()

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

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

◆ GetUseImageDirection()

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

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

virtual

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

◆ GetUseImageSpacing()

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float, typename 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. Use On to take the image spacing information into account and to compute the derivatives in physical space; use Off to ignore the image spacing and to compute the derivatives in isotropic voxel space. Default is On.

◆ New()

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float, typename 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.

◆ OverrideBoundaryCondition()

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

void itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::OverrideBoundaryCondition ( ImageBoundaryCondition< TInputImage > * boundaryCondition )

Allows to change the default boundary condition

◆ PrintSelf()

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

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

overrideprotectedvirtual

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

Reimplemented from itk::ProcessObject.

◆ SetOutputPixel() [1/2]

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

template<typename T >

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

inlineprivate

Definition at line 213 of file itkGradientImageFilter.h.

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

◆ SetOutputPixel() [2/2]

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

template<typename TValue >

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

inlineprivate

Definition at line 197 of file itkGradientImageFilter.h.

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

◆ SetUseImageDirection()

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

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

virtual

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

◆ SetUseImageSpacing()

template<typename TInputImage , typename TOperatorValueType = float, typename TOutputValueType = float, typename 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. Use On to take the image spacing information into account and to compute the derivatives in physical space; use Off to ignore the image spacing and to compute the derivatives in isotropic voxel space. Default is On.

◆ UseImageDirectionOn()

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

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

virtual

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

◆ UseImageSpacingOn()

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

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

virtual

Set/Get whether or not the filter will use the spacing of the input image in its calculations. Use On to take the image spacing information into account and to compute the derivatives in physical space; use Off to ignore the image spacing and to compute the derivatives in isotropic voxel space. Default is On.

Member Data Documentation

◆ InputImageDimension

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

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

staticconstexpr

Extract dimension from input image.

Definition at line 75 of file itkGradientImageFilter.h.

◆ m_BoundaryCondition

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

std::unique_ptr<ImageBoundaryCondition<TInputImage, TInputImage> > itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::m_BoundaryCondition

private

Initial value:

{
    std::make_unique<ZeroFluxNeumannBoundaryCondition<TInputImage>>()
  }

Definition at line 234 of file itkGradientImageFilter.h.

◆ m_UseImageDirection

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

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

private

Definition at line 231 of file itkGradientImageFilter.h.

◆ m_UseImageSpacing

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

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

private

Definition at line 227 of file itkGradientImageFilter.h.

◆ OutputImageDimension

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

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

staticconstexpr

Definition at line 76 of file itkGradientImageFilter.h.

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

itkGradientImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ CovariantVectorType

◆ InputImagePointer

◆ InputImageType

◆ InputPixelType

◆ OperatorValueType

◆ OutputImagePointer

◆ OutputImageRegionType

◆ OutputImageType

◆ OutputPixelType

◆ OutputValueType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ GradientImageFilter()

◆ ~GradientImageFilter()

Member Function Documentation

◆ DynamicThreadedGenerateData()

◆ GenerateInputRequestedRegion()

◆ GenerateOutputInformation()

◆ GetNameOfClass()

◆ GetUseImageDirection()

◆ GetUseImageSpacing()

◆ New()

◆ OverrideBoundaryCondition()

◆ PrintSelf()

◆ SetOutputPixel() [1/2]

◆ SetOutputPixel() [2/2]

◆ SetUseImageDirection()

◆ SetUseImageSpacing()

◆ UseImageDirectionOn()

◆ UseImageSpacingOn()

Member Data Documentation

◆ InputImageDimension

◆ m_BoundaryCondition

◆ m_UseImageDirection

◆ m_UseImageSpacing

◆ OutputImageDimension