ITK
6.0.0
Insight Toolkit
|
#include <itkRecursiveSeparableImageFilter.h>
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.
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, TInputImage > | |
virtual bool | CanRunInPlace () const |
const char * | GetNameOfClass () const override |
virtual void | SetInPlace (bool _arg) |
virtual bool | GetInPlace () const |
virtual void | InPlaceOn () |
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage > | |
const InputImageType * | GetInput () const |
const InputImageType * | GetInput (unsigned int idx) const |
const char * | GetNameOfClass () const override |
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< TInputImage > | |
const char * | GetNameOfClass () const override |
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 |
const char * | GetNameOfClass () const override |
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 DataObjectPointer | MakeOutput (const DataObjectIdentifierType &) |
virtual DataObjectPointer | MakeOutput (DataObjectPointerArraySizeType idx) |
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 *cmd) 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 |
const char * | GetNameOfClass () const override |
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) const |
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 Pointer | CreateAnother () const |
virtual void | Delete () |
virtual const char * | GetNameOfClass () const |
virtual int | GetReferenceCount () const |
void | Print (std::ostream &os, Indent indent=0) const |
virtual void | Register () const |
virtual void | SetReferenceCount (int) |
virtual void | UnRegister () const noexcept |
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< TInputImage > | |
static const ImageRegionSplitterBase * | GetGlobalDefaultSplitter () |
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION | ThreaderCallback (void *arg) |
Static Protected Member Functions inherited from itk::ProcessObject | |
template<typename TSourceObject > | |
static void | MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs) |
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< TInputImage > | |
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, TInputImage > | |
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, TInputImage > | |
static constexpr unsigned int | InputImageDimension |
static constexpr unsigned int | OutputImageDimension |
Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TInputImage > | |
static constexpr unsigned int | InputImageDimension |
static constexpr unsigned int | OutputImageDimension |
Static Public Attributes inherited from itk::ImageSource< TInputImage > | |
static constexpr unsigned int | OutputImageDimension |
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage > | |
using | InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension > |
using | OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension > |
using itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self> |
Definition at line 61 of file itkRecursiveSeparableImageFilter.h.
using itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::InputImageConstPointer = typename TInputImage::ConstPointer |
Definition at line 68 of file itkRecursiveSeparableImageFilter.h.
using itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::InputImagePointer = typename TInputImage::Pointer |
Smart pointer type alias support
Definition at line 67 of file itkRecursiveSeparableImageFilter.h.
using itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage |
Type of the input image
Definition at line 82 of file itkRecursiveSeparableImageFilter.h.
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.
using itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename TOutputImage::RegionType |
Definition at line 79 of file itkRecursiveSeparableImageFilter.h.
using itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage |
Type of the output image
Definition at line 85 of file itkRecursiveSeparableImageFilter.h.
using itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self> |
Definition at line 60 of file itkRecursiveSeparableImageFilter.h.
using itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::RealType = typename NumericTraits<InputPixelType>::RealType |
Definition at line 76 of file itkRecursiveSeparableImageFilter.h.
using itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::ScalarRealType = typename NumericTraits<InputPixelType>::ScalarRealType |
Definition at line 77 of file itkRecursiveSeparableImageFilter.h.
using itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::Self = RecursiveSeparableImageFilter |
Standard class type aliases.
Definition at line 58 of file itkRecursiveSeparableImageFilter.h.
using itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::Superclass = InPlaceImageFilter<TInputImage, TOutputImage> |
Definition at line 59 of file itkRecursiveSeparableImageFilter.h.
|
protected |
|
overrideprotecteddefault |
|
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< TInputImage >.
|
overrideprotected |
|
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.
Reimplemented from itk::ProcessObject.
|
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.
|
overrideprotectedvirtual |
This method causes the filter to generate its output.
Reimplemented from itk::ProcessObject.
|
virtual |
Get the direction in which the filter is to be applied.
const TInputImage * itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::GetInputImage | ( | ) |
Get Input Image.
|
overridevirtual |
Reimplemented from itk::ProcessObject.
|
inlinestaticprotected |
Definition at line 179 of file itkRecursiveSeparableImageFilter.h.
|
inlinestaticprotected |
Definition at line 195 of file itkRecursiveSeparableImageFilter.h.
|
inlinestaticprotected |
Definition at line 218 of file itkRecursiveSeparableImageFilter.h.
|
inlinestaticprotected |
Definition at line 233 of file itkRecursiveSeparableImageFilter.h.
|
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::ProcessObject.
|
virtual |
Set the direction in which the filter is to be applied.
void itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::SetInputImage | ( | const TInputImage * | ) |
Set Input Image.
|
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 >.
|
protected |
Definition at line 171 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 172 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 173 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 174 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Recursive coefficients to be used at the boundaries to simulate edge extension boundary conditions.
Definition at line 166 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 167 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 168 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 169 of file itkRecursiveSeparableImageFilter.h.
|
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.
|
protected |
Definition at line 154 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 155 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 156 of file itkRecursiveSeparableImageFilter.h.
|
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.
|
protected |
Anti-causal coefficients that multiply the input data.
Definition at line 159 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 160 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 161 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 162 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Causal coefficients that multiply the input data.
Definition at line 145 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 146 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 147 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 148 of file itkRecursiveSeparableImageFilter.h.