itkSumOfSquaresImageFunction.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
 *
 *         https://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 itkSumOfSquaresImageFunction_h
#define itkSumOfSquaresImageFunction_h
 
#include "itkImageFunction.h"
#include "itkImageNeighborhoodOffsets.h"
#include "itkNumericTraits.h"
#include "itkOffset.h"
 
#include <vector>
 
namespace itk
{
template <typename TInputImage, typename TCoordinate = float>
class ITK_TEMPLATE_EXPORT SumOfSquaresImageFunction
  : public ImageFunction<TInputImage, typename NumericTraits<typename TInputImage::PixelType>::RealType, TCoordinate>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(SumOfSquaresImageFunction);
 
  using Self = SumOfSquaresImageFunction;
  using Superclass =
    ImageFunction<TInputImage, typename NumericTraits<typename TInputImage::PixelType>::RealType, TCoordinate>;
 
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkOverrideGetNameOfClassMacro(SumOfSquaresImageFunction);
 
  itkNewMacro(Self);
 
  using InputImageType = TInputImage;
 
  using typename Superclass::InputPixelType;
 
  using typename Superclass::OutputType;
 
  using typename Superclass::IndexType;
 
  using typename Superclass::ContinuousIndexType;
 
  using 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);
  }
 
  itkGetConstReferenceMacro(NeighborhoodRadius, unsigned int);
 
  void
  SetNeighborhoodRadius(unsigned int radius)
  {
    m_NeighborhoodOffsets = GenerateRectangularImageNeighborhoodOffsets(ImageSizeType::Filled(radius));
    m_NeighborhoodRadius = radius;
    m_NeighborhoodSize = m_NeighborhoodOffsets.size();
  }
 
  itkGetConstReferenceMacro(NeighborhoodSize, unsigned int);
 
protected:
  SumOfSquaresImageFunction();
  ~SumOfSquaresImageFunction() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  unsigned int m_NeighborhoodRadius{};
  unsigned int m_NeighborhoodSize{};
 
  std::vector<Offset<ImageDimension>> m_NeighborhoodOffsets{ GenerateRectangularImageNeighborhoodOffsets(
    ImageSizeType::Filled(1)) };
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkSumOfSquaresImageFunction.hxx"
#endif
 
#endif