itkMeanImageFunction.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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 "itkImageNeighborhoodOffsets.h"
#include "itkNumericTraits.h"
#include "itkOffset.h"
 
#include <vector>
 
namespace itk
{
template <typename TInputImage, typename TCoordRep = float>
class ITK_TEMPLATE_EXPORT MeanImageFunction
  : public ImageFunction<TInputImage, typename NumericTraits<typename TInputImage::PixelType>::RealType, TCoordRep>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MeanImageFunction);
 
  using Self = MeanImageFunction;
  using Superclass =
    ImageFunction<TInputImage, typename NumericTraits<typename TInputImage::PixelType>::RealType, TCoordRep>;
 
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkTypeMacro(MeanImageFunction, ImageFunction);
 
  itkNewMacro(Self);
 
  using InputImageType = TInputImage;
 
  using typename Superclass::InputPixelType;
 
  using OutputType = typename Superclass::OutputType;
 
  using IndexType = typename Superclass::IndexType;
 
  using ContinuousIndexType = typename Superclass::ContinuousIndexType;
 
  using PointType = typename Superclass::PointType;
 
  using ImageSizeType = typename InputImageType::SizeType;
 
  static constexpr unsigned int ImageDimension = InputImageType::ImageDimension;
 
  using RealType = typename NumericTraits<typename InputImageType::PixelType>::RealType;
 
  RealType
  EvaluateAtIndex(const IndexType & index) const override;
 
  RealType
  Evaluate(const PointType & point) const override
  {
    IndexType index;
 
    this->ConvertPointToNearestIndex(point, index);
    return this->EvaluateAtIndex(index);
  }
 
  RealType
  EvaluateAtContinuousIndex(const ContinuousIndexType & cindex) const override
  {
    IndexType index;
 
    this->ConvertContinuousIndexToNearestIndex(cindex, index);
    return this->EvaluateAtIndex(index);
  }
 
  void
  SetNeighborhoodRadius(unsigned int);
  itkGetConstReferenceMacro(NeighborhoodRadius, unsigned int);
 
protected:
  MeanImageFunction();
  ~MeanImageFunction() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  unsigned int m_NeighborhoodRadius{ 1 };
 
  std::vector<Offset<ImageDimension>> m_NeighborhoodOffsets{ GenerateRectangularImageNeighborhoodOffsets(
    ImageSizeType::Filled(1)) };
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkMeanImageFunction.hxx"
#endif
 
#endif