itkHistogramMatchingImageFilter.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 itkHistogramMatchingImageFilter_h
#define itkHistogramMatchingImageFilter_h
 
#include "itkImageToImageFilter.h"
#include "itkHistogram.h"
#include "vnl/vnl_matrix.h"
 
namespace itk
{
/* THistogramMeasurement -- The precision level for which to do
  HistogramMeasurements */
template <typename TInputImage, typename TOutputImage, typename THistogramMeasurement = typename TInputImage::PixelType>
class ITK_TEMPLATE_EXPORT HistogramMatchingImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(HistogramMatchingImageFilter);

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

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(HistogramMatchingImageFilter);

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;

  using OutputImageRegionType = typename TOutputImage::RegionType;

  using typename Superclass::InputImageType;
  using typename Superclass::InputImagePointer;
  using typename Superclass::InputImageConstPointer;
  using typename Superclass::OutputImageType;
  using typename Superclass::OutputImagePointer;

  using InputPixelType = typename InputImageType::PixelType;
  using OutputPixelType = typename OutputImageType::PixelType;

  using HistogramType = Statistics::Histogram<THistogramMeasurement>;
  using HistogramPointer = typename HistogramType::Pointer;

  itkSetInputMacro(SourceImage, InputImageType);
  itkGetInputMacro(SourceImage, InputImageType);

  itkSetInputMacro(ReferenceImage, InputImageType);
  itkGetInputMacro(ReferenceImage, InputImageType);

  itkSetInputMacro(ReferenceHistogram, HistogramType);
  itkGetInputMacro(ReferenceHistogram, HistogramType);

  itkSetMacro(NumberOfHistogramLevels, SizeValueType);
  itkGetConstMacro(NumberOfHistogramLevels, SizeValueType);

  itkSetMacro(NumberOfMatchPoints, SizeValueType);
  itkGetConstMacro(NumberOfMatchPoints, SizeValueType);

  itkSetMacro(ThresholdAtMeanIntensity, bool);
  itkGetConstMacro(ThresholdAtMeanIntensity, bool);
  itkBooleanMacro(ThresholdAtMeanIntensity);

  itkSetMacro(GenerateReferenceHistogramFromImage, bool);
  itkGetConstMacro(GenerateReferenceHistogramFromImage, bool);
  itkBooleanMacro(GenerateReferenceHistogramFromImage);

  void
  GenerateInputRequestedRegion() override;

  itkGetModifiableObjectMacro(SourceHistogram, HistogramType);
  itkGetModifiableObjectMacro(OutputHistogram, HistogramType);
 
  itkConceptMacro(IntConvertibleToInputCheck, (Concept::Convertible<int, InputPixelType>));
  itkConceptMacro(SameDimensionCheck, (Concept::SameDimension<ImageDimension, OutputImageDimension>));
  itkConceptMacro(DoubleConvertibleToInputCheck, (Concept::Convertible<double, InputPixelType>));
  itkConceptMacro(DoubleConvertibleToOutputCheck, (Concept::Convertible<double, OutputPixelType>));
  itkConceptMacro(InputConvertibleToDoubleCheck, (Concept::Convertible<InputPixelType, double>));
  itkConceptMacro(OutputConvertibleToDoubleCheck, (Concept::Convertible<OutputPixelType, double>));
  itkConceptMacro(SameTypeCheck, (Concept::SameType<InputPixelType, OutputPixelType>));
 
protected:
  HistogramMatchingImageFilter();
  ~HistogramMatchingImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  BeforeThreadedGenerateData() override;
 
  void
  AfterThreadedGenerateData() override;
 
  void
  DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;
 

  void
  VerifyInputInformation() const override
  {}
 
  void
  VerifyPreconditions() const override;

  void
  ComputeMinMaxMean(const InputImageType *  image,
                    THistogramMeasurement & minValue,
                    THistogramMeasurement & maxValue,
                    THistogramMeasurement & meanValue);

  void
  ConstructHistogramFromIntensityRange(const InputImageType *      image,
                                       HistogramType *             histogram,
                                       const THistogramMeasurement minHistogramValidValue,
                                       const THistogramMeasurement maxHistogramValidValue,
                                       const THistogramMeasurement imageTrueMinValue,
                                       const THistogramMeasurement imageTrueMaxValue);
 
private:
  SizeValueType m_NumberOfHistogramLevels{ 256 };
  SizeValueType m_NumberOfMatchPoints{ 1 };
  bool          m_ThresholdAtMeanIntensity{ true };
 
  THistogramMeasurement m_SourceMinValue{};
  THistogramMeasurement m_SourceMaxValue{};
 
  THistogramMeasurement m_ReferenceMinValue{};
  THistogramMeasurement m_ReferenceMaxValue{};
 
  HistogramPointer m_SourceHistogram{};
  HistogramPointer m_OutputHistogram{};
 
  using TableType = vnl_matrix<double>;
  TableType m_QuantileTable{};
 
  using GradientArrayType = vnl_vector<double>;
  GradientArrayType m_Gradients{};
  double            m_LowerGradient{ 0.0 };
  double            m_UpperGradient{ 0.0 };
  bool              m_GenerateReferenceHistogramFromImage{ true };
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkHistogramMatchingImageFilter.hxx"
#endif
 
#endif