itkKappaSigmaThresholdImageFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkKappaSigmaThresholdImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2009-04-23 03:43:41 $
  Version:   $Revision: 1.6 $

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

#include "itkImageToImageFilter.h"
#include "itkKappaSigmaThresholdImageCalculator.h"

namespace itk {

template<class TInputImage, 
  class TMaskImage=Image<unsigned char,::itk::GetImageDimension<TInputImage>::ImageDimension>, 
  class TOutputImage=TInputImage>
class ITK_EXPORT KappaSigmaThresholdImageFilter : 
    public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  typedef KappaSigmaThresholdImageFilter                  Self;
  typedef ImageToImageFilter<TInputImage,TOutputImage>    Superclass;
  typedef SmartPointer<Self>                              Pointer;
  typedef SmartPointer<const Self>                        ConstPointer;

  itkNewMacro(Self);  

  itkTypeMacro(KappaSigmaThresholdImageFilter, ImageToImageFilter);

  typedef TInputImage                                     InputImageType;
  typedef TMaskImage                                      MaskImageType;

  typedef typename TInputImage::PixelType                 InputPixelType;
  typedef typename TOutputImage::PixelType                OutputPixelType;
  typedef typename TMaskImage::PixelType                  MaskPixelType;

  typedef typename TInputImage::Pointer                   InputImagePointer;
  typedef typename TOutputImage::Pointer                  OutputImagePointer;
  typedef typename TMaskImage::Pointer                    MaskImagePointer;

  itkSetMacro(OutsideValue,OutputPixelType);

  itkGetConstMacro(OutsideValue,OutputPixelType);

  itkSetMacro(InsideValue,OutputPixelType);

  itkGetConstMacro(InsideValue,OutputPixelType);

  itkGetConstMacro(Threshold,InputPixelType);

  itkSetMacro(MaskValue, MaskPixelType);
  itkGetConstMacro(MaskValue, MaskPixelType);

  itkSetMacro(SigmaFactor, double);
  itkGetConstMacro(SigmaFactor, double);

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

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro(OutputComparableCheck,
    (Concept::Comparable<OutputPixelType>));
  itkConceptMacro(OutputOStreamWritableCheck,
    (Concept::OStreamWritable<OutputPixelType>));

#endif

  void SetMaskImage(const MaskImageType *input)
    {
    // Process object is not const-correct so the const casting is required.
    this->SetNthInput( 1, const_cast<MaskImageType *>(input) );
    }

  const MaskImageType * GetMaskImage() const
    {
    return static_cast<MaskImageType*>(const_cast<DataObject *>(this->ProcessObject::GetInput(1)));
    }

  void SetInput1(const TInputImage *input)
    {
    this->SetInput( input );
    }

  void SetInput2(const MaskImageType *input)
    {
    this->SetMaskImage( input );
    }

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

  void GenerateInputRequestedRegion();
  void GenerateData ();

  typedef typename TInputImage::SizeType                InputSizeType;
  typedef typename TInputImage::IndexType               InputIndexType;
  typedef typename TInputImage::RegionType              InputImageRegionType;
  typedef typename TOutputImage::SizeType               OutputSizeType;
  typedef typename TOutputImage::IndexType              OutputIndexType;
  typedef typename TOutputImage::RegionType             OutputImageRegionType;

  typedef KappaSigmaThresholdImageCalculator< TInputImage, TMaskImage > CalculatorType;
  
  itkStaticConstMacro(InputImageDimension, unsigned int,
                      TInputImage::ImageDimension );
  itkStaticConstMacro(OutputImageDimension, unsigned int,
                      TOutputImage::ImageDimension );


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

  MaskPixelType             m_MaskValue;
  double                    m_SigmaFactor;
  unsigned int              m_NumberOfIterations;
  InputPixelType            m_Threshold;
  OutputPixelType           m_InsideValue;
  OutputPixelType           m_OutsideValue;


}; // end of class

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

#endif