itkMeanImageFunction.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 __itkMeanImageFunction_h
#define __itkMeanImageFunction_h

#include "itkImageFunction.h"
#include "itkNumericTraits.h"

namespace itk
{
template< class TInputImage, class TCoordRep = float >
class ITK_EXPORT MeanImageFunction:
  public ImageFunction< TInputImage,
                        typename NumericTraits< typename TInputImage::PixelType >::RealType,
                        TCoordRep >
{
public:

  typedef MeanImageFunction Self;
  typedef ImageFunction< TInputImage,
                         typename NumericTraits< typename TInputImage::PixelType >::RealType,
                         TCoordRep >                     Superclass;

  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  itkTypeMacro(MeanImageFunction, ImageFunction);

  itkNewMacro(Self);

  typedef TInputImage InputImageType;

  typedef typename Superclass::OutputType OutputType;

  typedef typename Superclass::IndexType IndexType;

  typedef typename Superclass::ContinuousIndexType ContinuousIndexType;

  typedef typename Superclass::PointType PointType;

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

  typedef typename NumericTraits< typename InputImageType::PixelType >::RealType
  RealType;

  virtual RealType EvaluateAtIndex(const IndexType & index) const;

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

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

  virtual RealType EvaluateAtContinuousIndex(
    const ContinuousIndexType & cindex) const
  {
    IndexType index;

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

  itkSetMacro(NeighborhoodRadius, unsigned int);
  itkGetConstReferenceMacro(NeighborhoodRadius, unsigned int);
protected:
  MeanImageFunction();
  ~MeanImageFunction(){}
  void PrintSelf(std::ostream & os, Indent indent) const;

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

  unsigned int m_NeighborhoodRadius;
};
} // end namespace itk

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

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

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

#endif