itkThresholdImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
/*=========================================================================
 *
 *  Portions of this file are subject to the VTK Toolkit Version 3 copyright.
 *
 *  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
 *
 *  For complete copyright, license and disclaimer of warranty information
 *  please refer to the NOTICE file at the top of the ITK source tree.
 *
 *=========================================================================*/
#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);

  itkGetConstMacro(OutsideValue, PixelType);

  void ThresholdAbove(const PixelType & thresh);

  void ThresholdBelow(const PixelType & thresh);

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

  itkSetMacro(Lower, PixelType);
  itkGetConstMacro(Lower, PixelType);

  itkSetMacro(Upper, PixelType);
  itkGetConstMacro(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,
                            ThreadIdType 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.hxx"
#endif

#endif