itkStatisticsImageFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkStatisticsImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2002/09/11 19:39:03 $
  Version:   $Revision: 1.7 $

  Copyright (c) 2002 Insight 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 __itkStatisticsImageFilter_h
#define __itkStatisticsImageFilter_h

#include "itkImageToImageFilter.h"
#include "itkNumericTraits.h"
#include "itkArray.h"

namespace itk {

template<class TInputImage>
class ITK_EXPORT StatisticsImageFilter : 
  public ImageToImageFilter<TInputImage, TInputImage>
{
public:
  typedef StatisticsImageFilter Self;
  typedef ImageToImageFilter<TInputImage,TInputImage>  Superclass;
  typedef SmartPointer<Self>        Pointer;
  typedef SmartPointer<const Self>  ConstPointer;
  
  itkNewMacro(Self);  

  itkTypeMacro(StatisticsImageFilter, ImageToImageFilter);
  
  typedef typename TInputImage::Pointer InputImagePointer;

  typedef typename TInputImage::RegionType RegionType ;
  typedef typename TInputImage::SizeType SizeType ;
  typedef typename TInputImage::IndexType IndexType ;
  typedef typename TInputImage::PixelType PixelType ;
  
  itkStaticConstMacro(ImageDimension, unsigned int,
                      TInputImage::ImageDimension ) ;

  typedef typename NumericTraits<PixelType>::RealType RealType;
  
  itkGetMacro(Minimum,RealType);

  itkGetMacro(Maximum,RealType);

  itkGetMacro(Mean,RealType);

  itkGetMacro(Sigma,RealType);

  itkGetMacro(Variance,RealType);

  itkGetMacro(Sum,RealType);

protected:
  StatisticsImageFilter(): m_ThreadSum(1), m_SumOfSquares(1), m_Count(1), m_ThreadMin(1), m_ThreadMax(1)
    {
      m_Minimum = NumericTraits<RealType>::max();
      m_Maximum = NumericTraits<RealType>::NonpositiveMin();
      m_Mean = NumericTraits<RealType>::max();
      m_Sigma = NumericTraits<RealType>::max();
      m_Variance = NumericTraits<RealType>::max();
      m_Sum = NumericTraits<RealType>::Zero;
    };
  
  ~StatisticsImageFilter(){};
  void PrintSelf(std::ostream& os, Indent indent) const;

  void AllocateOutputs();      

  void BeforeThreadedGenerateData ();
  
  void AfterThreadedGenerateData ();
  
  void  ThreadedGenerateData (const RegionType& 
                              outputRegionForThread,
                              int threadId) ;

  // Override since the filter needs all the data for the algorithm
  void GenerateInputRequestedRegion();

  // Override since the filter produces all of its output
  void EnlargeOutputRequestedRegion(DataObject *data);

 private:
  StatisticsImageFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  RealType m_Minimum;
  RealType m_Maximum;
  RealType m_Mean;
  RealType m_Sigma;
  RealType m_Variance;
  RealType m_Sum;

  Array<RealType> m_ThreadSum;
  Array<RealType> m_SumOfSquares;
  Array<long>     m_Count;
  Array<RealType> m_ThreadMin;
  Array<RealType> m_ThreadMax;

} ; // end of class

} // end namespace itk
  
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkStatisticsImageFilter.txx"
#endif

#endif

---