itk::MaskedMeanImageFilter< TInputImage, TOutputImage > Class Template Reference

Applies an averaging filter to an image. More...

#include <itkMaskedMeanImageFilter.h>

Inheritance diagram for itk::MaskedMeanImageFilter< TInputImage, TOutputImage >:
ImageToImageFilter

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef
InputImageType::ConstPointer 
InputImageConstPointer
typedef InputImageType::Pointer InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef TInputImage InputImageType
typedef InputImageType::PixelType InputPixelType
typedef NumericTraits
< InputPixelType >::RealType 
InputRealType
typedef InputImageType::SizeType InputSizeType
typedef OutputImageType::Pointer OutputImagePointer
typedef OutputImageType::RegionType OutputImageRegionType
typedef TOutputImage OutputImageType
typedef OutputImageType::PixelType OutputPixelType
typedef SmartPointer< SelfPointer
typedef MaskedMeanImageFilter Self
typedef ImageToImageFilter
< InputImageType,
OutputImageType
Superclass

Public Member Functions

virtual void GenerateInputRequestedRegion () throw (InvalidRequestedRegionError)
 itkGetConstReferenceMacro (Radius, InputSizeType)
 itkGetMacro (MinimumNumberOfUsedVoxels, int)
 itkNewMacro (Self)
 itkSetMacro (Radius, InputSizeType)
 itkSetMacro (MinimumNumberOfUsedVoxels, int)
 itkTypeMacro (MaskedMeanImageFilter, ImageToImageFilter)

Protected Member Functions

 MaskedMeanImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)
virtual ~MaskedMeanImageFilter ()

Private Member Functions

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

Private Attributes

int m_MinimumNumberOfUsedVoxels
InputSizeType m_Radius

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::MaskedMeanImageFilter< TInputImage, TOutputImage >

Applies an averaging filter to an image.

Computes an image where a given pixel is the mean value of the the pixels in a neighborhood about the corresponding input pixel. Only uses pixels with values greater than zero!

A mean filter is one of the family of linear filters.

See also:
Image
Neighborhood
NeighborhoodOperator
NeighborhoodIterator

Member Typedef Documentation

template<class TInputImage , class TOutputImage >
typedef SmartPointer<const Self> itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::ConstPointer
template<class TInputImage , class TOutputImage >
typedef InputImageType::ConstPointer itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::InputImageConstPointer
template<class TInputImage , class TOutputImage >
typedef InputImageType::Pointer itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::InputImagePointer
template<class TInputImage , class TOutputImage >
typedef InputImageType::RegionType itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::InputImageRegionType
template<class TInputImage , class TOutputImage >
typedef TInputImage itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::InputImageType

Convenient typedefs for simplifying declarations.

template<class TInputImage , class TOutputImage >
typedef InputImageType::PixelType itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::InputPixelType

Image typedef support.

template<class TInputImage , class TOutputImage >
typedef NumericTraits<InputPixelType>::RealType itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::InputRealType
template<class TInputImage , class TOutputImage >
typedef InputImageType::SizeType itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::InputSizeType
template<class TInputImage , class TOutputImage >
typedef OutputImageType::Pointer itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::OutputImagePointer
template<class TInputImage , class TOutputImage >
typedef OutputImageType::RegionType itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::OutputImageRegionType
template<class TInputImage , class TOutputImage >
typedef TOutputImage itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::OutputImageType
template<class TInputImage , class TOutputImage >
typedef OutputImageType::PixelType itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::OutputPixelType
template<class TInputImage , class TOutputImage >
typedef SmartPointer<Self> itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::Pointer
template<class TInputImage , class TOutputImage >
typedef MaskedMeanImageFilter itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

template<class TInputImage , class TOutputImage >
typedef ImageToImageFilter< InputImageType, OutputImageType> itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::Superclass

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >
itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::MaskedMeanImageFilter (  )  [protected]
template<class TInputImage , class TOutputImage >
virtual itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::~MaskedMeanImageFilter (  )  [inline, protected, virtual]
template<class TInputImage , class TOutputImage >
itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::MaskedMeanImageFilter ( const Self  )  [private]

Member Function Documentation

template<class TInputImage , class TOutputImage >
virtual void itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion (  )  throw (InvalidRequestedRegionError) [virtual]

MaskedMeanImageFilter needs a larger input requested region than the output requested region. As such, MaskedMeanImageFilter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

See also:
ImageToImageFilter::GenerateInputRequestedRegion()
template<class TInputImage , class TOutputImage >
itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::itkGetConstReferenceMacro ( Radius  ,
InputSizeType   
)
template<class TInputImage , class TOutputImage >
itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::itkGetMacro ( MinimumNumberOfUsedVoxels  ,
int   
)
template<class TInputImage , class TOutputImage >
itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::itkNewMacro ( Self   ) 

Method for creation through the object factory.

template<class TInputImage , class TOutputImage >
itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::itkSetMacro ( Radius  ,
InputSizeType   
)

Set and get the radius of the neighborhood used to compute the mean.

template<class TInputImage , class TOutputImage >
itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::itkSetMacro ( MinimumNumberOfUsedVoxels  ,
int   
)

Set and get the minimum number of samples for reliable estimates.

template<class TInputImage , class TOutputImage >
itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::itkTypeMacro ( MaskedMeanImageFilter< TInputImage, TOutputImage >  ,
ImageToImageFilter   
)

Run-time type information (and related methods).

template<class TInputImage , class TOutputImage >
void itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::operator= ( const Self  )  [private]
template<class TInputImage , class TOutputImage >
void itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected]
template<class TInputImage , class TOutputImage >
void itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
int  threadId 
) [protected]

MaskedMeanImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See also:
ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Member Data Documentation

template<class TInputImage , class TOutputImage >
int itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::m_MinimumNumberOfUsedVoxels [private]
template<class TInputImage , class TOutputImage >
InputSizeType itk::MaskedMeanImageFilter< TInputImage, TOutputImage >::m_Radius [private]

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

Generated on 6 Apr 2011 for Slicer3 by  doxygen 1.6.1