rtkBoellaardScatterCorrectionImageFilter.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 rtkBoellaardScatterCorrectionImageFilter_h
#define rtkBoellaardScatterCorrectionImageFilter_h

#include <itkInPlaceImageFilter.h>
#include "rtkConfiguration.h"

namespace rtk
{

template <class TInputImage, class TOutputImage = TInputImage>
class ITK_TEMPLATE_EXPORT BoellaardScatterCorrectionImageFilter
  : public itk::InPlaceImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(BoellaardScatterCorrectionImageFilter);

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

  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;
  using OutputImageRegionType = typename OutputImageType::RegionType;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(BoellaardScatterCorrectionImageFilter);

  itkGetMacro(AirThreshold, double);
  itkSetMacro(AirThreshold, double);

  itkGetMacro(ScatterToPrimaryRatio, double);
  itkSetMacro(ScatterToPrimaryRatio, double);

  itkGetMacro(NonNegativityConstraintThreshold, double);
  itkSetMacro(NonNegativityConstraintThreshold, double);

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

  void
  EnlargeOutputRequestedRegion(itk::DataObject * itkNotUsed(output)) override;
  void
  ThreadedGenerateData(const OutputImageRegionType & outputRegionForThread, ThreadIdType threadId) override;

  unsigned int
  SplitRequestedRegion(unsigned int i, unsigned int num, OutputImageRegionType & splitRegion) override;
  virtual int
  SplitRequestedRegion(int i, int num, OutputImageRegionType & splitRegion);

private:
  double m_AirThreshold{ 32000 };

  double m_ScatterToPrimaryRatio{ 0. };

  double m_NonNegativityConstraintThreshold{ 20 };
}; // end of class

} // end namespace rtk

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

#endif