ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage > Class Template Reference

#include <itkVectorGradientMagnitudeImageFilter.h>

+ Inheritance diagram for itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >:
+ Collaboration diagram for itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >:

Public Types

using ConstNeighborhoodIteratorType = ConstNeighborhoodIterator< RealVectorImageType >
 
using ConstPointer = SmartPointer< const Self >
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageType = TInputImage
 
using InputPixelType = typename TInputImage::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using OutputImageType = TOutputImage
 
using OutputPixelType = typename TOutputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename ConstNeighborhoodIteratorType::RadiusType
 
using RealType = TRealType
 
using RealVectorImageType = Image< RealVectorType, TInputImage::ImageDimension >
 
using RealVectorType = Vector< TRealType, InputPixelType::Dimension >
 
using Self = VectorGradientMagnitudeImageFilter
 
using Superclass = ImageToImageFilter< TInputImage, TOutputImage >
 
using WeightsType = FixedArray< TRealType, VectorDimension >
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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< TOutputImage >
 
- Public Types inherited from itk::ImageSource< TOutputImage >
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 = TOutputImage
 
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
 
virtual bool GetUseImageSpacing () const
 
void SetUseImageSpacing (bool)
 
void SetUseImageSpacingOff ()
 
void SetUseImageSpacingOn ()
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetInput (const InputImageType *image)
 
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< TOutputImage >
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
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 flag)
 
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 ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () 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
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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
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 Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension
 
static constexpr unsigned int VectorDimension = InputPixelType::Dimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
using ImageBaseType = typename InputImageType::Superclass
 
WeightsType m_DerivativeWeights
 
WeightsType m_ComponentWeights
 
WeightsType m_SqrtComponentWeights
 
bool m_UseImageSpacing
 
bool m_UsePrincipleComponents
 
ThreadIdType m_RequestedNumberOfThreads
 
RealVectorImageType::ConstPointer m_RealValuedInputImage
 
static int CubicSolver (double *, double *)
 
virtual void SetDerivativeWeights (WeightsType _arg)
 
virtual const WeightsTypeGetDerivativeWeights () const
 
virtual void SetComponentWeights (WeightsType _arg)
 
virtual const WeightsTypeGetComponentWeights () const
 
virtual void SetUsePrincipleComponents (bool _arg)
 
virtual bool GetUsePrincipleComponents () const
 
void SetUsePrincipleComponentsOn ()
 
void SetUsePrincipleComponentsOff ()
 
 VectorGradientMagnitudeImageFilter ()
 
 ~VectorGradientMagnitudeImageFilter () override=default
 
void BeforeThreadedGenerateData () override
 
void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual const RealVectorImageTypeGetRealValuedInputImage () const
 
TRealType NonPCEvaluateAtNeighborhood (const ConstNeighborhoodIteratorType &it) const
 
TRealType EvaluateAtNeighborhood3D (const ConstNeighborhoodIteratorType &it) const
 
TRealType EvaluateAtNeighborhood (const ConstNeighborhoodIteratorType &it) const
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override=default
 
void VerifyInputInformation () ITKv5_CONST override
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
 ImageSource ()
 
 ~ImageSource () override=default
 
void GenerateData () override
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual void AllocateOutputs ()
 
virtual void AfterThreadedGenerateData ()
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () 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
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () 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)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () 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 GenerateOutputInformation ()
 
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 &time)
 
- 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< TOutputImage >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
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< TOutputImage >
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 TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
class itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >

Computes a scalar, gradient magnitude image from a multiple channel (pixels are vectors) input.

Constraints
The filter requires an image with at least two dimensions and a vector length of at least 2. The theory supports extension to scalar images, but the implementation of the itk vector classes do not

The template parameter TRealType must be floating point (float or double) or a user-defined "real" numerical type with arithmetic operations defined sufficient to compute derivatives.

Performance
This filter will automatically multithread if run with SetUsePrincipleComponents=Off or on 3D data in UsePrincipleComponents=On mode. Unfortunately the ND eigen solver used is not thread safe (a special 3D solver is), so it cannot multithread for data other than 3D in UsePrincipleComponents=On mode.
References

[1] G. Sapiro and D. Ringach, "Anisotropic Diffusion of Multivalued Images with Application to Color Filtering," IEEE Transactions on Image Processing, Vol 5, No. 11 pp. 1582-1586, 1996

See also
Image
Neighborhood
NeighborhoodOperator
NeighborhoodIterator
Overview
This filter has two calculation modes. The first (default) mode calculates gradient magnitude as the difference between the largest two singular values in a singular value decomposition (SVD) of the partial derivatives [1]. The gradient is then based on the direction of maximal change, and is a characterization of how "elongated" the point-spread of the analysis is found to be.

The second, more heuristic, calculation mode finds gradient magnitude as the square-root of the sum of the * individual weighted vector component derivative sums squared. That is, * $ \mathbf{magnitude} = \left( \sum_{i=0}^n \sum_{j=0}^m \frac{\delta * \phi_j}{\delta \mathbf{x}_{i}}^2 \right)^{\frac{1}{2}} $, where $\phi_j$ * is the $j^{\mathbf{th}}$ channel of vector image $\phi$ of dimension $n$. * Weighting terms are applied to each vector component.

The second mode is computationally much faster than the first and has the advantage that it is automatically multi-threaded (some vnl functions used in the first mode are not thread-safe). The first mode, however, tends to give intuitively better results with less (or no) parameter tuning.

Template Parameters (Input and Output)
This filter has one required template parameter which defines the input image type. The pixel type of the input image is assumed to be a vector (e.g., itk::Vector, itk::FixedArray). The scalar type of the vector components must be castable to floating point. Instantiating with an image of RGBPixel is not allowed but the image can be converted/adapted to Vector for processing.

The second template parameter, TRealType, can be optionally specified to define the scalar numerical type used in calculations. This is the component type of the output image. The default type of TRealType is float. For extra precision, you may safely change this parameter to double.

The third template parameter is the output image type. The third parameter will be automatically constructed from the first and second parameters, so it is not necessary (or advisable) to set this parameter explicitly. Given an M-channel input image with dimensionality N, and a numerical type specified as TRealType, the output image will be of type itk::Image<TRealType, N>.

Filter Parameters
The methods Set/GetUsePrincipleComponents and SetUsePrincipleComponentsOn/Off determine controls the calculation mode that is used.

The method SetUseImageSpacingOn will cause derivatives in the image to be scaled (inversely) with the pixel size of the input image, effectively taking derivatives in world coordinates (versus isotropic image space). SetUseImageSpacingOff turns this functionality off. Default is UseImageSpacingOn. The parameter UseImageSpacing can be set directly with the method SetUseImageSpacing(bool).

Weights can be applied to the derivatives directly using the SetDerivativeWeights method. Note that if UseImageSpacing is set to TRUE (ON), then these weights will be overridden by weights derived from the image spacing when the filter is updated. The argument to this method is a C array of TRealValue type.

Weights can be applied to each vector component of the image when the component derivative values are summed during computation. Specify these weights using the SetComponentWeights method. The argument to this method is a C array of TRealValue type.

Examples
Examples/IO/VisibleHumanPasteWrite.cxx, and Examples/Segmentation/WatershedSegmentation1.cxx.

Definition at line 138 of file itkVectorGradientMagnitudeImageFilter.h.

Member Typedef Documentation

◆ ConstNeighborhoodIteratorType

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
using itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::ConstNeighborhoodIteratorType = ConstNeighborhoodIterator<RealVectorImageType>

Type of the iterator that will be used to move through the image. Also the type which will be passed to the evaluate function

Definition at line 179 of file itkVectorGradientMagnitudeImageFilter.h.

◆ ConstPointer

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
using itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 147 of file itkVectorGradientMagnitudeImageFilter.h.

◆ ImageBaseType

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
using itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::ImageBaseType = typename InputImageType::Superclass
protected

The weights used to scale derivatives during processing

Definition at line 296 of file itkVectorGradientMagnitudeImageFilter.h.

◆ InputImagePointer

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
using itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::InputImagePointer = typename InputImageType::Pointer

Definition at line 163 of file itkVectorGradientMagnitudeImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
using itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::InputImageType = TInputImage

Image type alias support

Definition at line 161 of file itkVectorGradientMagnitudeImageFilter.h.

◆ InputPixelType

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
using itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::InputPixelType = typename TInputImage::PixelType

Definition at line 158 of file itkVectorGradientMagnitudeImageFilter.h.

◆ OutputImagePointer

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
using itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 164 of file itkVectorGradientMagnitudeImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
using itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::OutputImageRegionType = typename Superclass::OutputImageRegionType

Superclass type alias.

Definition at line 183 of file itkVectorGradientMagnitudeImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
using itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::OutputImageType = TOutputImage

Definition at line 162 of file itkVectorGradientMagnitudeImageFilter.h.

◆ OutputPixelType

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
using itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::OutputPixelType = typename TOutputImage::PixelType

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

Definition at line 157 of file itkVectorGradientMagnitudeImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
using itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 146 of file itkVectorGradientMagnitudeImageFilter.h.

◆ RadiusType

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
using itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::RadiusType = typename ConstNeighborhoodIteratorType::RadiusType

Definition at line 180 of file itkVectorGradientMagnitudeImageFilter.h.

◆ RealType

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
using itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::RealType = TRealType

Define the data type and the vector of data type used in calculations.

Definition at line 173 of file itkVectorGradientMagnitudeImageFilter.h.

◆ RealVectorImageType

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
using itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::RealVectorImageType = Image<RealVectorType, TInputImage::ImageDimension>

Definition at line 175 of file itkVectorGradientMagnitudeImageFilter.h.

◆ RealVectorType

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
using itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::RealVectorType = Vector<TRealType, InputPixelType::Dimension>

Definition at line 174 of file itkVectorGradientMagnitudeImageFilter.h.

◆ Self

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
using itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::Self = VectorGradientMagnitudeImageFilter

Standard class type aliases.

Definition at line 144 of file itkVectorGradientMagnitudeImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
using itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 145 of file itkVectorGradientMagnitudeImageFilter.h.

◆ WeightsType

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
using itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::WeightsType = FixedArray<TRealType, VectorDimension>

Definition at line 222 of file itkVectorGradientMagnitudeImageFilter.h.

Constructor & Destructor Documentation

◆ VectorGradientMagnitudeImageFilter()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::VectorGradientMagnitudeImageFilter ( )
protected

The weights used to scale derivatives during processing

◆ ~VectorGradientMagnitudeImageFilter()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::~VectorGradientMagnitudeImageFilter ( )
overrideprotecteddefault

The weights used to scale derivatives during processing

Member Function Documentation

◆ BeforeThreadedGenerateData()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::BeforeThreadedGenerateData ( )
overrideprotectedvirtual

Do any necessary casting/copying of the input data. Input pixel types whose value types are not real number types must be cast to real number types.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ CreateAnother()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
virtual::itk::LightObject::Pointer itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::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.

◆ CubicSolver()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
static int itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::CubicSolver ( double *  ,
double *   
)
static

A specialized solver for finding the roots of a cubic polynomial. Necessary to multi-thread the 3D case

◆ DynamicThreadedGenerateData()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType outputRegionForThread)
overrideprotectedvirtual

VectorGradientMagnitudeImageFilter 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< TOutputImage >.

◆ EvaluateAtNeighborhood()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
TRealType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::EvaluateAtNeighborhood ( const ConstNeighborhoodIteratorType it) const
inlineprotected

◆ EvaluateAtNeighborhood3D()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
TRealType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::EvaluateAtNeighborhood3D ( const ConstNeighborhoodIteratorType it) const
inlineprotected

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::GenerateInputRequestedRegion ( )
overridevirtual

VectorGradientMagnitudeImageFilter needs a larger input requested region than the output requested region (larger by the kernel size to calculate derivatives). As such, VectorGradientMagnitudeImageFilter 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 >.

◆ GetComponentWeights()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
virtual const WeightsType& itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::GetComponentWeights ( ) const
virtual

The weights used to scale derivatives during processing

◆ GetDerivativeWeights()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
virtual const WeightsType& itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::GetDerivativeWeights ( ) const
virtual

The weights used to scale derivatives during processing

◆ GetNameOfClass()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
virtual const char* itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods)

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

◆ GetRealValuedInputImage()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
virtual const RealVectorImageType* itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::GetRealValuedInputImage ( ) const
protectedvirtual

Get access to the input image casted as real pixel values

◆ GetUseImageSpacing()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
virtual bool itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::GetUseImageSpacing ( ) const
virtual

◆ GetUsePrincipleComponents()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
virtual bool itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::GetUsePrincipleComponents ( ) const
virtual

The weights used to scale derivatives during processing

◆ New()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
static Pointer itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ NonPCEvaluateAtNeighborhood()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
TRealType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::NonPCEvaluateAtNeighborhood ( const ConstNeighborhoodIteratorType it) const
inlineprotected

◆ PrintSelf()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

The weights used to scale derivatives during processing

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

◆ SetComponentWeights()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
virtual void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::SetComponentWeights ( WeightsType  _arg)
virtual

Set/Get the array of weightings for the different components of the vector. Default values are 1.0.

◆ SetDerivativeWeights()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
virtual void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::SetDerivativeWeights ( WeightsType  _arg)
virtual

Directly Set/Get the array of weights used in the gradient calculations. Note that calling UseImageSpacingOn will clobber these values.

◆ SetUseImageSpacing()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::SetUseImageSpacing ( bool  )

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

◆ SetUseImageSpacingOff()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::SetUseImageSpacingOff ( )
inline

Reset the derivative weights to ignore image spacing. Use this option if you want to calculate the gradient in the image space. Default is ImageSpacingOn.

Definition at line 210 of file itkVectorGradientMagnitudeImageFilter.h.

◆ SetUseImageSpacingOn()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::SetUseImageSpacingOn ( )
inline

Set the derivative weights according to the spacing of the input image (1/spacing). Use this option if you want to calculate the gradient in the space in which the data was acquired. Default is ImageSpacingOn.

Definition at line 201 of file itkVectorGradientMagnitudeImageFilter.h.

◆ SetUsePrincipleComponents()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
virtual void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::SetUsePrincipleComponents ( bool  _arg)
virtual

Set/Get principle components calculation mode. When this is set to TRUE/ON, the gradient calculation will involve a principle component analysis of the partial derivatives of the color components. When this value is set to FALSE/OFF, the calculation is done as a square root of weighted sum of the derivatives squared. Default is UsePrincipleComponents = true.

◆ SetUsePrincipleComponentsOff()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::SetUsePrincipleComponentsOff ( )
inline

The weights used to scale derivatives during processing

Definition at line 251 of file itkVectorGradientMagnitudeImageFilter.h.

◆ SetUsePrincipleComponentsOn()

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::SetUsePrincipleComponentsOn ( )
inline

The weights used to scale derivatives during processing

Definition at line 244 of file itkVectorGradientMagnitudeImageFilter.h.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
constexpr unsigned int itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::ImageDimension = TOutputImage::ImageDimension
staticconstexpr

The dimensionality of the input and output images.

Definition at line 167 of file itkVectorGradientMagnitudeImageFilter.h.

◆ m_ComponentWeights

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
WeightsType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::m_ComponentWeights
protected

These weights are used to scale vector component values when they are combined to produce a scalar. The square root

Definition at line 477 of file itkVectorGradientMagnitudeImageFilter.h.

◆ m_DerivativeWeights

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
WeightsType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::m_DerivativeWeights
protected

The weights used to scale derivatives during processing

Definition at line 472 of file itkVectorGradientMagnitudeImageFilter.h.

◆ m_RealValuedInputImage

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
RealVectorImageType::ConstPointer itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::m_RealValuedInputImage
private

The weights used to scale derivatives during processing

Definition at line 486 of file itkVectorGradientMagnitudeImageFilter.h.

◆ m_RequestedNumberOfThreads

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
ThreadIdType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::m_RequestedNumberOfThreads
private

The weights used to scale derivatives during processing

Definition at line 484 of file itkVectorGradientMagnitudeImageFilter.h.

◆ m_SqrtComponentWeights

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
WeightsType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::m_SqrtComponentWeights
protected

The weights used to scale derivatives during processing

Definition at line 478 of file itkVectorGradientMagnitudeImageFilter.h.

◆ m_UseImageSpacing

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
bool itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::m_UseImageSpacing
private

The weights used to scale derivatives during processing

Definition at line 481 of file itkVectorGradientMagnitudeImageFilter.h.

◆ m_UsePrincipleComponents

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
bool itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::m_UsePrincipleComponents
private

The weights used to scale derivatives during processing

Definition at line 482 of file itkVectorGradientMagnitudeImageFilter.h.

◆ VectorDimension

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image<TRealType, TInputImage::ImageDimension>>
constexpr unsigned int itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::VectorDimension = InputPixelType::Dimension
staticconstexpr

Length of the vector pixel type of the input image.

Definition at line 170 of file itkVectorGradientMagnitudeImageFilter.h.


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