ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Attributes | List of all members
itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage > Class Template Referenceabstract
Data Processing Objects » Filters » Image FiltersGroup Filtering » | Module ITKImageFilterBase

#include <itkRecursiveSeparableImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage = TInputImage>
class itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >

Base class for recursive convolution with a kernel.

RecursiveSeparableImageFilter is the base class for recursive filters that are applied in each dimension separately. If multi-component images are specified, the filtering operation works on each component independently.

This class implements the recursive filtering method proposed by R.Deriche in IEEE-PAMI Vol.12, No.1, January 1990, pp 78-87.

Details of the implementation are described in the technical report: R. Deriche, "Recursively Implementing The Gaussian and Its Derivatives", INRIA, 1993, ftp://ftp.inria.fr/INRIA/tech-reports/RR/RR-1893.ps.gz

Further improvements of the algorithm are described in: G. Farnebäck & C.-F. Westin, "Improving Deriche-style Recursive Gaussian Filters". J Math Imaging Vis 26, 293–299 (2006). https://doi.org/10.1007/s10851-006-8464-z

Definition at line 52 of file itkRecursiveSeparableImageFilter.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename TInputImage::ConstPointer
 
using InputImagePointer = typename TInputImage::Pointer
 
using InputImageType = TInputImage
 
using InputPixelType = typename TInputImage::PixelType
 
using OutputImageRegionType = typename TOutputImage::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using RealType = typename NumericTraits< InputPixelType >::RealType
 
using ScalarRealType = typename NumericTraits< InputPixelType >::ScalarRealType
 
using Self = RecursiveSeparableImageFilter
 
using Superclass = InPlaceImageFilter< TInputImage, TOutputImage >
 
- Public Types inherited from itk::InPlaceImageFilter< 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 = InPlaceImageFilter
 
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

virtual unsigned int GetDirection () const
 
const TInputImage * GetInputImage ()
 
const char * GetNameOfClass () const override
 
virtual void SetDirection (unsigned int _arg)
 
void SetInputImage (const TInputImage *)
 
- Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool CanRunInPlace () const
 
virtual void SetInPlace (bool _arg)
 
virtual bool GetInPlace () const
 
virtual void InPlaceOn ()
 
- 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 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
 

Protected Member Functions

void BeforeThreadedGenerateData () override
 
void DynamicThreadedGenerateData (const OutputImageRegionType &) override
 
void EnlargeOutputRequestedRegion (DataObject *output) override
 
void FilterDataArray (RealType *outs, const RealType *data, RealType *scratch, SizeValueType ln) const
 
void GenerateData () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 RecursiveSeparableImageFilter ()
 
virtual void SetUp (ScalarRealType spacing)=0
 
 ~RecursiveSeparableImageFilter () override=default
 
- Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool GetRunningInPlace () const
 
 InPlaceImageFilter ()=default
 
void ReleaseInputs () override
 
 ~InPlaceImageFilter () override=default
 
void AllocateOutputs () override
 
- 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 ()
 
void VerifyInputInformation () ITKv5_CONST override
 
 ~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 ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
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 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 GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObject * GetInput (const DataObjectIdentifierType &key)
 
const DataObject * GetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
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 ()
 

Static Protected Member Functions

template<typename T1 , typename T2 >
static void MathEMAMAMAM (T1 &out, const T1 &a1, const T2 &b1, const T1 &a2, const T2 &b2, const T1 &a3, const T2 &b3, const T1 &a4, const T2 &b4)
 
template<typename T1 , typename T2 >
static void MathEMAMAMAM (VariableLengthVector< T1 > &out, const VariableLengthVector< T1 > &a1, const T2 &b1, const VariableLengthVector< T1 > &a2, const T2 &b2, const VariableLengthVector< T1 > &a3, const T2 &b3, const VariableLengthVector< T1 > &a4, const T2 &b4)
 
template<typename T1 , typename T2 >
static void MathSMAMAMAM (T1 &out, const T1 &a1, const T2 &b1, const T1 &a2, const T2 &b2, const T1 &a3, const T2 &b3, const T1 &a4, const T2 &b4)
 
template<typename T1 , typename T2 >
static void MathSMAMAMAM (VariableLengthVector< T1 > &out, const VariableLengthVector< T1 > &a1, const T2 &b1, const VariableLengthVector< T1 > &a2, const T2 &b2, const VariableLengthVector< T1 > &a3, const T2 &b3, const VariableLengthVector< T1 > &a4, const T2 &b4)
 
- 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

ScalarRealType m_BM1 {}
 
ScalarRealType m_BM2 {}
 
ScalarRealType m_BM3 {}
 
ScalarRealType m_BM4 {}
 
ScalarRealType m_BN1 {}
 
ScalarRealType m_BN2 {}
 
ScalarRealType m_BN3 {}
 
ScalarRealType m_BN4 {}
 
ScalarRealType m_D1 {}
 
ScalarRealType m_D2 {}
 
ScalarRealType m_D3 {}
 
ScalarRealType m_D4 {}
 
ScalarRealType m_M1 {}
 
ScalarRealType m_M2 {}
 
ScalarRealType m_M3 {}
 
ScalarRealType m_M4 {}
 
ScalarRealType m_N0 {}
 
ScalarRealType m_N1 {}
 
ScalarRealType m_N2 {}
 
ScalarRealType m_N3 {}
 
- 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 {}
 

Private Attributes

unsigned int m_Direction { 0 }
 

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 ()
 
- Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::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 Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 61 of file itkRecursiveSeparableImageFilter.h.

◆ InputImageConstPointer

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::InputImageConstPointer = typename TInputImage::ConstPointer

Definition at line 68 of file itkRecursiveSeparableImageFilter.h.

◆ InputImagePointer

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::InputImagePointer = typename TInputImage::Pointer

Smart pointer type alias support

Definition at line 67 of file itkRecursiveSeparableImageFilter.h.

◆ InputImageType

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

Type of the input image

Definition at line 82 of file itkRecursiveSeparableImageFilter.h.

◆ InputPixelType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::InputPixelType = typename TInputImage::PixelType

Real type to be used in internal computations. RealType in general is templated over the pixel type. (For example for vector or tensor pixels, RealType is a vector or a tensor of doubles.) ScalarRealType is a type meant for scalars.

Definition at line 75 of file itkRecursiveSeparableImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename TOutputImage::RegionType

Definition at line 79 of file itkRecursiveSeparableImageFilter.h.

◆ OutputImageType

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

Type of the output image

Definition at line 85 of file itkRecursiveSeparableImageFilter.h.

◆ Pointer

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

Definition at line 60 of file itkRecursiveSeparableImageFilter.h.

◆ RealType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::RealType = typename NumericTraits<InputPixelType>::RealType

Definition at line 76 of file itkRecursiveSeparableImageFilter.h.

◆ ScalarRealType

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::ScalarRealType = typename NumericTraits<InputPixelType>::ScalarRealType

Definition at line 77 of file itkRecursiveSeparableImageFilter.h.

◆ Self

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

Standard class type aliases.

Definition at line 58 of file itkRecursiveSeparableImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage = TInputImage>
using itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::Superclass = InPlaceImageFilter<TInputImage, TOutputImage>

Definition at line 59 of file itkRecursiveSeparableImageFilter.h.

Constructor & Destructor Documentation

◆ RecursiveSeparableImageFilter()

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

◆ ~RecursiveSeparableImageFilter()

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

Member Function Documentation

◆ BeforeThreadedGenerateData()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( )
overrideprotectedvirtual

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ DynamicThreadedGenerateData()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread)
overrideprotectedvirtual

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData() or DynamicThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call (Dynamic)ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of (Dynamic)ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a (Dynamic)ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The (Dynamic)ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. (Dynamic)ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

DynamicThreadedGenerateData() is the newer variant without threadId, and is the preferred signature, which is called by default. This variant can split the requested region into different number of pieces depending on current multi-processing load, which allows better load balancing. The non-dynamic (also known as classic) ThreadedGenerateData() signature has threadId, and number of pieces to be split into is known in advance. It is activated by calling this->DynamicMultiThreadingOff(); in derived class constructor. It should be used when the multi-threaded algorithm needs to pre-allocate some data structure with size dependent on the number of pieces (also known as chunks, work units, and sometimes also incorrectly as threads). Only PlatformMultiThreader guarantees that each piece will be processed in its own specific thread. Pool and TBB multi-threaders maintain a pool of threads (normally equal to number of processing cores) which they use to process the pieces. This normally results in a single thread being reused to process multiple work units.

See also
GenerateData(), SplitRequestedRegion()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ EnlargeOutputRequestedRegion()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::EnlargeOutputRequestedRegion ( DataObject *  output)
overrideprotectedvirtual

RecursiveSeparableImageFilter needs all of the input only in the "Direction" dimension. Therefore we enlarge the output's RequestedRegion to this. Then the superclass's GenerateInputRequestedRegion method will copy the output region to the input.

See also
ImageToImageFilter::GenerateInputRequestedRegion()

Reimplemented from itk::ProcessObject.

◆ FilterDataArray()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::FilterDataArray ( RealType *  outs,
const RealType *  data,
RealType *  scratch,
SizeValueType  ln 
) const
protected

Apply the Recursive Filter to an array of data. This method is called for each line of the volume. Parameter "scratch" is a scratch area used for internal computations that is the same size as the parameters "outs" and "data". The scratch area must be allocated outside of this routine (this avoids memory allocation and deallocation in the inner loop of the overall algorithm.

◆ GenerateData()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::GenerateData ( )
overrideprotectedvirtual

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling DynamicThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter can be threaded, it should NOT provide a GenerateData() method but should provide a DynamicThreadedGenerateData() instead.

See also
ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GetDirection()

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual unsigned int itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::GetDirection ( ) const
virtual

Get the direction in which the filter is to be applied.

◆ GetInputImage()

template<typename TInputImage , typename TOutputImage = TInputImage>
const TInputImage* itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::GetInputImage ( )

Get Input Image.

◆ GetNameOfClass()

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

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

Reimplemented in itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >.

◆ MathEMAMAMAM() [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
template<typename T1 , typename T2 >
static void itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::MathEMAMAMAM ( T1 &  out,
const T1 &  a1,
const T2 &  b1,
const T1 &  a2,
const T2 &  b2,
const T1 &  a3,
const T2 &  b3,
const T1 &  a4,
const T2 &  b4 
)
inlinestaticprotected

Definition at line 179 of file itkRecursiveSeparableImageFilter.h.

◆ MathEMAMAMAM() [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
template<typename T1 , typename T2 >
static void itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::MathEMAMAMAM ( VariableLengthVector< T1 > &  out,
const VariableLengthVector< T1 > &  a1,
const T2 &  b1,
const VariableLengthVector< T1 > &  a2,
const T2 &  b2,
const VariableLengthVector< T1 > &  a3,
const T2 &  b3,
const VariableLengthVector< T1 > &  a4,
const T2 &  b4 
)
inlinestaticprotected

Definition at line 195 of file itkRecursiveSeparableImageFilter.h.

References itk::VariableLengthVector< TValue >::GetSize(), and itk::VariableLengthVector< TValue >::SetSize().

◆ MathSMAMAMAM() [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
template<typename T1 , typename T2 >
static void itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::MathSMAMAMAM ( T1 &  out,
const T1 &  a1,
const T2 &  b1,
const T1 &  a2,
const T2 &  b2,
const T1 &  a3,
const T2 &  b3,
const T1 &  a4,
const T2 &  b4 
)
inlinestaticprotected

Definition at line 218 of file itkRecursiveSeparableImageFilter.h.

◆ MathSMAMAMAM() [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
template<typename T1 , typename T2 >
static void itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::MathSMAMAMAM ( VariableLengthVector< T1 > &  out,
const VariableLengthVector< T1 > &  a1,
const T2 &  b1,
const VariableLengthVector< T1 > &  a2,
const T2 &  b2,
const VariableLengthVector< T1 > &  a3,
const T2 &  b3,
const VariableLengthVector< T1 > &  a4,
const T2 &  b4 
)
inlinestaticprotected

Definition at line 233 of file itkRecursiveSeparableImageFilter.h.

References itk::VariableLengthVector< TValue >::GetSize(), and itk::VariableLengthVector< TValue >::SetSize().

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::RecursiveSeparableImageFilter< TInputImage, 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::InPlaceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >.

◆ SetDirection()

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual void itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::SetDirection ( unsigned int  _arg)
virtual

Set the direction in which the filter is to be applied.

◆ SetInputImage()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::SetInputImage ( const TInputImage *  )

Set Input Image.

◆ SetUp()

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual void itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::SetUp ( ScalarRealType  spacing)
protectedpure virtual

Set up the coefficients of the filter to approximate a specific kernel. Typically it can be used to approximate a Gaussian or one of its derivatives. Parameter is the spacing along the dimension to filter.

Implemented in itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >.

Member Data Documentation

◆ m_BM1

template<typename TInputImage , typename TOutputImage = TInputImage>
ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_BM1 {}
protected

Definition at line 171 of file itkRecursiveSeparableImageFilter.h.

◆ m_BM2

template<typename TInputImage , typename TOutputImage = TInputImage>
ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_BM2 {}
protected

Definition at line 172 of file itkRecursiveSeparableImageFilter.h.

◆ m_BM3

template<typename TInputImage , typename TOutputImage = TInputImage>
ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_BM3 {}
protected

Definition at line 173 of file itkRecursiveSeparableImageFilter.h.

◆ m_BM4

template<typename TInputImage , typename TOutputImage = TInputImage>
ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_BM4 {}
protected

Definition at line 174 of file itkRecursiveSeparableImageFilter.h.

◆ m_BN1

template<typename TInputImage , typename TOutputImage = TInputImage>
ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_BN1 {}
protected

Recursive coefficients to be used at the boundaries to simulate edge extension boundary conditions.

Definition at line 166 of file itkRecursiveSeparableImageFilter.h.

◆ m_BN2

template<typename TInputImage , typename TOutputImage = TInputImage>
ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_BN2 {}
protected

Definition at line 167 of file itkRecursiveSeparableImageFilter.h.

◆ m_BN3

template<typename TInputImage , typename TOutputImage = TInputImage>
ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_BN3 {}
protected

Definition at line 168 of file itkRecursiveSeparableImageFilter.h.

◆ m_BN4

template<typename TInputImage , typename TOutputImage = TInputImage>
ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_BN4 {}
protected

Definition at line 169 of file itkRecursiveSeparableImageFilter.h.

◆ m_D1

template<typename TInputImage , typename TOutputImage = TInputImage>
ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_D1 {}
protected

Recursive coefficients that multiply previously computed values at the output. These are the same for the causal and anti-causal parts of the filter.

Definition at line 153 of file itkRecursiveSeparableImageFilter.h.

◆ m_D2

template<typename TInputImage , typename TOutputImage = TInputImage>
ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_D2 {}
protected

Definition at line 154 of file itkRecursiveSeparableImageFilter.h.

◆ m_D3

template<typename TInputImage , typename TOutputImage = TInputImage>
ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_D3 {}
protected

Definition at line 155 of file itkRecursiveSeparableImageFilter.h.

◆ m_D4

template<typename TInputImage , typename TOutputImage = TInputImage>
ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_D4 {}
protected

Definition at line 156 of file itkRecursiveSeparableImageFilter.h.

◆ m_Direction

template<typename TInputImage , typename TOutputImage = TInputImage>
unsigned int itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_Direction { 0 }
private

Direction in which the filter is to be applied this should be in the range [0,ImageDimension-1].

Definition at line 257 of file itkRecursiveSeparableImageFilter.h.

◆ m_M1

template<typename TInputImage , typename TOutputImage = TInputImage>
ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_M1 {}
protected

Anti-causal coefficients that multiply the input data.

Definition at line 159 of file itkRecursiveSeparableImageFilter.h.

◆ m_M2

template<typename TInputImage , typename TOutputImage = TInputImage>
ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_M2 {}
protected

Definition at line 160 of file itkRecursiveSeparableImageFilter.h.

◆ m_M3

template<typename TInputImage , typename TOutputImage = TInputImage>
ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_M3 {}
protected

Definition at line 161 of file itkRecursiveSeparableImageFilter.h.

◆ m_M4

template<typename TInputImage , typename TOutputImage = TInputImage>
ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_M4 {}
protected

Definition at line 162 of file itkRecursiveSeparableImageFilter.h.

◆ m_N0

template<typename TInputImage , typename TOutputImage = TInputImage>
ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_N0 {}
protected

Causal coefficients that multiply the input data.

Definition at line 145 of file itkRecursiveSeparableImageFilter.h.

◆ m_N1

template<typename TInputImage , typename TOutputImage = TInputImage>
ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_N1 {}
protected

Definition at line 146 of file itkRecursiveSeparableImageFilter.h.

◆ m_N2

template<typename TInputImage , typename TOutputImage = TInputImage>
ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_N2 {}
protected

Definition at line 147 of file itkRecursiveSeparableImageFilter.h.

◆ m_N3

template<typename TInputImage , typename TOutputImage = TInputImage>
ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_N3 {}
protected

Definition at line 148 of file itkRecursiveSeparableImageFilter.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