itkSTAPLEImageFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkSTAPLEImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2009-04-23 03:53:37 $
  Version:   $Revision: 1.4 $

  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 __itkSTAPLEImageFilter_h
#define __itkSTAPLEImageFilter_h

#include "itkImageToImageFilter.h"
#include "itkImage.h"
#include <vector>

namespace itk
{
template <typename TInputImage, typename TOutputImage>
class ITK_EXPORT STAPLEImageFilter :
    public ImageToImageFilter< TInputImage, TOutputImage >
{
public:
  typedef STAPLEImageFilter                               Self;
  typedef ImageToImageFilter< TInputImage, TOutputImage > Superclass;
  typedef SmartPointer<Self>                              Pointer;
  typedef SmartPointer<const Self>                        ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(STAPLEImageFilter, ImageToImageFilter);

  typedef typename TOutputImage::PixelType                 OutputPixelType;
  typedef typename TInputImage::PixelType                  InputPixelType;
  typedef typename NumericTraits<InputPixelType>::RealType RealType;

  itkStaticConstMacro(ImageDimension, unsigned int,
                      TOutputImage::ImageDimension);

  typedef TInputImage                       InputImageType;
  typedef typename InputImageType::Pointer  InputImagePointer;
  typedef TOutputImage                      OutputImageType;
  typedef typename OutputImageType::Pointer OutputImagePointer;

  typedef typename Superclass::OutputImageRegionType OutputImageRegionType;

  itkSetMacro(ForegroundValue, InputPixelType);
  itkGetConstMacro(ForegroundValue, InputPixelType);

  const std::vector<double> &GetSpecificity() const
    {
    return m_Specificity;
    }

  const std::vector<double> &GetSensitivity() const
    {
    return m_Sensitivity;
    }

  double GetSensitivity(unsigned int i)
    {
    if (i > this->GetNumberOfInputs())
      {
      itkExceptionMacro(<< "Array reference out of bounds.");
      }
    return m_Sensitivity[i];
    }

  double GetSpecificity(unsigned int i)
    {
    if (i > this->GetNumberOfInputs())
      {
      itkExceptionMacro(<< "Array reference out of bounds.");
      }
    return m_Specificity[i];
    }

  itkSetMacro(MaximumIterations, unsigned int);
  itkGetConstMacro(MaximumIterations, unsigned int);

  itkSetMacro(ConfidenceWeight, double);
  itkGetConstMacro(ConfidenceWeight, double);

  itkGetConstMacro(ElapsedIterations, unsigned int);

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro(InputHasNumericTraitsCheck,
                  (Concept::HasNumericTraits<InputPixelType>));

#endif

protected:
  STAPLEImageFilter()
    {
    m_ForegroundValue = NumericTraits<InputPixelType>::One;
    m_MaximumIterations = NumericTraits<unsigned int>::max();
    m_ElapsedIterations = 0;
    m_ConfidenceWeight = 1.0;
    }
  virtual ~STAPLEImageFilter() {}  
  void GenerateData( );
  
  void PrintSelf(std::ostream&, Indent) const;

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

  InputPixelType m_ForegroundValue;
  unsigned int   m_ElapsedIterations;
  unsigned int   m_MaximumIterations;

  double m_ConfidenceWeight;
  
  std::vector<double> m_Sensitivity;
  std::vector<double> m_Specificity;
};
  
} // end namespace itk

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

#endif