itkStructuralSimilarityImageFilter.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 itkStructuralSimilarityImageFilter_h
#define itkStructuralSimilarityImageFilter_h
 
#include "itkArray.h"
#include "itkImage.h"
#include "itkImageToImageFilter.h"
#include "itkNumericTraits.h"
 
#include <type_traits>
 
namespace itk
{
template <typename TInputImage, typename TOutputImage = Image<float, TInputImage::ImageDimension>>
class ITK_TEMPLATE_EXPORT StructuralSimilarityImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(StructuralSimilarityImageFilter);

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

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(StructuralSimilarityImageFilter);

  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;
  using InputPixelType = typename InputImageType::PixelType;
  using OutputPixelType = typename OutputImageType::PixelType;
  using InputImageRegionType = typename InputImageType::RegionType;
  using OutputImageRegionType = typename OutputImageType::RegionType;
  using SizeType = typename InputImageType::SizeType;
  using IndexType = typename InputImageType::IndexType;
 
  static constexpr unsigned int ImageDimension = InputImageType::ImageDimension;

  using RealType = typename NumericTraits<InputPixelType>::RealType;

  using ScaleWeightsType = Array<RealType>;

  void
  SetInput1(const InputImageType * image)
  {
    this->SetInput(image);
  }
  const InputImageType *
  GetInput1() const
  {
    return this->GetInput(0);
  }


  void
  SetInput2(const InputImageType * image);
  const InputImageType *
  GetInput2() const;

  itkSetMacro(GaussianSigma, double);
  itkGetConstMacro(GaussianSigma, double);

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

  itkSetMacro(K1, double);
  itkGetConstMacro(K1, double);

  itkSetMacro(K2, double);
  itkGetConstMacro(K2, double);

  itkSetMacro(DynamicRange, double);
  itkGetConstMacro(DynamicRange, double);

  itkSetMacro(LuminanceExponent, double);
  itkGetConstMacro(LuminanceExponent, double);

  itkSetMacro(ContrastExponent, double);
  itkGetConstMacro(ContrastExponent, double);

  itkSetMacro(StructureExponent, double);
  itkGetConstMacro(StructureExponent, double);

  void
  SetScaleWeights(const ScaleWeightsType & weights);
  itkGetConstReferenceMacro(ScaleWeights, ScaleWeightsType);

  itkGetConstMacro(MeanSSIM, double);
 
  itkConceptMacro(InputHasNumericTraitsCheck, (Concept::HasNumericTraits<InputPixelType>));
 
protected:
  StructuralSimilarityImageFilter();
  ~StructuralSimilarityImageFilter() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  VerifyPreconditions() const override;

  void
  EnlargeOutputRequestedRegion(DataObject * data) override;

  void
  GenerateData() override;
 
private:
  double       m_GaussianSigma{ 1.5 };
  unsigned int m_MaximumKernelWidth{ 11 };
  double       m_K1{ 0.01 };
  double       m_K2{ 0.03 };

  static constexpr double
  DefaultDynamicRange()
  {
    if constexpr (std::is_floating_point_v<InputPixelType>)
    {
      return 1.0;
    }
    else
    {
      return static_cast<double>(NumericTraits<InputPixelType>::max()) -
             static_cast<double>(NumericTraits<InputPixelType>::min());
    }
  }
  double m_DynamicRange{ DefaultDynamicRange() };
  double m_LuminanceExponent{ 1.0 };
  double m_ContrastExponent{ 1.0 };
  double m_StructureExponent{ 1.0 };
 
  ScaleWeightsType m_ScaleWeights{ 1, static_cast<RealType>(1.0) };
 
  double m_MeanSSIM{ 0.0 };
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkStructuralSimilarityImageFilter.hxx"
#endif
 
#endif