rtkDaubechiesWaveletsConvolutionImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright RTK 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
 *
 *         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 rtkDaubechiesWaveletsConvolutionImageFilter_h
#define rtkDaubechiesWaveletsConvolutionImageFilter_h

// Includes
#include <itkImageToImageFilter.h>
#include <itkConvolutionImageFilter.h>

#include "rtkMacro.h"

namespace rtk
{

template <typename TImage>
class ITK_TEMPLATE_EXPORT DaubechiesWaveletsConvolutionImageFilter : public itk::ImageToImageFilter<TImage, TImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(DaubechiesWaveletsConvolutionImageFilter);

  enum Pass
  {
    Low = 0x0, // Indicates to return the low-pass filter coefficients
    High = 0x1 // Indicates to return the high-pass filter coefficients
  };

  enum Type
  {
    Deconstruct = 0x0, // Indicates to deconstruct the image into levels/bands
    Reconstruct = 0x1  // Indicates to reconstruct the image from levels/bands
  };


  using Self = DaubechiesWaveletsConvolutionImageFilter;
  using Superclass = itk::ImageToImageFilter<TImage, TImage>;
  using Pointer = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;

  using OutputImageType = TImage;

  using OutputImagePixelType = typename TImage::PixelType;

  using OutputImageRegionType = typename TImage::RegionType;

  using PassVector = typename itk::Vector<typename Self::Pass, TImage::ImageDimension>;

#ifdef itkOverrideGetNameOfClassMacro
  itkOverrideGetNameOfClassMacro(DaubechiesWaveletsConvolutionImageFilter);
#else
  itkTypeMacro(DaubechiesWaveletsConvolutionImageFilter, itk::ImageSource);
#endif


  itkNewMacro(Self);

  using ConvolutionFilterType = typename itk::ConvolutionImageFilter<TImage>;

  void
  SetDeconstruction();

  void
  SetReconstruction();

  void
  PrintSelf(std::ostream & os, itk::Indent i) const override;

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

  itkSetMacro(Pass, PassVector);
  itkGetMacro(Pass, PassVector);

protected:
  DaubechiesWaveletsConvolutionImageFilter();
  ~DaubechiesWaveletsConvolutionImageFilter() override;

  using CoefficientVector = std::vector<typename TImage::PixelType>;

  CoefficientVector
  GenerateCoefficients();

  void
  GenerateData() override;

  void
  GenerateOutputInformation() override;

private:
  CoefficientVector
  GenerateCoefficientsLowpassDeconstruct();
  CoefficientVector
  GenerateCoefficientsHighpassDeconstruct();
  CoefficientVector
  GenerateCoefficientsLowpassReconstruct();
  CoefficientVector
  GenerateCoefficientsHighpassReconstruct();

  unsigned int m_Order{ 3 };

  PassVector m_Pass{ PassVector(typename PassVector::ComponentType(0)) };

  Type m_Type;
};

} // namespace rtk

// Include CXX
#ifndef rtk_MANUAL_INSTANTIATION
#  include "rtkDaubechiesWaveletsConvolutionImageFilter.hxx"
#endif

#endif