rtkDeconstructImageFilter.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 rtkDeconstructImageFilter_h
#define rtkDeconstructImageFilter_h

// Includes
#include <itkImageToImageFilter.h>
#include <itkMacro.h>
#include <itkMirrorPadImageFilter.h>

#include "rtkDaubechiesWaveletsConvolutionImageFilter.h"
#include "rtkDownsampleImageFilter.h"

namespace rtk
{

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

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

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(DeconstructImageFilter);

  static constexpr unsigned int ImageDimension = TImage::ImageDimension;

  using InputImageType = typename Superclass::InputImageType;
  using OutputImageType = typename Superclass::OutputImageType;
  using InputImagePointer = typename Superclass::InputImagePointer;
  using OutputImagePointer = typename Superclass::OutputImagePointer;
  using InputImageConstPointer = typename Superclass::InputImageConstPointer;
  using PixelType = typename TImage::PixelType;
  using InternalPixelType = typename TImage::InternalPixelType;

  using PadFilterType = itk::MirrorPadImageFilter<InputImageType, InputImageType>;
  using ConvolutionFilterType = rtk::DaubechiesWaveletsConvolutionImageFilter<InputImageType>;
  using DownsampleImageFilterType = rtk::DownsampleImageFilter<InputImageType>;

  virtual void
  SetNumberOfLevels(unsigned int levels)
  {
    this->m_NumberOfLevels = levels;
    this->ModifyInputOutputStorage();
  }

  virtual unsigned int
  GetNumberOfLevels()
  {
    return this->m_NumberOfLevels;
  }

  void
  GenerateOutputInformation() override;

  void
  GenerateInputRequestedRegion() override;

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

  typename InputImageType::SizeType *
  GetSizes()
  {
    return m_Sizes.data();
  }

  typename InputImageType::IndexType *
  GetIndices()
  {
    return m_Indices.data();
  }

protected:
  DeconstructImageFilter();
  ~DeconstructImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, itk::Indent indent) const override;

  void
  ModifyInputOutputStorage();

  void
  GenerateData() override;

  virtual unsigned int
  CalculateNumberOfOutputs();

  void
  GeneratePassVectors();

private:
  unsigned int m_NumberOfLevels{ 5 }; // Holds the number of deconstruction levels
  unsigned int m_Order{ 3 };          // Holds the order of the wavelet filters
  bool         m_PipelineConstructed{
    false
  }; // Filters instantiated by GenerateOutputInformation() should be instantiated only once

  typename std::vector<typename InputImageType::SizeType>  m_Sizes;      // Holds the size of sub-images at each level
  typename std::vector<typename InputImageType::IndexType> m_Indices;    // Holds the size of sub-images at each level
  typename std::vector<typename PadFilterType::Pointer>    m_PadFilters; // Holds a vector of padding filters
  typename std::vector<typename ConvolutionFilterType::Pointer>
    m_ConvolutionFilters; // Holds a vector of convolution filters
  typename std::vector<typename DownsampleImageFilterType::Pointer>
    m_DownsampleFilters; // Holds a vector of downsample filters
  // Holds a vector of PassVectors. A PassVector has Dimension components, each one storing either "High" or "Low"
  typename std::vector<typename ConvolutionFilterType::PassVector> m_PassVectors;
};

} // namespace rtk

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

#endif