itkThresholdImageFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkThresholdImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2008-10-18 16:11:15 $
  Version:   $Revision: 1.23 $

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

  Portions of this code are covered under the VTK copyright.
  See VTKCopyright.txt or http://www.kitware.com/VTKCopyright.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 __itkThresholdImageFilter_h
#define __itkThresholdImageFilter_h

#include "itkInPlaceImageFilter.h"

#include "itkConceptChecking.h"

namespace itk
{

template <class TImage>
class ITK_EXPORT ThresholdImageFilter : public InPlaceImageFilter<TImage,TImage>
{
public:
  typedef ThresholdImageFilter               Self;
  typedef InPlaceImageFilter<TImage,TImage>  Superclass;
  typedef SmartPointer<Self>                 Pointer;
  typedef SmartPointer<const Self>           ConstPointer;

  itkNewMacro(Self);  

  itkTypeMacro(ThresholdImageFilter, InPlaceImageFilter);

  typedef typename TImage::PixelType PixelType;

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro(PixelTypeComparableCheck,
                  (Concept::Comparable<PixelType>));
  itkConceptMacro(PixelTypeOStreamWritableCheck,
                  (Concept::OStreamWritable<PixelType>));

#endif

  itkSetMacro(OutsideValue,PixelType);

  itkGetMacro(OutsideValue,PixelType);

  void ThresholdAbove(const PixelType &thresh);

  void ThresholdBelow(const PixelType &thresh);

  void ThresholdOutside(const PixelType &lower, const PixelType &upper);

  itkSetMacro(Lower, PixelType);
  itkGetMacro(Lower, PixelType);

  itkSetMacro(Upper, PixelType);
  itkGetMacro(Upper, PixelType);

  typedef TImage                                InputImageType;
  typedef typename InputImageType::ConstPointer InputImagePointer;
  typedef typename InputImageType::RegionType   InputImageRegionType;
  typedef typename InputImageType::PixelType    InputImagePixelType;

  typedef TImage                                OutputImageType;
  typedef typename OutputImageType::Pointer     OutputImagePointer;
  typedef typename OutputImageType::RegionType  OutputImageRegionType;
  typedef typename OutputImageType::PixelType   OutputImagePixelType;

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

  void ThreadedGenerateData(const OutputImageRegionType& outputRegionForThread,
                            int threadId );

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

  PixelType m_OutsideValue;
  PixelType m_Lower;
  PixelType m_Upper;
};

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