ITK  5.1.0
Insight Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage > Class Template Referenceabstract

#include <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 OutputImagePixelType = typename Superclass::OutputImagePixelType
 
using OutputImagePointer = typename Superclass::OutputImagePointer
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using OutputImageType = typename Superclass::OutputImageType
 
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 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 unsigned int GetDirection () const
 
const TInputImage * GetInputImage ()
 
virtual const char * GetNameOfClass () const
 
virtual void SetDirection (unsigned int _arg)
 
void SetInputImage (const TInputImage *)
 
- Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual void SetInPlace (bool _arg)
 
virtual bool GetInPlace () const
 
virtual void InPlaceOn ()
 
virtual void InPlaceOff ()
 
virtual bool CanRunInPlace () const
 
- 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 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 ()
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual const float & GetProgress () const
 
void UpdateProgress (float progress)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputInformation ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void ResetPipeline ()
 
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
 
LightObject::Pointer CreateAnother () const override
 
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
 

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)
 
void GenerateData () override
 
template<typename T1 , typename T2 >
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 >
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 >
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 >
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)
 
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 >
 InPlaceImageFilter ()=default
 
 ~InPlaceImageFilter () override=default
 
void AllocateOutputs () override
 
void ReleaseInputs () override
 
virtual bool GetRunningInPlace () const
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override
 
void VerifyInputInformation () ITKv5_CONST override
 
void GenerateInputRequestedRegion () override
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
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 ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
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 CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
- 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 ()
 

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
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- 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 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 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 >
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 

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. Farneback & C.-F. Westin, "On Implementation of Recursive Gaussian Filters", so far unpublished.

Definition at line 51 of file itkRecursiveSeparableImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 60 of file itkRecursiveSeparableImageFilter.h.

◆ InputImageConstPointer

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

Definition at line 67 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 66 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 81 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 74 of file itkRecursiveSeparableImageFilter.h.

◆ OutputImageRegionType

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

Definition at line 78 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 84 of file itkRecursiveSeparableImageFilter.h.

◆ Pointer

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

Definition at line 59 of file itkRecursiveSeparableImageFilter.h.

◆ RealType

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

Definition at line 75 of file itkRecursiveSeparableImageFilter.h.

◆ ScalarRealType

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

Definition at line 76 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 57 of file itkRecursiveSeparableImageFilter.h.

◆ Superclass

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

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

Get the output data of this process object. The output of this function is not valid until an appropriate Update() method has been called, either explicitly or implicitly. Both the filter itself and the data object have Update() methods, and both methods update the data. Here are three ways to use GetOutput() and make sure the data is valid. In these examples, image is a pointer to some Image object, and the particular ProcessObjects involved are filters. The same examples apply to non-image (e.g. Mesh) data as well.

anotherFilter->SetInput( someFilter->GetOutput() );
anotherFilter->Update();

In this situation, someFilter and anotherFilter are said to constitute a pipeline.

image = someFilter->GetOutput();
image->Update();
someFilter->Update();
image = someFilter->GetOutput();

(In the above example, the two lines of code can be in either order.)

Note that Update() is not called automatically except within a pipeline as in the first example. When streaming (using a StreamingImageFilter) is activated, it may be more efficient to use a pipeline than to call Update() once for each filter in turn.

For an image, the data generated is for the requested Region, which can be set using ImageBase::SetRequestedRegion(). By default, the largest possible region is requested.

For Filters which have multiple outputs of different types, the GetOutput() method assumes the output is of OutputImageType. For the GetOutput(unsigned int) method, a dynamic_cast is performed incase the filter has outputs of different types or image types. Derived classes should have names get methods for these outputs.

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 
)
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>
virtual const char* itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

Type macro that defines a name for this class.

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

Definition at line 178 of file itkRecursiveSeparableImageFilter.h.

◆ MathEMAMAMAM() [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
template<typename T1 , typename T2 >
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 
)
inlineprotected

◆ MathSMAMAMAM() [1/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
template<typename T1 , typename T2 >
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 
)
inlineprotected

Definition at line 217 of file itkRecursiveSeparableImageFilter.h.

◆ MathSMAMAMAM() [2/2]

template<typename TInputImage , typename TOutputImage = TInputImage>
template<typename T1 , typename T2 >
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 
)
inlineprotected

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage = TInputImage>
void itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

In place operation can be turned on and off. Asking for in-place operation, i.e. calling SetInplace(true) or InplaceOn(), will be effective only if CanRunInPlace also returns true. By default CanRunInPlace checks whether the input and output image type match.

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 170 of file itkRecursiveSeparableImageFilter.h.

◆ m_BM2

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

Definition at line 171 of file itkRecursiveSeparableImageFilter.h.

◆ m_BM3

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

Definition at line 172 of file itkRecursiveSeparableImageFilter.h.

◆ m_BM4

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

Definition at line 173 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 165 of file itkRecursiveSeparableImageFilter.h.

◆ m_BN2

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

Definition at line 166 of file itkRecursiveSeparableImageFilter.h.

◆ m_BN3

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

Definition at line 167 of file itkRecursiveSeparableImageFilter.h.

◆ m_BN4

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

Definition at line 168 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 152 of file itkRecursiveSeparableImageFilter.h.

◆ m_D2

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

Definition at line 153 of file itkRecursiveSeparableImageFilter.h.

◆ m_D3

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

Definition at line 154 of file itkRecursiveSeparableImageFilter.h.

◆ m_D4

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

Definition at line 155 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 256 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 158 of file itkRecursiveSeparableImageFilter.h.

◆ m_M2

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

Definition at line 159 of file itkRecursiveSeparableImageFilter.h.

◆ m_M3

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

Definition at line 160 of file itkRecursiveSeparableImageFilter.h.

◆ m_M4

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

Definition at line 161 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 144 of file itkRecursiveSeparableImageFilter.h.

◆ m_N1

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

Definition at line 145 of file itkRecursiveSeparableImageFilter.h.

◆ m_N2

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

Definition at line 146 of file itkRecursiveSeparableImageFilter.h.

◆ m_N3

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

Definition at line 147 of file itkRecursiveSeparableImageFilter.h.


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