itkMaskedMeanImageFilter.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkMaskedMeanImageFilter.h,v $
  Language:  C++
  Date:      $Date$
  Version:   $Revision$

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkMaskedMeanImageFilter_h
#define __itkMaskedMeanImageFilter_h

#include "itkImageToImageFilter.h"
#include "itkImage.h"
#include "itkNumericTraits.h"

namespace itk
{
template <class TInputImage, class TOutputImage>
class ITK_EXPORT MaskedMeanImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  typedef TInputImage                           InputImageType;
  typedef TOutputImage                          OutputImageType;
  typedef typename InputImageType::Pointer      InputImagePointer;
  typedef typename InputImageType::ConstPointer InputImageConstPointer;
  typedef typename OutputImageType::Pointer     OutputImagePointer;

  typedef MaskedMeanImageFilter                               Self;
  typedef ImageToImageFilter<InputImageType, OutputImageType> Superclass;
  typedef SmartPointer<Self>                                  Pointer;
  typedef SmartPointer<const Self>                            ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro( MaskedMeanImageFilter, ImageToImageFilter );

  itkSetMacro( MinimumNumberOfUsedVoxels, int );
  itkGetMacro( MinimumNumberOfUsedVoxels, int );

  typedef typename InputImageType::PixelType               InputPixelType;
  typedef typename OutputImageType::PixelType              OutputPixelType;
  typedef typename NumericTraits<InputPixelType>::RealType InputRealType;
  typedef typename InputImageType::RegionType              InputImageRegionType;
  typedef typename OutputImageType::RegionType             OutputImageRegionType;
  typedef typename InputImageType::SizeType                InputSizeType;

  itkSetMacro(Radius, InputSizeType);
  itkGetConstReferenceMacro(Radius, InputSizeType);

  virtual void GenerateInputRequestedRegion()
  throw (InvalidRequestedRegionError);

protected:
  MaskedMeanImageFilter();
  virtual ~MaskedMeanImageFilter()
  {
  }
  void PrintSelf( std::ostream& os, Indent indent) const;

#if ITK_VERSION_MAJOR < 4
  void ThreadedGenerateData( const OutputImageRegionType & outputRegionForThread, int threadId );

#else
  void ThreadedGenerateData( const OutputImageRegionType & outputRegionForThread, ThreadIdType threadId );

#endif
private:
  MaskedMeanImageFilter(const Self &); // purposely not implemented
  void operator=(const Self &);        // purposely not implemented

  InputSizeType m_Radius;
  int           m_MinimumNumberOfUsedVoxels;

};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkMaskedMeanImageFilter.txx"
#endif

#endif