rtkSoftThresholdTVImageFilter.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 rtkSoftThresholdTVImageFilter_h
#define rtkSoftThresholdTVImageFilter_h

#include <itkNeighborhoodIterator.h>
#include <itkImageToImageFilter.h>
#include <itkImage.h>
#include <itkVector.h>
#include "vnl/vnl_matrix.h"
#include "vnl/vnl_vector_fixed.h"
#include "vnl/algo/vnl_symmetric_eigensystem.h"
#include "rtkConfiguration.h"

namespace rtk
{
template <typename TInputImage, typename TOutputImage = TInputImage>
class ITK_TEMPLATE_EXPORT SoftThresholdTVImageFilter : public itk::ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(SoftThresholdTVImageFilter);

  using Self = SoftThresholdTVImageFilter;
  using Superclass = itk::ImageToImageFilter<TInputImage, TOutputImage>;
  using Pointer = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(SoftThresholdTVImageFilter);

  using OutputPixelType = typename TOutputImage::PixelType;
  using InputPixelType = typename TInputImage::PixelType;

  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;
  using InputImagePointer = typename InputImageType::Pointer;
  using OutputImagePointer = typename OutputImageType::Pointer;

  static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension;

  static constexpr unsigned int VectorDimension = InputPixelType::Dimension;

  using OutputImageRegionType = typename Superclass::OutputImageRegionType;

  itkConceptMacro(InputHasNumericTraitsCheck, (itk::Concept::HasNumericTraits<typename InputPixelType::ValueType>));

  itkGetMacro(Threshold, float);
  itkSetMacro(Threshold, float);

protected:
  SoftThresholdTVImageFilter();
  ~SoftThresholdTVImageFilter() override = default;

  //    void BeforeThreadedGenerateData();

  void
  DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;

  //    using ImageBaseType = typename InputImageType::Superclass;

private:
  float        m_Threshold;
  ThreadIdType m_RequestedNumberOfThreads;
};
} // namespace rtk

#ifndef ITK_MANUAL_INSTANTIATION
#  include "rtkSoftThresholdTVImageFilter.hxx"
#endif

#endif