ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes
itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage > Class Template Reference

#include <itkConvolutionImageFilterBase.h>

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

List of all members.

Public Types

typedef BoundaryConditionTypeBoundaryConditionPointerType
typedef ImageBoundaryCondition
< TInputImage > 
BoundaryConditionType
typedef SmartPointer< const SelfConstPointer
typedef
ZeroFluxNeumannBoundaryCondition
< TInputImage > 
DefaultBoundaryConditionType
typedef TInputImage InputImageType
typedef InputImageType::IndexType InputIndexType
typedef InputImageType::PixelType InputPixelType
typedef InputImageType::RegionType InputRegionType
typedef InputImageType::SizeType InputSizeType
typedef TKernelImage KernelImageType
typedef KernelImageType::IndexType KernelIndexType
typedef KernelImageType::PixelType KernelPixelType
typedef KernelImageType::RegionType KernelRegionType
typedef KernelImageType::SizeType KernelSizeType
typedef TOutputImage OutputImageType
typedef OutputImageType::IndexType OutputIndexType
typedef OutputImageType::PixelType OutputPixelType
enum  OutputRegionModeType {
  SAME = 0,
  VALID
}
typedef OutputImageType::RegionType OutputRegionType
typedef OutputImageType::SizeType OutputSizeType
typedef SmartPointer< SelfPointer
typedef ConvolutionImageFilterBase Self
typedef
InputSizeType::SizeValueType 
SizeValueType
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass

Public Member Functions

virtual const char * GetNameOfClass () const
virtual void SetBoundaryCondition (BoundaryConditionPointerType _arg)
virtual
BoundaryConditionPointerType 
GetBoundaryCondition () const
virtual void SetKernelImage (const KernelImageType *input)
virtual const KernelImageTypeGetKernelImage () const
virtual void SetNormalize (bool _arg)
virtual bool GetNormalize () const
virtual void NormalizeOn ()
virtual void NormalizeOff ()
virtual void SetOutputRegionMode (const OutputRegionModeType _arg)
virtual OutputRegionModeType GetOutputRegionMode () const
virtual void SetOutputRegionModeToSame ()
virtual void SetOutputRegionModeToValid ()

Static Public Attributes

static const unsigned int ImageDimension = TInputImage::ImageDimension

Protected Member Functions

 ConvolutionImageFilterBase ()
void GenerateOutputInformation ()
OutputRegionType GetValidRegion () const
void PrintSelf (std::ostream &os, Indent indent) const
virtual void VerifyInputInformation ()
 ~ConvolutionImageFilterBase ()

Private Member Functions

 ConvolutionImageFilterBase (const Self &)
void operator= (const Self &)

Private Attributes

BoundaryConditionPointerType m_BoundaryCondition
DefaultBoundaryConditionType m_DefaultBoundaryCondition
bool m_Normalize
OutputRegionModeType m_OutputRegionMode

Detailed Description

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

Abstract base class for the convolution image filters.

See also:
ConvolutionImageFilter FFTConvolutionImageFilter

Definition at line 35 of file itkConvolutionImageFilterBase.h.


Member Typedef Documentation

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef BoundaryConditionType* itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::BoundaryConditionPointerType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef ImageBoundaryCondition< TInputImage > itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::BoundaryConditionType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef SmartPointer< const Self > itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::ConstPointer
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef ZeroFluxNeumannBoundaryCondition< TInputImage > itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::DefaultBoundaryConditionType

Definition at line 71 of file itkConvolutionImageFilterBase.h.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef TInputImage itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::InputImageType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef InputImageType::IndexType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::InputIndexType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef InputImageType::PixelType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::InputPixelType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef InputImageType::RegionType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::InputRegionType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef InputImageType::SizeType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::InputSizeType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef TKernelImage itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::KernelImageType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef KernelImageType::IndexType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::KernelIndexType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef KernelImageType::PixelType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::KernelPixelType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef KernelImageType::RegionType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::KernelRegionType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef KernelImageType::SizeType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::KernelSizeType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef TOutputImage itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::OutputImageType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef OutputImageType::IndexType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::OutputIndexType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef OutputImageType::PixelType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::OutputPixelType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef OutputImageType::RegionType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::OutputRegionType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef OutputImageType::SizeType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::OutputSizeType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef SmartPointer< Self > itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::Pointer
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef ConvolutionImageFilterBase itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::Self
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef InputSizeType::SizeValueType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::SizeValueType
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
typedef ImageToImageFilter< TInputImage, TOutputImage > itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::Superclass

Member Enumeration Documentation

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
enum itk::ConvolutionImageFilterBase::OutputRegionModeType
Enumerator:
SAME 
VALID 

Definition at line 90 of file itkConvolutionImageFilterBase.h.


Constructor & Destructor Documentation

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::ConvolutionImageFilterBase ( ) [protected]
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::~ConvolutionImageFilterBase ( ) [inline, protected]

Definition at line 113 of file itkConvolutionImageFilterBase.h.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::ConvolutionImageFilterBase ( const Self ) [private]

Member Function Documentation

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::GenerateOutputInformation ( ) [protected, virtual]

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

Reimplemented from itk::ProcessObject.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
virtual BoundaryConditionPointerType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::GetBoundaryCondition ( ) const [virtual]

Set/get the boundary condition.

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

Set/get the image kernel.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
virtual const char* itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::GetNameOfClass ( ) const [virtual]
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
virtual bool itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::GetNormalize ( ) const [virtual]

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

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
virtual OutputRegionModeType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::GetOutputRegionMode ( ) const [virtual]

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

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

Get the valid region of the convolution.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
virtual void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::NormalizeOff ( ) [virtual]

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

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

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

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::operator= ( const Self ) [private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

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

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

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
virtual void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::SetBoundaryCondition ( BoundaryConditionPointerType  _arg) [virtual]

Set/get the boundary condition.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
virtual void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::SetKernelImage ( const KernelImageType input) [virtual]

Set/get the image kernel.

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

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

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
virtual void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::SetOutputRegionMode ( const OutputRegionModeType  _arg) [virtual]

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

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

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

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

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

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
virtual void itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::VerifyInputInformation ( ) [inline, protected, virtual]

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

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

Definition at line 126 of file itkConvolutionImageFilterBase.h.


Member Data Documentation

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
const unsigned int itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension [static]
template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
BoundaryConditionPointerType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::m_BoundaryCondition [private]

Definition at line 135 of file itkConvolutionImageFilterBase.h.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
DefaultBoundaryConditionType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::m_DefaultBoundaryCondition [private]

Definition at line 134 of file itkConvolutionImageFilterBase.h.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
bool itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::m_Normalize [private]

Definition at line 132 of file itkConvolutionImageFilterBase.h.

template<class TInputImage , class TKernelImage = TInputImage, class TOutputImage = TInputImage>
OutputRegionModeType itk::ConvolutionImageFilterBase< TInputImage, TKernelImage, TOutputImage >::m_OutputRegionMode [private]

Definition at line 137 of file itkConvolutionImageFilterBase.h.


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