itkVectorCentralDifferenceImageFunction.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 itkVectorCentralDifferenceImageFunction_h
#define itkVectorCentralDifferenceImageFunction_h

#include "itkImageFunction.h"
#include "itkMatrix.h"

namespace itk
{

template<
  typename TInputImage,
  typename TCoordRep = float >
class ITK_TEMPLATE_EXPORT VectorCentralDifferenceImageFunction:
  public ImageFunction< TInputImage,
                        Matrix< double,
                                TInputImage::PixelType::Dimension,
                                TInputImage::ImageDimension >,
                        TCoordRep >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(VectorCentralDifferenceImageFunction);

  using InputPixelType = typename TInputImage::PixelType;

  static constexpr unsigned int Dimension = InputPixelType::Dimension;

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  using Self = VectorCentralDifferenceImageFunction;
  using Superclass = ImageFunction< TInputImage,
                         Matrix< double, Self::Dimension,
                                 Self::ImageDimension >,
                         TCoordRep >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkTypeMacro(VectorCentralDifferenceImageFunction, ImageFunction);

  itkNewMacro(Self);

  using InputImageType = TInputImage;

  using OutputType = typename Superclass::OutputType;

  using IndexType = typename Superclass::IndexType;

  using ContinuousIndexType = typename Superclass::ContinuousIndexType;

  using PointType = typename Superclass::PointType;

  OutputType EvaluateAtIndex(const IndexType & index) const override;

  OutputType Evaluate(const PointType & point) const override
  {
    IndexType index;

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

  OutputType EvaluateAtContinuousIndex(
    const ContinuousIndexType & cindex) const override
  {
    IndexType index;

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

  itkSetMacro(UseImageDirection, bool);
  itkGetConstMacro(UseImageDirection, bool);
  itkBooleanMacro(UseImageDirection);

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

private:
  // flag to take or not the image direction into account
  // when computing the derivatives.
  bool m_UseImageDirection;
};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkVectorCentralDifferenceImageFunction.hxx"
#endif

#endif