itkBinaryThresholdImageFunction.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.
 *
 *=========================================================================*/
#ifndef __itkBinaryThresholdImageFunction_h
#define __itkBinaryThresholdImageFunction_h

#include "itkImageFunction.h"

namespace itk
{
template< class TInputImage, class TCoordRep = float >
class ITK_EXPORT BinaryThresholdImageFunction:
  public ImageFunction< TInputImage, bool, TCoordRep >
{
public:
  typedef BinaryThresholdImageFunction                  Self;
  typedef ImageFunction< TInputImage, bool, TCoordRep > Superclass;
  typedef SmartPointer< Self >                          Pointer;
  typedef SmartPointer< const Self >                    ConstPointer;

  itkTypeMacro(BinaryThresholdImageFunction, ImageFunction);

  itkNewMacro(Self);

  typedef typename Superclass::InputImageType InputImageType;

  typedef typename TInputImage::PixelType PixelType;

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

  typedef typename Superclass::PointType PointType;

  typedef typename Superclass::IndexType IndexType;

  typedef typename Superclass::ContinuousIndexType ContinuousIndexType;

  virtual bool Evaluate(const PointType & point) const
  {
    IndexType index;

    this->ConvertPointToNearestIndex(point, index);
    return ( this->EvaluateAtIndex(index) );
  }

  virtual bool EvaluateAtContinuousIndex(
    const ContinuousIndexType & index) const
  {
    IndexType nindex;

    this->ConvertContinuousIndexToNearestIndex (index, nindex);
    return this->EvaluateAtIndex(nindex);
  }

  virtual bool EvaluateAtIndex(const IndexType & index) const
  {
    PixelType value = this->GetInputImage()->GetPixel(index);

    return ( m_Lower <= value && value <= m_Upper );
  }

  itkGetConstReferenceMacro(Lower, PixelType);

  itkGetConstReferenceMacro(Upper, PixelType);

  void ThresholdAbove(PixelType thresh);

  void ThresholdBelow(PixelType thresh);

  void ThresholdBetween(PixelType lower, PixelType upper);

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

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

  PixelType m_Lower;
  PixelType m_Upper;
};
} // end namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_BinaryThresholdImageFunction(_, EXPORT, TypeX, TypeY)     \
  namespace itk                                                                \
  {                                                                            \
  _( 2 ( class EXPORT BinaryThresholdImageFunction< ITK_TEMPLATE_2 TypeX > ) ) \
  namespace Templates                                                          \
  {                                                                            \
  typedef BinaryThresholdImageFunction< ITK_TEMPLATE_2 TypeX >                 \
  BinaryThresholdImageFunction##TypeY;                                       \
  }                                                                            \
  }

#if ITK_TEMPLATE_EXPLICIT
#include "Templates/itkBinaryThresholdImageFunction+-.h"
#endif

#if ITK_TEMPLATE_TXX
#include "itkBinaryThresholdImageFunction.hxx"
#endif

#endif