itkLabelOverlapMeasuresImageFilter.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 itkLabelOverlapMeasuresImageFilter_h
#define itkLabelOverlapMeasuresImageFilter_h
 
#include "itkImageSink.h"
#include "itkNumericTraits.h"
#include "itkLabelOverlapLabelSetMeasures.h"
#include <mutex>
#include <unordered_map>
 
namespace itk
{
template <typename TLabelImage>
class ITK_TEMPLATE_EXPORT LabelOverlapMeasuresImageFilter : public ImageSink<TLabelImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(LabelOverlapMeasuresImageFilter);

  using Self = LabelOverlapMeasuresImageFilter;
  using Superclass = ImageSink<TLabelImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(LabelOverlapMeasuresImageFilter);

  using LabelImageType = TLabelImage;
  using LabelImagePointer = typename TLabelImage::Pointer;
  using LabelImageConstPointer = typename TLabelImage::ConstPointer;
 
  using RegionType = typename TLabelImage::RegionType;
  using SizeType = typename TLabelImage::SizeType;
  using IndexType = typename TLabelImage::IndexType;
 
  using LabelType = typename TLabelImage::PixelType;

  using RealType = typename NumericTraits<LabelType>::RealType;
 
#ifndef ITK_FUTURE_LEGACY_REMOVE
  using LabelSetMeasures = LabelOverlapLabelSetMeasures;
#endif // !ITK_FUTURE_LEGACY_REMOVE

  using MapType = std::unordered_map<LabelType, LabelOverlapLabelSetMeasures>;
  using MapIterator = typename MapType::iterator;
  using MapConstIterator = typename MapType::const_iterator;

  static constexpr unsigned int ImageDimension = TLabelImage::ImageDimension;

  itkSetInputMacro(TargetImage, LabelImageType);
  itkGetInputMacro(TargetImage, LabelImageType);
  itkSetInputMacro(SourceImage, LabelImageType);
  itkGetInputMacro(SourceImage, LabelImageType);

  MapType
  GetLabelSetMeasures()
  {
    return this->m_LabelSetMeasures;
  }

  std::vector<LabelType>
  GetLabels() const
  {
    std::vector<LabelType> labels;
    labels.reserve(this->m_LabelSetMeasures.size());
    for (const auto & kv : this->m_LabelSetMeasures)
    {
      labels.push_back(kv.first);
    }
    return labels;
  }

  LabelOverlapLabelSetMeasures
  GetMeasureForLabel(LabelType label) const
  {
    const auto it = this->m_LabelSetMeasures.find(label);
    if (it == this->m_LabelSetMeasures.end())
    {
      itkExceptionMacro("Label " << static_cast<typename NumericTraits<LabelType>::PrintType>(label)
                                 << " is not present in the label set measures map.");
    }
    return it->second;
  }
 
  // Overlap agreement metrics

  RealType
  GetTotalOverlap() const;

  RealType GetTargetOverlap(LabelType) const;

  RealType
  GetUnionOverlap() const;
  RealType
  GetJaccardCoefficient() const
  {
    return this->GetUnionOverlap();
  }

  RealType GetUnionOverlap(LabelType) const;
  RealType
  GetJaccardCoefficient(LabelType label) const
  {
    return this->GetUnionOverlap(label);
  }

  RealType
  GetMeanOverlap() const;
  RealType
  GetDiceCoefficient() const
  {
    return this->GetMeanOverlap();
  }

  RealType GetMeanOverlap(LabelType) const;
  RealType
  GetDiceCoefficient(LabelType label) const
  {
    return this->GetMeanOverlap(label);
  }

  RealType
  GetVolumeSimilarity() const;

  RealType GetVolumeSimilarity(LabelType) const;
 
  // Overlap error metrics

  RealType
  GetFalseNegativeError() const;

  RealType GetFalseNegativeError(LabelType) const;

  RealType
  GetFalsePositiveError() const;

  RealType GetFalsePositiveError(LabelType) const;

  RealType
  GetFalseDiscoveryRate() const;

  RealType GetFalseDiscoveryRate(LabelType) const;
 
  itkConceptMacro(Input1HasNumericTraitsCheck, (Concept::HasNumericTraits<LabelType>));
 
protected:
  LabelOverlapMeasuresImageFilter();
  ~LabelOverlapMeasuresImageFilter() override = default;

  using PrintType = typename NumericTraits<LabelType>::PrintType;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  BeforeStreamedGenerateData() override;
 
  void
  ThreadedStreamedGenerateData(const RegionType &) override;
 
  void
  MergeMap(MapType & m1, MapType & m2) const;
 
private:
  MapType m_LabelSetMeasures{};
 
  std::mutex m_Mutex{};
}; // end of class
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkLabelOverlapMeasuresImageFilter.hxx"
#endif
 
#endif