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

  using typename Superclass::SizeType;
 
  itkOverrideGetNameOfClassMacro(SobelOperator);

  void
  CreateDirectional() override
  {
    this->CreateToRadius(1);
  }

  // virtual void CreateToRadius(const unsigned long);

  void
  UseLegacyCoefficients(const bool useLegacyCoefficients)
  {
    m_UseLegacyCoefficients = useLegacyCoefficients;
  }

  bool
  IsUsingLegacyCoefficients() const
  {
    return m_UseLegacyCoefficients;
  }
 
protected:
  itkConceptMacro(SignedOutputPixelType, (Concept::Signed<typename NumericTraits<TPixel>::ValueType>));

  using typename Superclass::CoefficientVector;

  CoefficientVector
  GenerateCoefficients() override;

  void
  Fill(const CoefficientVector & coeff) override;
 
private:
#ifdef ITK_FUTURE_LEGACY_REMOVE
  bool m_UseLegacyCoefficients{ false };
#else
  bool m_UseLegacyCoefficients{ true };
#endif
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkSobelOperator.hxx"
#endif
 
#endif