rtkPolynomialGainCorrectionImageFilter.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 rtkPolynomialGainCorrectionImageFilter_h
#define rtkPolynomialGainCorrectionImageFilter_h

#include <itkImageToImageFilter.h>

#include <vector>

#include "rtkMacro.h"

namespace rtk
{

template <class TInputImage, class TOutputImage>
class ITK_TEMPLATE_EXPORT PolynomialGainCorrectionImageFilter
  : public itk::ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(PolynomialGainCorrectionImageFilter);

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

  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;
  using InputImagePointer = typename InputImageType::Pointer;
  using OutputImagePointer = typename OutputImageType::Pointer;
  using InputImageRegionType = typename InputImageType::RegionType;
  using OutputImageRegionType = typename TOutputImage::RegionType;
  using VectorType = typename std::vector<float>;
  using OutputSizeType = typename OutputImageType::SizeType;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(PolynomialGainCorrectionImageFilter);

  void
  SetDarkImage(InputImageType * darkImage);

  void
  SetGainCoefficients(OutputImageType * gain);

  /* if K==0, the filter is bypassed */
  itkSetMacro(K, float);
  itkGetMacro(K, float);

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

  void
  GenerateOutputInformation() override;

  void
  GenerateInputRequestedRegion() override;

  void
  DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;

  bool               m_MapsLoaded{ false }; // True if gain maps loaded
  int                m_VModelOrder{ 1 };    // Polynomial correction order
  float              m_K{ 1.0f };           // Scaling constant, a 0 means no correction
  VectorType         m_PowerLut;            // Vector containing I^n
  InputImagePointer  m_DarkImage;           // Dark image
  OutputImagePointer m_GainImage;           // Gain coefficients (A matrix)
  OutputSizeType     m_GainSize;            // Gain map size
};                                          // end of class

} // namespace rtk

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

#endif