rtkTotalVariationImageFilter.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 rtkTotalVariationImageFilter_h
#define rtkTotalVariationImageFilter_h

#include <itkImageToImageFilter.h>
#include <itkNumericTraits.h>
#include <itkArray.h>
#include <itkSimpleDataObjectDecorator.h>

#include "rtkMacro.h"

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

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

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(TotalVariationImageFilter);

  using InputImagePointer = typename TInputImage::Pointer;

  using RegionType = typename TInputImage::RegionType;
  using SizeType = typename TInputImage::SizeType;
  using IndexType = typename TInputImage::IndexType;
  using PixelType = typename TInputImage::PixelType;

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  using RealType = typename itk::NumericTraits<PixelType>::RealType;

  using DataObjectPointer = typename itk::DataObject::Pointer;

  using RealObjectType = itk::SimpleDataObjectDecorator<RealType>;
  //  using PixelObjectType = SimpleDataObjectDecorator< PixelType >;

  RealType
  GetTotalVariation() const
  {
    return this->GetTotalVariationOutput()->Get();
  }
  RealObjectType *
  GetTotalVariationOutput();

  const RealObjectType *
  GetTotalVariationOutput() const;

  using DataObjectPointerArraySizeType = itk::ProcessObject::DataObjectPointerArraySizeType;
  using Superclass::MakeOutput;
  DataObjectPointer
  MakeOutput(DataObjectPointerArraySizeType output) override;

  // Begin concept checking
  itkConceptMacro(InputHasNumericTraitsCheck, (itk::Concept::HasNumericTraits<PixelType>));
  // End concept checking

  void
  SetUseImageSpacingOn()
  {
    this->SetUseImageSpacing(true);
  }

  void
  SetUseImageSpacingOff()
  {
    this->SetUseImageSpacing(false);
  }

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

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

  void
  AllocateOutputs() override;

  void
  BeforeThreadedGenerateData() override;

  void
  AfterThreadedGenerateData() override;

  void
  ThreadedGenerateData(const RegionType & outputRegionForThread, itk::ThreadIdType threadId) override;

  // Override since the filter needs all the data for the algorithm
  void
  GenerateInputRequestedRegion() override;

  // Override since the filter produces all of its output
  void
  EnlargeOutputRequestedRegion(itk::DataObject * data) override;

  bool m_UseImageSpacing;

private:
  itk::Array<RealType> m_SumOfSquareRoots;
}; // end of class
} // end namespace rtk

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

#endif