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
#define MITKIMAGESTATISTICSCONTAINER

#include <MitkImageStatisticsExports.h>
#include <mitkBaseData.h>
#include <itkHistogram.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 RealType = double;
    using LabelIndex = unsigned int;
    using IndexType = vnl_vector<int>;
    using VoxelCountType = unsigned long;
    using StatisticsVariantType = boost::variant<RealType, VoxelCountType, IndexType >;
    using StatisticsMapType = std::map < std::string, StatisticsVariantType>;
    using StatisticsKeyType = std::string;

    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();
      void AddStatistic(const std::string& 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& name) const;

      template <typename TType>
      TType GetValueConverted(const std::string& name) const
      {
        auto value = GetValueNonConverted(name);
        return boost::get<TType>(value);
      }

      StatisticsVariantType GetValueNonConverted(const std::string& name) const;

      void Reset();

      HistogramType::ConstPointer m_Histogram=nullptr;
    private:
      StatisticsMapType m_Statistics;
      StatisticNameVector m_CustomNames;
      static const StatisticNameVector m_DefaultNames;
    };

    using TimeStepMapType = std::map<TimeStepType, ImageStatisticsObject>;

    unsigned int GetNumberOfTimeSteps() const;

    void Reset();

    const ImageStatisticsObject& GetStatisticsForTimeStep(TimeStepType timeStep) const;

    void SetStatisticsForTimeStep(TimeStepType timeStep, ImageStatisticsObject statistics);

    bool TimeStepExists(TimeStepType timeStep) const;

    const HistogramType* GetHistogramForTimeStep(TimeStepType timeStep) const;

  protected:
    ImageStatisticsContainer();
    void PrintSelf(std::ostream &os, itk::Indent indent) const override;

  private:
    itk::LightObject::Pointer InternalClone() const override;

    void SetTimeStepMap(TimeStepMapType map);

    TimeStepMapType m_TimeStepMap;
  };

  MITKIMAGESTATISTICS_EXPORT ImageStatisticsContainer::ImageStatisticsObject::StatisticNameVector GetAllStatisticNames(const ImageStatisticsContainer* container);
  MITKIMAGESTATISTICS_EXPORT ImageStatisticsContainer::ImageStatisticsObject::StatisticNameVector GetAllStatisticNames(std::vector<ImageStatisticsContainer::ConstPointer> containers);
}
#endif // MITKIMAGESTATISTICSCONTAINER