itkDerivativeOperator.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 itkDerivativeOperator_h
#define itkDerivativeOperator_h
 
#include "itkNeighborhoodOperator.h"
 
namespace itk
{
template <typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
class ITK_TEMPLATE_EXPORT DerivativeOperator : public NeighborhoodOperator<TPixel, VDimension, TAllocator>
{
public:
  using Self = DerivativeOperator;
  using Superclass = NeighborhoodOperator<TPixel, VDimension, TAllocator>;

  itkOverrideGetNameOfClassMacro(DerivativeOperator);

  using typename Superclass::PixelRealType;

  void
  SetOrder(const unsigned int order)
  {
    this->m_Order = order;
  }

  unsigned int
  GetOrder() const
  {
    return m_Order;
  }
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override
  {
    Superclass::PrintSelf(os, indent);
 
    os << indent << "Order: " << m_Order << std::endl;
  }
 
protected:
  using typename Superclass::CoefficientVector;

  CoefficientVector
  GenerateCoefficients() override;

  void
  Fill(const CoefficientVector & coeff) override
  {
    Superclass::FillCenteredDirectional(coeff);
  }
 
private:
  unsigned int m_Order{ 1 };
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkDerivativeOperator.hxx"
#endif
 
#endif