ITK
4.6.0
Insight Segmentation and Registration 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. Farneback & C.-F. Westin, "On Implementation of Recursive Gaussian Filters", so far unpublished.
Definition at line 51 of file itkRecursiveSeparableImageFilter.h.
Public Member Functions | |
virtual unsigned int | GetDirection () const |
const TInputImage * | GetInputImage (void) |
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 bool | CanRunInPlace () const |
virtual void | SetInPlace (bool _arg) |
virtual bool | GetInPlace () const |
virtual void | InPlaceOn () |
virtual void | InPlaceOff () |
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage > | |
const InputImageType * | GetInput (void) const |
const InputImageType * | GetInput (unsigned int idx) const |
virtual void | PopBackInput () |
virtual void | PopFrontInput () |
virtual void | PushBackInput (const InputImageType *image) |
virtual void | PushFrontInput (const InputImageType *image) |
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 > | |
OutputImageType * | GetOutput (unsigned int idx) |
virtual void | GraftNthOutput (unsigned int idx, DataObject *output) |
virtual void | GraftOutput (DataObject *output) |
virtual void | GraftOutput (const DataObjectIdentifierType &key, DataObject *output) |
OutputImageType * | GetOutput (void) |
const OutputImageType * | GetOutput (void) const |
virtual ProcessObject::DataObjectPointer | MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) ITK_OVERRIDE |
Public Member Functions inherited from itk::ProcessObject | |
virtual void | AbortGenerateDataOff () |
virtual void | AbortGenerateDataOn () |
virtual const bool & | GetAbortGenerateData () const |
NameArray | GetInputNames () const |
MultiThreader * | GetMultiThreader () const |
DataObjectPointerArraySizeType | GetNumberOfIndexedInputs () const |
DataObjectPointerArraySizeType | GetNumberOfInputs () const |
DataObjectPointerArraySizeType | GetNumberOfOutputs () const |
virtual DataObjectPointerArraySizeType | GetNumberOfValidRequiredInputs () const |
NameArray | GetOutputNames () const |
virtual const float & | GetProgress () const |
NameArray | GetRequiredInputNames () const |
bool | HasInput (const DataObjectIdentifierType &key) const |
bool | HasOutput (const DataObjectIdentifierType &key) const |
virtual DataObjectPointer | MakeOutput (const DataObjectIdentifierType &) |
virtual void | PrepareOutputs () |
virtual void | PropagateRequestedRegion (DataObject *output) |
virtual void | ResetPipeline () |
virtual void | SetAbortGenerateData (bool _arg) |
virtual void | Update () |
virtual void | UpdateLargestPossibleRegion () |
virtual void | UpdateOutputData (DataObject *output) |
virtual void | UpdateOutputInformation () |
void | UpdateProgress (float progress) |
DataObjectPointerArray | GetInputs () |
DataObjectPointerArray | GetOutputs () |
DataObjectPointerArray | GetIndexedInputs () |
DataObjectPointerArray | GetIndexedOutputs () |
DataObjectPointerArraySizeType | GetNumberOfIndexedOutputs () const |
void | SetProgress (float progress) |
virtual void | SetReleaseDataFlag (bool flag) |
virtual bool | GetReleaseDataFlag () const |
void | ReleaseDataFlagOn () |
void | ReleaseDataFlagOff () |
virtual void | SetReleaseDataBeforeUpdateFlag (bool _arg) |
virtual const bool & | GetReleaseDataBeforeUpdateFlag () const |
virtual void | ReleaseDataBeforeUpdateFlagOn () |
virtual void | ReleaseDataBeforeUpdateFlagOff () |
virtual void | SetNumberOfThreads (ThreadIdType _arg) |
virtual const ThreadIdType & | GetNumberOfThreads () const |
Public Member Functions inherited from itk::Object | |
unsigned long | AddObserver (const EventObject &event, Command *) |
unsigned long | AddObserver (const EventObject &event, Command *) const |
virtual LightObject::Pointer | CreateAnother () const ITK_OVERRIDE |
virtual void | DebugOff () const |
virtual void | DebugOn () const |
Command * | GetCommand (unsigned long tag) |
bool | GetDebug () const |
MetaDataDictionary & | GetMetaDataDictionary (void) |
const MetaDataDictionary & | GetMetaDataDictionary (void) 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 |
virtual void | Register () const ITK_OVERRIDE |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) |
void | SetDebug (bool debugFlag) const |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
virtual void | SetReferenceCount (int) ITK_OVERRIDE |
virtual void | UnRegister () const ITK_OVERRIDE |
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 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::ProcessObject | |
TimeStamp | m_OutputInformationMTime |
bool | m_Updating |
Protected Attributes inherited from itk::LightObject | |
InternalReferenceCountType | m_ReferenceCount |
SimpleFastMutexLock | m_ReferenceCountLock |
Private Member Functions | |
void | operator= (const Self &) |
RecursiveSeparableImageFilter (const Self &) | |
Private Attributes | |
unsigned int | m_Direction |
ImageRegionSplitterDirection::Pointer | m_ImageRegionSplitter |
Additional Inherited Members | |
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 const unsigned int | InputImageDimension = TInputImage::ImageDimension |
static const unsigned int | OutputImageDimension = TOutputImage::ImageDimension |
Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage > | |
static const unsigned int | InputImageDimension = TInputImage::ImageDimension |
static const unsigned int | OutputImageDimension = TOutputImage::ImageDimension |
Static Public Attributes inherited from itk::ImageSource< TOutputImage > | |
static const unsigned int | OutputImageDimension = TOutputImage::ImageDimension |
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage > | |
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) > | InputToOutputRegionCopierType |
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) > | OutputToInputRegionCopierType |
Protected Types inherited from itk::LightObject | |
typedef int | InternalReferenceCountType |
Static Protected Member Functions inherited from itk::ImageSource< TOutputImage > | |
static const ImageRegionSplitterBase * | GetGlobalDefaultSplitter () |
static ITK_THREAD_RETURN_TYPE | ThreaderCallback (void *arg) |
typedef SmartPointer< const Self > itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::ConstPointer |
Definition at line 59 of file itkRecursiveSeparableImageFilter.h.
typedef TInputImage::ConstPointer itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::InputImageConstPointer |
Definition at line 66 of file itkRecursiveSeparableImageFilter.h.
typedef TInputImage::Pointer itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::InputImagePointer |
Smart pointer typedef support.
Definition at line 62 of file itkRecursiveSeparableImageFilter.h.
typedef TInputImage itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::InputImageType |
Type of the input image
Definition at line 80 of file itkRecursiveSeparableImageFilter.h.
typedef TInputImage::PixelType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::InputPixelType |
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 73 of file itkRecursiveSeparableImageFilter.h.
typedef TOutputImage::RegionType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::OutputImageRegionType |
Definition at line 77 of file itkRecursiveSeparableImageFilter.h.
typedef TOutputImage itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::OutputImageType |
Type of the output image
Definition at line 83 of file itkRecursiveSeparableImageFilter.h.
typedef SmartPointer< Self > itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::Pointer |
Definition at line 58 of file itkRecursiveSeparableImageFilter.h.
typedef NumericTraits< InputPixelType >::RealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::RealType |
Definition at line 74 of file itkRecursiveSeparableImageFilter.h.
typedef NumericTraits< InputPixelType >::ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::ScalarRealType |
Definition at line 75 of file itkRecursiveSeparableImageFilter.h.
typedef RecursiveSeparableImageFilter itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::Self |
Standard class typedefs.
Definition at line 56 of file itkRecursiveSeparableImageFilter.h.
typedef InPlaceImageFilter< TInputImage, TOutputImage > itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::Superclass |
Definition at line 57 of file itkRecursiveSeparableImageFilter.h.
|
protected |
|
inlineprotectedvirtual |
Definition at line 99 of file itkRecursiveSeparableImageFilter.h.
|
private |
|
protectedvirtual |
GenerateData (apply) the filter.
Reimplemented from itk::ImageSource< TOutputImage >.
|
protectedvirtual |
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.
|
virtual |
Get the direction in which the filter is to be applied.
|
protectedvirtual |
Get the image splitter to split the image for multi-threading.
The Splitter object divides the image into regions for threading or streaming. The algorithms on how to split an images are separated into class so that they can be easily be reused. When deriving from this class to write a filter consideration to the algorithm used to divide the image should be made. If a change is desired this method should be overridden to return the appropriate object.
Reimplemented from itk::ImageSource< TOutputImage >.
const TInputImage* itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::GetInputImage | ( | void | ) |
Get Input Image.
|
virtual |
Type macro that defines a name for this class.
Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.
Reimplemented in itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >.
|
private |
|
protectedvirtual |
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 >.
|
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 >.
|
protectedvirtual |
If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call 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 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 ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).
Reimplemented from itk::ImageSource< TOutputImage >.
|
protected |
Definition at line 163 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 164 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 165 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 166 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Recursive coefficients to be used at the boundaries to simulate edge extension boundary conditions.
Definition at line 158 of file itkRecursiveSeparableImageFilter.h.
|
protected |
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 |
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 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.
|
private |
Direction in which the filter is to be applied this should be in the range [0,ImageDimension-1].
Definition at line 174 of file itkRecursiveSeparableImageFilter.h.
|
private |
Definition at line 176 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Anti-causal coefficients that multiply the input data.
Definition at line 151 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 152 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 153 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 154 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Causal coefficients that multiply the input data.
Definition at line 137 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 138 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 139 of file itkRecursiveSeparableImageFilter.h.
|
protected |
Definition at line 140 of file itkRecursiveSeparableImageFilter.h.