itkHessianRecursiveGaussianImageFilter.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 itkHessianRecursiveGaussianImageFilter_h
#define itkHessianRecursiveGaussianImageFilter_h
 
#include "itkRecursiveGaussianImageFilter.h"
#include "itkNthElementImageAdaptor.h"
#include "itkImage.h"
#include "itkSymmetricSecondRankTensor.h"
#include "itkPixelTraits.h"
#include <array>
 
namespace itk
{
template <typename TInputImage,
          typename TOutputImage =
            Image<SymmetricSecondRankTensor<typename NumericTraits<typename TInputImage::PixelType>::RealType,
                                            TInputImage::ImageDimension>,
                  TInputImage::ImageDimension>>
class ITK_TEMPLATE_EXPORT HessianRecursiveGaussianImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(HessianRecursiveGaussianImageFilter);

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

  using InputImageType = TInputImage;
  using PixelType = typename TInputImage::PixelType;
  using RealType = typename NumericTraits<PixelType>::RealType;

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  static constexpr unsigned int NumberOfSmoothingFilters =
    (TInputImage::ImageDimension > 2) ? (TInputImage::ImageDimension - 2) : (0);

 
  using InternalRealType = float;
  using RealImageType = Image<InternalRealType, TInputImage::ImageDimension>;

  using OutputImageAdaptorType = NthElementImageAdaptor<TOutputImage, InternalRealType>;
 
  using OutputImageAdaptorPointer = typename OutputImageAdaptorType::Pointer;

  using GaussianFilterType = RecursiveGaussianImageFilter<RealImageType, RealImageType>;

  using DerivativeFilterAType = RecursiveGaussianImageFilter<InputImageType, RealImageType>;
 
  using DerivativeFilterBType = RecursiveGaussianImageFilter<RealImageType, RealImageType>;

  using GaussianFilterPointer = typename GaussianFilterType::Pointer;
 
#ifndef ITK_FUTURE_LEGACY_REMOVE
  using GaussianFiltersArray [[deprecated("This type alias is deprecated from ITK 6!")]] =
    std::vector<GaussianFilterPointer>;
#endif

  using DerivativeFilterAPointer = typename DerivativeFilterAType::Pointer;
  using DerivativeFilterBPointer = typename DerivativeFilterBType::Pointer;

  using OutputImagePointer = typename TOutputImage::Pointer;

  using OutputImageType = TOutputImage;
  using OutputPixelType = typename OutputImageType::PixelType;
  using OutputComponentType = typename PixelTraits<OutputPixelType>::ValueType;

  itkOverrideGetNameOfClassMacro(HessianRecursiveGaussianImageFilter);

  itkNewMacro(Self);

  void
  SetSigma(RealType sigma);
  RealType
  GetSigma() const;
  void
  SetNormalizeAcrossScale(bool normalize);
  itkGetConstMacro(NormalizeAcrossScale, bool);
  itkBooleanMacro(NormalizeAcrossScale);
  void
  GenerateInputRequestedRegion() override;
 
  itkConceptMacro(InputHasNumericTraitsCheck, (Concept::HasNumericTraits<PixelType>));
  itkConceptMacro(OutputHasPixelTraitsCheck, (Concept::HasPixelTraits<OutputPixelType>));
 
protected:
  HessianRecursiveGaussianImageFilter();
  ~HessianRecursiveGaussianImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  GenerateData() override;
 
  // Override since the filter produces the entire dataset
  void
  EnlargeOutputRequestedRegion(DataObject * output) override;
 
private:
  std::array<GaussianFilterPointer, NumberOfSmoothingFilters> m_SmoothingFilters{};
  DerivativeFilterAPointer                                    m_DerivativeFilterA{};
  DerivativeFilterBPointer                                    m_DerivativeFilterB{};
  OutputImageAdaptorPointer                                   m_ImageAdaptor{};

  bool m_NormalizeAcrossScale{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkHessianRecursiveGaussianImageFilter.hxx"
#endif
 
#endif