#include <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, TOutputImageType >
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	OutputImagePixelType = typename Superclass::OutputImagePixelType

using	OutputImageRegionType = typename Superclass::OutputImageRegionType

using	Pointer = SmartPointer< Self >

using	Self = ImageToImageFilter

using	Superclass = ImageSource< TOutputImageType >

Public Types inherited from itk::ImageSource< TOutputImageType >
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 = TOutputImageType

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
virtual ::itk::LightObject::Pointer	CreateAnother () const

void	GenerateInputRequestedRegion () override

virtual const char *	GetNameOfClass () const

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImageType >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

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< TOutputImageType >
OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

OutputImageType *	GetOutput (unsigned int idx)

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

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

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 void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

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

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

MultiThreaderType *	GetMultiThreader () const

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	PrepareOutputs ()

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

unsigned long	AddObserver (const EventObject &event, Command *) const

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

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

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)

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

virtual int	GetReferenceCount () const

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

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImageType >
static void	SetGlobalDefaultDirectionTolerance (double)

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static double	GetGlobalDefaultCoordinateTolerance ()

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, TOutputImageType >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImageType >
static constexpr unsigned int	OutputImageDimension

bool	m_UseImageSpacing

bool	m_UseImageDirection

ImageBoundaryCondition< TInputImage, TInputImage > *	m_BoundaryCondition

virtual void	SetUseImageSpacing (bool _arg)

virtual bool	GetUseImageSpacing () const

virtual void	UseImageSpacingOn ()

virtual void	UseImageSpacingOff ()

void	OverrideBoundaryCondition (ImageBoundaryCondition< TInputImage > *boundaryCondition)

virtual void	SetUseImageDirection (bool _arg)

virtual bool	GetUseImageDirection () const

virtual void	UseImageDirectionOn ()

virtual void	UseImageDirectionOff ()

	GradientImageFilter ()

	~GradientImageFilter () override

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

void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

void	GenerateOutputInformation () override

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

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

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

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

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImageType >
void	PushBackInput (const DataObject *input) override

void	PushFrontInput (const DataObject *input) override

	ImageToImageFilter ()

	~ImageToImageFilter () override=default

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

void	VerifyInputInformation () ITKv5_CONST override

void	GenerateInputRequestedRegion () override

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

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

Protected Member Functions inherited from itk::ImageSource< TOutputImageType >
	ImageSource ()

	~ImageSource () override=default

void	GenerateData () override

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

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

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

virtual void	AfterThreadedGenerateData ()

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

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

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

virtual void	DynamicMultiThreadingOff ()

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

	~ProcessObject () override

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

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

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	AddInput (DataObject *input)

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

virtual void	SetPrimaryInput (DataObject *object)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

void	SetRequiredInputNames (const NameArray &)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

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

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

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual void	SetPrimaryOutput (DataObject *object)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

virtual void	AddOutput (DataObject *output)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

virtual void	VerifyPreconditions () ITKv5_CONST

virtual void	GenerateOutputRequestedRegion (DataObject *output)

virtual void	PropagateResetPipeline ()

virtual void	ReleaseInputs ()

virtual void	CacheInputReleaseDataFlags ()

virtual void	RestoreInputReleaseDataFlags ()

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	ThreaderUpdateProgressOff ()

virtual void	SetThreaderUpdateProgress (bool arg)

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

	~Object () override

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

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

Static Protected Member Functions inherited from itk::ImageSource< TOutputImageType >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ImageSource< TOutputImageType >
bool	m_DynamicMultiThreading

Protected Attributes inherited from itk::ProcessObject
bool	m_Updating

TimeStamp	m_OutputInformationMTime

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

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:

All ITK Sphinx Examples

Gradient Of Vector Image

Compute And Display Gradient Of Image

Examples: SphinxExamples/src/Filtering/ImageGradient/ComputeAndDisplayGradient/Code.cxx, SphinxExamples/src/Filtering/ImageGradient/GradientOfVectorImage/Code.cxx, and SphinxExamples/src/Filtering/ImageIntensity/ComputeEdgePotential/Code.cxx.

Definition at line 66 of file itkGradientImageFilter.h.

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 86 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 99 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 78 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 77 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 95 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 96 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 80 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 100 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 79 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 98 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 97 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 85 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 83 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 84 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

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.

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

overrideprotected

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

◆ CreateAnother()

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

virtual::itk::LightObject::Pointer itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::CreateAnother ( ) 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.

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

overrideprotectedvirtual

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

Reimplemented from itk::ImageSource< TOutputImageType >.

◆ 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

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.

Reimplemented from itk::ProcessObject.

◆ GetNameOfClass()

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

◆ 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

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.

◆ 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

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.

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

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.

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

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.

Definition at line 195 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.

◆ UseImageDirectionOff()

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

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

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.

◆ UseImageSpacingOff()

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

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.

◆ 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 73 of file itkGradientImageFilter.h.

◆ m_BoundaryCondition

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

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

private

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.

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

private

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.

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

private

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.

Definition at line 225 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 74 of file itkGradientImageFilter.h.

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

itkGradientImageFilter.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

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

◆ CreateAnother()

◆ DynamicThreadedGenerateData()

◆ GenerateInputRequestedRegion()

◆ GenerateOutputInformation()

◆ GetNameOfClass()

◆ GetUseImageDirection()

◆ GetUseImageSpacing()

◆ New()

◆ OverrideBoundaryCondition()

◆ PrintSelf()

◆ SetOutputPixel() [1/2]

◆ SetOutputPixel() [2/2]

◆ SetUseImageDirection()

◆ SetUseImageSpacing()

◆ UseImageDirectionOff()

◆ UseImageDirectionOn()

◆ UseImageSpacingOff()

◆ UseImageSpacingOn()

Member Data Documentation

◆ InputImageDimension

◆ m_BoundaryCondition

◆ m_UseImageDirection

◆ m_UseImageSpacing

◆ OutputImageDimension