itkImageFunction.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 __itkImageFunction_h
#define __itkImageFunction_h

#include "itkFunctionBase.h"
#include "itkIndex.h"
#include "itkImageBase.h"

namespace itk
{
template<
  class TInputImage,
  class TOutput,
  class TCoordRep = float
  >
class ITK_EXPORT ImageFunction:
  public FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, TOutput >
{
public:
  itkStaticConstMacro(ImageDimension, unsigned int,
                      TInputImage::ImageDimension);

  typedef ImageFunction Self;
  typedef FunctionBase<
    Point< TCoordRep, itkGetStaticConstMacro(ImageDimension) >,
    TOutput >                                                   Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  itkTypeMacro(ImageFunction, FunctionBase);

  typedef TInputImage InputImageType;

  typedef typename InputImageType::PixelType InputPixelType;

  typedef typename InputImageType::ConstPointer InputImageConstPointer;

  typedef TOutput OutputType;

  typedef TCoordRep CoordRepType;

  typedef typename InputImageType::IndexType      IndexType;
  typedef typename InputImageType::IndexValueType IndexValueType;

  typedef ContinuousIndex< TCoordRep, itkGetStaticConstMacro(ImageDimension) >
  ContinuousIndexType;

  typedef Point< TCoordRep, itkGetStaticConstMacro(ImageDimension) > PointType;

  virtual void SetInputImage(const InputImageType *ptr);

  const InputImageType * GetInputImage() const
  { return m_Image.GetPointer(); }

  virtual TOutput Evaluate(const PointType & point) const = 0;

  virtual TOutput EvaluateAtIndex(const IndexType & index) const = 0;

  virtual TOutput EvaluateAtContinuousIndex(
    const ContinuousIndexType & index) const = 0;

  virtual bool IsInsideBuffer(const IndexType & index) const
  {
    for ( unsigned int j = 0; j < ImageDimension; j++ )
      {
      if ( index[j] < m_StartIndex[j] )
        {
        return false;
        }
      if ( index[j] > m_EndIndex[j] )
        {
        return false;
        }
      }
    return true;
  }

  virtual bool IsInsideBuffer(const ContinuousIndexType & index) const
  {
    for ( unsigned int j = 0; j < ImageDimension; j++ )
      {
      /* Test for negative of a positive so we can catch NaN's. */
      if ( ! (index[j] >= m_StartContinuousIndex[j] &&
             index[j] < m_EndContinuousIndex[j] ) )
        {
        return false;
        }
      }
    return true;
  }

  virtual bool IsInsideBuffer(const PointType & point) const
  {
    ContinuousIndexType index;
    m_Image->TransformPhysicalPointToContinuousIndex(point, index);
    /* Call IsInsideBuffer to test against BufferedRegion bounds.
     * TransformPhysicalPointToContinuousIndex tests against
     * LargestPossibleRegion */
    bool isInside = IsInsideBuffer( index );
    return isInside;
  }

  void ConvertPointToNearestIndex(const PointType & point,
                                  IndexType & index) const
  {
    ContinuousIndexType cindex;

    m_Image->TransformPhysicalPointToContinuousIndex(point, cindex);
    this->ConvertContinuousIndexToNearestIndex(cindex, index);
  }

  void ConvertPointToContinuousIndex(const PointType & point,
                                     ContinuousIndexType & cindex) const
  {
    m_Image->TransformPhysicalPointToContinuousIndex(point, cindex);
  }

  inline void ConvertContinuousIndexToNearestIndex(
                                  const ContinuousIndexType & cindex,
                                  IndexType &                 index) const
  {
    index.CopyWithRound(cindex);
  }

  itkGetConstReferenceMacro(StartIndex, IndexType);
  itkGetConstReferenceMacro(EndIndex, IndexType);

  itkGetConstReferenceMacro(StartContinuousIndex, ContinuousIndexType);
  itkGetConstReferenceMacro(EndContinuousIndex, ContinuousIndexType);
protected:
  ImageFunction();
  ~ImageFunction() {}
  void PrintSelf(std::ostream & os, Indent indent) const;

  InputImageConstPointer m_Image;

  IndexType m_StartIndex;
  IndexType m_EndIndex;

  ContinuousIndexType m_StartContinuousIndex;
  ContinuousIndexType m_EndContinuousIndex;
private:
  ImageFunction(const Self &);  //purposely not implemented
  void operator=(const Self &); //purposely not implemented
};
} // end namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_ImageFunction(_, EXPORT, TypeX, TypeY)             \
  namespace itk                                                         \
  {                                                                     \
  _( 3 ( class EXPORT ImageFunction< ITK_TEMPLATE_3 TypeX > ) )         \
  namespace Templates                                                   \
  {                                                                     \
  typedef ImageFunction< ITK_TEMPLATE_3 TypeX > ImageFunction##TypeY; \
  }                                                                     \
  }

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

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

#endif