QmitkDataGeneratorBase.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 QmitkDataGeneratorBase_h
#define QmitkDataGeneratorBase_h

#include <mutex>

//QT
#include <QObject>

//MITK
#include <mitkDataStorage.h>

#include "QmitkDataGenerationJobBase.h"

#include <MitkImageStatisticsUIExports.h>

class MITKIMAGESTATISTICSUI_EXPORT QmitkDataGeneratorBase : public QObject
{
  Q_OBJECT
public:
  QmitkDataGeneratorBase(const QmitkDataGeneratorBase& other) = delete;
  QmitkDataGeneratorBase& operator=(const QmitkDataGeneratorBase& other) = delete;

  virtual ~QmitkDataGeneratorBase();

  using JobResultMapType = QmitkDataGenerationJobBase::ResultMapType;

  mitk::DataStorage::Pointer GetDataStorage() const;

  bool GetAutoUpdate() const;

  bool IsGenerating() const;

  bool Generate() const;

  virtual bool IsValidResultAvailable(const mitk::DataNode* imageNode, const mitk::DataNode* roiNode) const = 0;

public slots:
  void SetDataStorage(mitk::DataStorage* storage);

  void SetAutoUpdate(bool autoUpdate);

protected slots:
  void OnJobError(QString error, const QmitkDataGenerationJobBase* failedJob) const;
  void OnFinalResultsAvailable(JobResultMapType results, const QmitkDataGenerationJobBase *job) const;

signals:

  void DataGenerationStarted(const mitk::DataNode* imageNode, const mitk::DataNode* roiNode, const QmitkDataGenerationJobBase* job) const;

  void NewDataAvailable(mitk::DataStorage::SetOfObjects::ConstPointer data) const;

  void GenerationFinished() const;

  void JobError(QString error, const QmitkDataGenerationJobBase* failedJob) const;

protected:
  QmitkDataGeneratorBase(mitk::DataStorage::Pointer storage, QObject* parent = nullptr);
  QmitkDataGeneratorBase(QObject* parent = nullptr);

  using InputPairVectorType = std::vector<std::pair<mitk::DataNode::ConstPointer, mitk::DataNode::ConstPointer>>;

  virtual bool ChangedNodeIsRelevant(const mitk::DataNode* changedNode) const = 0;
  virtual InputPairVectorType GetAllImageROICombinations() const = 0;
  virtual void IndicateFutureResults(const mitk::DataNode* imageNode, const mitk::DataNode* roiNode) const = 0;
  virtual std::pair<QmitkDataGenerationJobBase*,mitk::DataNode::Pointer> GetNextMissingGenerationJob(const mitk::DataNode* imageNode, const mitk::DataNode* roiNode) const =0;
  virtual void RemoveObsoleteDataNodes(const mitk::DataNode* imageNode, const mitk::DataNode* roiNode) const = 0;
  virtual mitk::DataNode::Pointer PrepareResultForStorage(const std::string& label, mitk::BaseData* result, const QmitkDataGenerationJobBase* job) const = 0;

  static mitk::DataNode::Pointer CreateWIPDataNode(mitk::BaseData* dataDummy, const std::string& nodeName);

  InputPairVectorType FilterImageROICombinations(InputPairVectorType&& imageROICombinations) const;

  std::string GetPairDescription(const InputPairVectorType::value_type& imageAndSeg) const;

  bool DoGenerate() const;

  void EnsureRecheckingAndGeneration() const;

  mitk::WeakPointer<mitk::DataStorage> m_Storage;

  bool m_AutoUpdate = false;

  mutable std::mutex m_DataMutex;

private: 
  mutable bool m_InGenerate = false;
  mutable bool m_RestartGeneration = false;
  mutable bool m_WIP = false;
  mutable bool m_AddingToStorage = false;

  void NodeAddedOrModified(const mitk::DataNode* node);

  unsigned long m_DataStorageDeletedTag;
};

#endif