itkAdaptiveHistogramEqualizationImageFilter.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 itkAdaptiveHistogramEqualizationImageFilter_h
#define itkAdaptiveHistogramEqualizationImageFilter_h
 
#include "itkMovingHistogramImageFilter.h"
#include "itkAdaptiveEqualizationHistogram.h"
#include "itkImage.h"
 
namespace itk
{
template <typename TImageType, typename TKernel = Neighborhood<bool, TImageType::ImageDimension>>
class ITK_TEMPLATE_EXPORT AdaptiveHistogramEqualizationImageFilter
  : public MovingHistogramImageFilter<
      TImageType,
      TImageType,
      TKernel,
      typename Function::AdaptiveEqualizationHistogram<typename TImageType::PixelType, typename TImageType::PixelType>>
 
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(AdaptiveHistogramEqualizationImageFilter);

  using Self = AdaptiveHistogramEqualizationImageFilter;
  using Superclass = MovingHistogramImageFilter<
    TImageType,
    TImageType,
    TKernel,
    typename Function::AdaptiveEqualizationHistogram<typename TImageType::PixelType, typename TImageType::PixelType>>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  static constexpr unsigned int ImageDimension = TImageType::ImageDimension;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(AdaptiveHistogramEqualizationImageFilter);

  using ImageType = TImageType;
  using InputPixelType = typename ImageType::PixelType;
  using ImageSizeType = typename ImageType::SizeType;

  itkSetMacro(Alpha, float);
  itkGetConstMacro(Alpha, float);

  itkSetMacro(Beta, float);
  itkGetConstMacro(Beta, float);
 
#if !defined(ITK_FUTURE_LEGACY_REMOVE)
  virtual void
  SetUseLookupTable(const bool _arg)
  {
    itkDebugMacro("setting UseLookupTable to " << _arg);
    itkGenericLegacyReplaceBodyMacro("UseLookupTable", "", "nothing");
    if (this->m_UseLookupTable != _arg)
    {
      this->m_UseLookupTable = _arg;
      this->Modified();
    }
  }
 
  itkGetConstMacro(UseLookupTable, bool);
  itkBooleanMacro(UseLookupTable);
#endif
 
  void
  ConfigureHistogram(typename Superclass::HistogramType & h) override
  {
    h.SetAlpha(this->m_Alpha);
    h.SetBeta(this->m_Beta);
    h.SetMinimum(this->m_InputMinimum);
    h.SetMaximum(this->m_InputMaximum);
 
    typename Superclass::HistogramType::RealType kernelSize = 1;
    for (unsigned int i = 0; i < ImageDimension; ++i)
    {
      kernelSize *= (2 * this->GetRadius()[i] + 1);
    }
    h.SetKernelSize(kernelSize);
  }
 
protected:
  AdaptiveHistogramEqualizationImageFilter()
  {
    m_Alpha = .3;
    m_Beta = .3;
 
    this->SetRadius(5);
 
    m_InputMinimum = NumericTraits<InputPixelType>::min();
    m_InputMaximum = NumericTraits<InputPixelType>::max();
 
    m_UseLookupTable = false;
  }
 
  ~AdaptiveHistogramEqualizationImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  BeforeThreadedGenerateData() override;
 
private:
  float m_Alpha{};
  float m_Beta{};
 
  InputPixelType m_InputMinimum{};
  InputPixelType m_InputMaximum{};
 
  bool m_UseLookupTable{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkAdaptiveHistogramEqualizationImageFilter.hxx"
#endif
 
#endif