ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage > Class Template Reference
Group Filtering » Module ITKConvolution

#include <itkConvolutionImageFilterBase.h>

Detailed Description

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
class itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >

Abstract base class for the convolution image filters.

See also
ConvolutionImageFilter FFTConvolutionImageFilter

Definition at line 58 of file itkConvolutionImageFilterBase.h.

+ Inheritance diagram for itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >:
+ Collaboration diagram for itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >:

Public Types

using BoundaryConditionType = ImageBoundaryCondition< TInputImage >
 
using ConstPointer = SmartPointer< const Self >
 
using DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition< TInputImage >
 
using InputImageType = TInputImage
 
using InputIndexType = typename InputImageType::IndexType
 
using InputPixelType = typename InputImageType::PixelType
 
using InputRegionType = typename InputImageType::RegionType
 
using InputSizeType = typename InputImageType::SizeType
 
using KernelImageType = TKernelImage
 
using KernelIndexType = typename KernelImageType::IndexType
 
using KernelPixelType = typename KernelImageType::PixelType
 
using KernelRegionType = typename KernelImageType::RegionType
 
using KernelSizeType = typename KernelImageType::SizeType
 
using OutputImageType = TOutputImage
 
using OutputIndexType = typename OutputImageType::IndexType
 
using OutputPixelType = typename OutputImageType::PixelType
 
using OutputRegionModeEnum = ConvolutionImageFilterBaseEnums::ConvolutionImageFilterOutputRegion
 
using OutputRegionType = typename OutputImageType::RegionType
 
using OutputSizeType = typename OutputImageType::SizeType
 
using Pointer = SmartPointer< Self >
 
using Self = ConvolutionImageFilterBase
 
using SizeValueType = typename InputSizeType::SizeValueType
 
using Superclass = ImageToImageFilter< TInputImage, TOutputImage >
 
- 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 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

const char * GetNameOfClass () const override
 
virtual void SetBoundaryCondition (BoundaryConditionType *_arg)
 
virtual BoundaryConditionType * GetBoundaryCondition () const
 
virtual void SetKernelImage (const KernelImageType *input)
 
virtual const KernelImageType * GetKernelImage () const
 
virtual void SetNormalize (bool _arg)
 
virtual bool GetNormalize () const
 
virtual void NormalizeOn ()
 
virtual void SetOutputRegionMode (const OutputRegionModeEnum _arg)
 
virtual OutputRegionModeEnum GetOutputRegionMode () const
 
virtual void SetOutputRegionModeToSame ()
 
virtual void SetOutputRegionModeToValid ()
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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< TOutputImage >
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
 
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 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 *)
 
unsigned long AddObserver (const EventObject &event, Command *) 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
 
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 Attributes

static constexpr unsigned int ImageDimension = TInputImage::ImageDimension
 
- 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
 

Protected Member Functions

 ConvolutionImageFilterBase ()
 
void GenerateOutputInformation () override
 
OutputRegionType GetValidRegion () const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void VerifyInputInformation () ITKv5_CONST override
 
 ~ConvolutionImageFilterBase () override=default
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
void GenerateInputRequestedRegion () override
 
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override=default
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
void GenerateData () override
 
virtual const ImageRegionSplitterBase * GetImageRegionSplitter () const
 
 ImageSource ()
 
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 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
 
 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 VerifyPreconditions () ITKv5_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
 
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 PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

BoundaryConditionType * m_BoundaryCondition {}
 
DefaultBoundaryConditionType m_DefaultBoundaryCondition {}
 
bool m_Normalize { false }
 
OutputRegionModeEnum m_OutputRegionMode { ConvolutionImageFilterBaseEnums::ConvolutionImageFilterOutputRegion::SAME }
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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 ()
 
- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
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< TOutputImage >
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

◆ BoundaryConditionType

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::BoundaryConditionType = ImageBoundaryCondition<TInputImage>

Typedef to describe the boundary condition.

Definition at line 92 of file itkConvolutionImageFilterBase.h.

◆ ConstPointer

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 66 of file itkConvolutionImageFilterBase.h.

◆ DefaultBoundaryConditionType

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition<TInputImage>

Definition at line 97 of file itkConvolutionImageFilterBase.h.

◆ InputImageType

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::InputImageType = TInputImage

Definition at line 74 of file itkConvolutionImageFilterBase.h.

◆ InputIndexType

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::InputIndexType = typename InputImageType::IndexType

Definition at line 80 of file itkConvolutionImageFilterBase.h.

◆ InputPixelType

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::InputPixelType = typename InputImageType::PixelType

Definition at line 77 of file itkConvolutionImageFilterBase.h.

◆ InputRegionType

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::InputRegionType = typename InputImageType::RegionType

Definition at line 87 of file itkConvolutionImageFilterBase.h.

◆ InputSizeType

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::InputSizeType = typename InputImageType::SizeType

Definition at line 83 of file itkConvolutionImageFilterBase.h.

◆ KernelImageType

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::KernelImageType = TKernelImage

Definition at line 76 of file itkConvolutionImageFilterBase.h.

◆ KernelIndexType

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::KernelIndexType = typename KernelImageType::IndexType

Definition at line 82 of file itkConvolutionImageFilterBase.h.

◆ KernelPixelType

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::KernelPixelType = typename KernelImageType::PixelType

Definition at line 79 of file itkConvolutionImageFilterBase.h.

◆ KernelRegionType

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::KernelRegionType = typename KernelImageType::RegionType

Definition at line 89 of file itkConvolutionImageFilterBase.h.

◆ KernelSizeType

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::KernelSizeType = typename KernelImageType::SizeType

Definition at line 85 of file itkConvolutionImageFilterBase.h.

◆ OutputImageType

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 75 of file itkConvolutionImageFilterBase.h.

◆ OutputIndexType

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::OutputIndexType = typename OutputImageType::IndexType

Definition at line 81 of file itkConvolutionImageFilterBase.h.

◆ OutputPixelType

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::OutputPixelType = typename OutputImageType::PixelType

Definition at line 78 of file itkConvolutionImageFilterBase.h.

◆ OutputRegionModeEnum

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::OutputRegionModeEnum = ConvolutionImageFilterBaseEnums::ConvolutionImageFilterOutputRegion

Reverse compatibility for enumerations

Definition at line 117 of file itkConvolutionImageFilterBase.h.

◆ OutputRegionType

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::OutputRegionType = typename OutputImageType::RegionType

Definition at line 88 of file itkConvolutionImageFilterBase.h.

◆ OutputSizeType

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::OutputSizeType = typename OutputImageType::SizeType

Definition at line 84 of file itkConvolutionImageFilterBase.h.

◆ Pointer

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 65 of file itkConvolutionImageFilterBase.h.

◆ Self

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::Self = ConvolutionImageFilterBase

Definition at line 63 of file itkConvolutionImageFilterBase.h.

◆ SizeValueType

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::SizeValueType = typename InputSizeType::SizeValueType

Definition at line 86 of file itkConvolutionImageFilterBase.h.

◆ Superclass

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
using itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 64 of file itkConvolutionImageFilterBase.h.

Constructor & Destructor Documentation

◆ ConvolutionImageFilterBase()

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::ConvolutionImageFilterBase ( )
protected

◆ ~ConvolutionImageFilterBase()

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::~ConvolutionImageFilterBase ( )
overrideprotecteddefault

Member Function Documentation

◆ GenerateOutputInformation()

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::GenerateOutputInformation ( )
overrideprotectedvirtual

The largest possible output region may differ from the largest possible input region.

Reimplemented from itk::ProcessObject.

◆ GetBoundaryCondition()

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
virtual BoundaryConditionType* itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::GetBoundaryCondition ( ) const
virtual

Set/get the boundary condition.

◆ GetKernelImage()

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
virtual const KernelImageType* itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::GetKernelImage ( ) const
virtual

Set/get the image kernel.

◆ GetNameOfClass()

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
const char* itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

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

Reimplemented in itk::LandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::WienerDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::RichardsonLucyDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelSource::OutputImageType, TOutputImage >, itk::ProjectedLandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::FFTConvolutionImageFilter< TInputImage, TKernelSource::OutputImageType, TOutputImage, double >, itk::InverseDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::ProjectedIterativeDeconvolutionImageFilter< LandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision > >, and itk::TikhonovDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >.

◆ GetNormalize()

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
virtual bool itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::GetNormalize ( ) const
virtual

Normalize the output image by the sum of the kernel components. Defaults to off.

◆ GetOutputRegionMode()

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
virtual OutputRegionModeEnum itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::GetOutputRegionMode ( ) const
virtual

Sets the output region mode. If set to SAME, the output region will be the same as the input region, and regions of the image near the boundaries will contain contributions from outside the input image as determined by the boundary condition set in SetBoundaryCondition(). If set to VALID, the output region consists of pixels computed only from pixels in the input image (no extrapolated contributions from the boundary condition are needed). The output is therefore smaller than the input region. Default output region mode is SAME.

◆ GetValidRegion()

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
OutputRegionType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::GetValidRegion ( ) const
protected

Get the valid region of the convolution.

◆ NormalizeOn()

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
virtual void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::NormalizeOn ( )
virtual

Normalize the output image by the sum of the kernel components. Defaults to off.

◆ PrintSelf()

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::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::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::FFTConvolutionImageFilter< TInputImage, TKernelSource::OutputImageType, TOutputImage, double >, itk::LandweberDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::IterativeDeconvolutionImageFilter< TInputImage, TKernelSource::OutputImageType, TOutputImage >, itk::WienerDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::InverseDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, itk::TikhonovDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >, and itk::RichardsonLucyDeconvolutionImageFilter< TInputImage, TKernelImage, TOutputImage, TInternalPrecision >.

◆ SetBoundaryCondition()

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
virtual void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::SetBoundaryCondition ( BoundaryConditionType *  _arg)
virtual

Set/get the boundary condition.

◆ SetKernelImage()

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
virtual void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::SetKernelImage ( const KernelImageType *  input)
virtual

Set/get the image kernel.

◆ SetNormalize()

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
virtual void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::SetNormalize ( bool  _arg)
virtual

Normalize the output image by the sum of the kernel components. Defaults to off.

◆ SetOutputRegionMode()

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
virtual void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::SetOutputRegionMode ( const OutputRegionModeEnum  _arg)
virtual

Sets the output region mode. If set to SAME, the output region will be the same as the input region, and regions of the image near the boundaries will contain contributions from outside the input image as determined by the boundary condition set in SetBoundaryCondition(). If set to VALID, the output region consists of pixels computed only from pixels in the input image (no extrapolated contributions from the boundary condition are needed). The output is therefore smaller than the input region. Default output region mode is SAME.

◆ SetOutputRegionModeToSame()

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
virtual void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::SetOutputRegionModeToSame ( )
virtual

Sets the output region mode. If set to SAME, the output region will be the same as the input region, and regions of the image near the boundaries will contain contributions from outside the input image as determined by the boundary condition set in SetBoundaryCondition(). If set to VALID, the output region consists of pixels computed only from pixels in the input image (no extrapolated contributions from the boundary condition are needed). The output is therefore smaller than the input region. Default output region mode is SAME.

◆ SetOutputRegionModeToValid()

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
virtual void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::SetOutputRegionModeToValid ( )
virtual

Sets the output region mode. If set to SAME, the output region will be the same as the input region, and regions of the image near the boundaries will contain contributions from outside the input image as determined by the boundary condition set in SetBoundaryCondition(). If set to VALID, the output region consists of pixels computed only from pixels in the input image (no extrapolated contributions from the boundary condition are needed). The output is therefore smaller than the input region. Default output region mode is SAME.

◆ VerifyInputInformation()

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::VerifyInputInformation ( )
inlineoverrideprotectedvirtual

Default superclass implementation ensures that input images occupy same physical space. This is not needed for this filter.

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

Definition at line 162 of file itkConvolutionImageFilterBase.h.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
constexpr unsigned int itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension
staticconstexpr

Dimensionality of input and output data is assumed to be the same.

Definition at line 72 of file itkConvolutionImageFilterBase.h.

◆ m_BoundaryCondition

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
BoundaryConditionType* itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::m_BoundaryCondition {}
private

Definition at line 168 of file itkConvolutionImageFilterBase.h.

◆ m_DefaultBoundaryCondition

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
DefaultBoundaryConditionType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::m_DefaultBoundaryCondition {}
private

Definition at line 167 of file itkConvolutionImageFilterBase.h.

◆ m_Normalize

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
bool itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::m_Normalize { false }
private

Definition at line 165 of file itkConvolutionImageFilterBase.h.

◆ m_OutputRegionMode

template<typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
OutputRegionModeEnum itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::m_OutputRegionMode { ConvolutionImageFilterBaseEnums::ConvolutionImageFilterOutputRegion::SAME }
private

Definition at line 170 of file itkConvolutionImageFilterBase.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16