itkDiscreteGaussianDerivativeImageFilter.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 itkDiscreteGaussianDerivativeImageFilter_h
#define itkDiscreteGaussianDerivativeImageFilter_h
 
#include "itkImageToImageFilter.h"
#include "itkImage.h"
 
namespace itk
{
 
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT DiscreteGaussianDerivativeImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(DiscreteGaussianDerivativeImageFilter);

  using Self = DiscreteGaussianDerivativeImageFilter;
  using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(DiscreteGaussianDerivativeImageFilter);

  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;

  using OutputPixelType = typename TOutputImage::PixelType;
  using OutputInternalPixelType = typename TOutputImage::InternalPixelType;
  using InputPixelType = typename TInputImage::PixelType;
  using InputInternalPixelType = typename TInputImage::InternalPixelType;

  static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension;

  using ArrayType = FixedArray<double, Self::ImageDimension>;

  using OrderArrayType = FixedArray<unsigned int, Self::ImageDimension>;

  itkSetMacro(Order, OrderArrayType);
  itkGetConstMacro(Order, const OrderArrayType);

  itkSetMacro(Variance, ArrayType);
  itkGetConstMacro(Variance, const ArrayType);

  itkSetMacro(MaximumError, ArrayType);
  itkGetConstMacro(MaximumError, const ArrayType);

  itkGetConstMacro(MaximumKernelWidth, int);
  itkSetMacro(MaximumKernelWidth, int);

  itkSetMacro(InternalNumberOfStreamDivisions, unsigned int);
  itkGetConstMacro(InternalNumberOfStreamDivisions, unsigned int);

  void
  SetOrder(const typename OrderArrayType::ValueType v)
  {
    auto a = MakeFilled<OrderArrayType>(v);
    this->SetOrder(a);
  }

 
  void
  SetVariance(const typename ArrayType::ValueType v)
  {
    auto a = MakeFilled<ArrayType>(v);
    this->SetVariance(a);
  }
 
  void
  SetMaximumError(const typename ArrayType::ValueType v)
  {
    auto a = MakeFilled<ArrayType>(v);
    this->SetMaximumError(a);
  }


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

  itkSetMacro(NormalizeAcrossScale, bool);
  itkGetConstMacro(NormalizeAcrossScale, bool);
  itkBooleanMacro(NormalizeAcrossScale);
 
  itkConceptMacro(OutputHasNumericTraitsCheck, (Concept::HasNumericTraits<OutputPixelType>));
 
protected:
  DiscreteGaussianDerivativeImageFilter()
  {
    m_Order.Fill(1);
    m_Variance.Fill(0.0);
    m_MaximumError.Fill(0.01);
    m_MaximumKernelWidth = 32;
    m_UseImageSpacing = true;
    m_NormalizeAcrossScale = false;
    m_InternalNumberOfStreamDivisions = ImageDimension * ImageDimension;
  }
 
  ~DiscreteGaussianDerivativeImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  GenerateInputRequestedRegion() override;

  void
  GenerateData() override;
 
private:
  OrderArrayType m_Order{};

  ArrayType m_Variance{};

  ArrayType m_MaximumError{};

  int m_MaximumKernelWidth{};

  bool m_UseImageSpacing{};

  bool m_NormalizeAcrossScale{};

  unsigned int m_InternalNumberOfStreamDivisions{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkDiscreteGaussianDerivativeImageFilter.hxx"
#endif
 
#endif