mitkImageStatisticsContainer.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef mitkImageStatisticsContainer_h
#define mitkImageStatisticsContainer_h
 
#include <MitkImageStatisticsExports.h>
#include <mitkBaseData.h>
#include <itkHistogram.h>
#include <mitkLabelSetImage.h>
#include <mitkImageStatisticsConstants.h>
 
#include <boost/variant.hpp>
 
namespace mitk
{
 
  class MITKIMAGESTATISTICS_EXPORT ImageStatisticsContainer : public mitk::BaseData
  {
  public:
    mitkClassMacro(ImageStatisticsContainer, mitk::BaseData);
    itkFactorylessNewMacro(Self);
    itkCloneMacro(Self);
 
    using HistogramType = itk::Statistics::Histogram<double>;
    using LabelValueType = MultiLabelSegmentation::LabelValueType;
 
    void SetRequestedRegionToLargestPossibleRegion() override {}
 
    bool RequestedRegionIsOutsideOfTheBufferedRegion() override { return false; }
 
    bool VerifyRequestedRegion() override { return true; }
 
    void SetRequestedRegion(const itk::DataObject*) override {}
 
    class MITKIMAGESTATISTICS_EXPORT ImageStatisticsObject {
    public:
      ImageStatisticsObject();
 
      using RealType = double;
      using IndexType = vnl_vector<int>;
      using VoxelCountType = unsigned long;
 
      using StatisticsVariantType = boost::variant<RealType, VoxelCountType, IndexType >;
 
      void AddStatistic(const std::string_view key, StatisticsVariantType value);
 
      using StatisticNameVector = std::vector<std::string>;
 
      static const StatisticNameVector& GetDefaultStatisticNames();
 
      const StatisticNameVector& GetCustomStatisticNames() const;
 
      StatisticNameVector GetAllStatisticNames() const;
 
      StatisticNameVector GetExistingStatisticNames() const;
 
      bool HasStatistic(const std::string_view name) const;
 
      template <typename TType>
      TType GetValueConverted(const std::string_view name) const
      {
        auto value = GetValueNonConverted(name);
        return boost::get<TType>(value);
      }
 
      StatisticsVariantType GetValueNonConverted(const std::string_view name) const;
 
      void Reset();
 
      HistogramType::ConstPointer m_Histogram=nullptr;
    private:
 
      using StatisticsMapType = std::map < std::string, StatisticsVariantType, std::less<>>;
 
      StatisticsMapType m_Statistics;
      StatisticNameVector m_CustomNames;
      static const StatisticNameVector m_DefaultNames;
    };
 
    using StatisticsVariantType = ImageStatisticsObject::StatisticsVariantType;
    using RealType = ImageStatisticsObject::RealType;
    using IndexType = ImageStatisticsObject::IndexType;
    using VoxelCountType = ImageStatisticsObject::VoxelCountType;
 
    using TimeStepVectorType = std::vector<TimeStepType>;
 
    TimeStepVectorType GetExistingTimeSteps(LabelValueType labelValue) const;
 
    static constexpr LabelValueType NO_MASK_LABEL_VALUE = Label::UNLABELED_VALUE;
    using LabelValueVectorType = MultiLabelSegmentation::LabelValueVectorType;
 
    LabelValueVectorType GetExistingLabelValues() const;
 
    void Reset();
 
    const ImageStatisticsObject& GetStatistics(LabelValueType labelValue, TimeStepType timeStep) const;
 
    void SetStatistics(LabelValueType labelValue, TimeStepType timeStep, const ImageStatisticsObject& statistics);
 
    bool StatisticsExist(LabelValueType labelValue, TimeStepType timeStep) const;
 
    const HistogramType* GetHistogram(LabelValueType labelValue, TimeStepType timeStep) const;
 
    bool IgnoresZeroVoxel() const;
 
    bool IsWIP() const;
 
  protected:
    ImageStatisticsContainer();
    ImageStatisticsContainer(const ImageStatisticsContainer &other);
    void PrintSelf(std::ostream &os, itk::Indent indent) const override;
 
    mitkCloneMacro(Self);
 
  private:
 
    using TimeStepMapType = std::map<TimeStepType, ImageStatisticsObject>;
    using LabelMapType = std::map<LabelValueType, TimeStepMapType>;
 
    LabelMapType m_LabelTimeStep2StatisticsMap;
  };
 
  MITKIMAGESTATISTICS_EXPORT ImageStatisticsContainer::ImageStatisticsObject::StatisticNameVector GetAllStatisticNames(const ImageStatisticsContainer* container);
 
  MITKIMAGESTATISTICS_EXPORT ImageStatisticsContainer::ImageStatisticsObject::StatisticNameVector GetAllStatisticNames(std::vector<ImageStatisticsContainer::ConstPointer> containers);
}
#endif