itkSTAPLEImageFilter.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 itkSTAPLEImageFilter_h
#define itkSTAPLEImageFilter_h
 
#include "itkImageToImageFilter.h"
#include <vector>
 
namespace itk
{
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT STAPLEImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(STAPLEImageFilter);

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

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(STAPLEImageFilter);

  using OutputPixelType = typename TOutputImage::PixelType;
  using InputPixelType = typename TInputImage::PixelType;
  using RealType = typename NumericTraits<InputPixelType>::RealType;

  static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension;

  using InputImageType = TInputImage;
  using InputImagePointer = typename InputImageType::Pointer;
  using OutputImageType = TOutputImage;
  using OutputImagePointer = typename OutputImageType::Pointer;

  using typename Superclass::OutputImageRegionType;

  itkSetMacro(ForegroundValue, InputPixelType);
  itkGetConstMacro(ForegroundValue, InputPixelType);

  const std::vector<double> &
  GetSpecificity() const
  {
    return m_Specificity;
  }

  const std::vector<double> &
  GetSensitivity() const
  {
    return m_Sensitivity;
  }

  double
  GetSensitivity(unsigned int i)
  {
    if (i > this->GetNumberOfIndexedInputs())
    {
      itkExceptionMacro("Array reference out of bounds.");
    }
    return m_Sensitivity[i];
  }


  double
  GetSpecificity(unsigned int i)
  {
    if (i > this->GetNumberOfIndexedInputs())
    {
      itkExceptionMacro("Array reference out of bounds.");
    }
    return m_Specificity[i];
  }


  itkSetClampMacro(MaximumIterations, unsigned int, 1, NumericTraits<unsigned int>::max());
  itkGetConstMacro(MaximumIterations, unsigned int);

  itkSetMacro(ConfidenceWeight, double);
  itkGetConstMacro(ConfidenceWeight, double);

  itkGetConstMacro(ElapsedIterations, unsigned int);
 
  itkConceptMacro(InputHasNumericTraitsCheck, (Concept::HasNumericTraits<InputPixelType>));
 
protected:
  STAPLEImageFilter()
  {
    m_ForegroundValue = NumericTraits<InputPixelType>::OneValue();
    m_MaximumIterations = NumericTraits<unsigned int>::max();
    m_ElapsedIterations = 0;
    m_ConfidenceWeight = 1.0;
  }
 
  ~STAPLEImageFilter() override = default;
  void
  GenerateData() override;
 
  void
  PrintSelf(std::ostream &, Indent) const override;
 
private:
  InputPixelType m_ForegroundValue{};
  unsigned int   m_ElapsedIterations{};
  unsigned int   m_MaximumIterations{};
 
  double m_ConfidenceWeight{};
 
  std::vector<double> m_Sensitivity{};
  std::vector<double> m_Specificity{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkSTAPLEImageFilter.hxx"
#endif
 
#endif