mlModuleBackgroundTask.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2009, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef ML_MODULE_BACKGROUND_TASK_H
#define ML_MODULE_BACKGROUND_TASK_H
 
// Local includes
#include "MLBackgroundTasksSystem.h"
 
#include "mlImagingBackgroundTask.h"
 
ML_START_NAMESPACE
 
class ProcessAllPagesHandler;

class MLBACKGROUNDTASKS_EXPORT PagedImageProperties : public MedicalImageProperties {
public:
  PagedImageProperties() {};
  PagedImageProperties(const PagedImage& pagedImage):
      MedicalImageProperties(pagedImage),
      _pageExtent(pagedImage.getPageExtent())
  {
    // Clear the image properties, since they are not thread-safe!
    getImagePropertyContainer().clear();
  }

  const ImageVector& getPageExtent() const { return _pageExtent; }
 
protected:
  ImageVector _pageExtent;
};
 
//----------------------------------------------------------------------------------------------------

class MLBACKGROUNDTASKS_EXPORT ModuleBackgroundTask : public ImagingBackgroundTask
{
public:
  ModuleBackgroundTask(Module* module, FloatField* progressField = nullptr, StringField* statusField= nullptr);
 
  ~ModuleBackgroundTask() override;

  void setProgressField(FloatField* field) { _progressField = field; }

  void setStatusField(StringField* field) { _statusField = field; }

  bool hasProgressField() { return !_progressField.isNull(); }

  bool hasStatusField() { return !_statusField.isNull(); }

  void setStatusString(const std::string& status) override;

  void setProgress(float progress) override;

  AsyncTileRequest  requestTile(int inputImageIndex, const SubImageBox& box, MLDataType type, const ScaleShiftData& shift = ScaleShiftData(),
                           int getTileFlags = ImagingBackgroundTask::UseMemoryManager);

  AsyncTileRequest  requestTileWithExternalBuffer(int inputImageIndex, const SubImageBox& box, MLDataType type, const ScaleShiftData& shift,
    ManagedSubImage* externalBuffer, int getTileFlags = ImagingBackgroundTask::ExternalBuffer);


  ProcessAllPagesRequest requestProcessAllPages(ProcessAllPagesHandler* handler, const SubImageBox& box = SubImageBox());

  ProcessAllPagesRequest requestProcessAllPages(const SubImageBox& box = SubImageBox());

  virtual bool shouldCancelOnInputImageChange(int /*inputIndex*/) const { return true; }

  ImageVector getInputImageExtent(int index = 0) const;

  ImageVector getInputImagePageExtent(int index = 0) const;

  MLDataType getInputImageDataType(int index = 0) const;

  double getInputImageMinVoxelValue(int index = 0) const;

  double getInputImageMaxVoxelValue(int index = 0) const;


  const MedicalImageProperties& getInputImageProperties(int index = 0) const;

  bool  hasValidInputImage(int index = 0) const;

  int   getNumInputImages() const { return _numInputImages; }
 
private:
 
  Module*      _module;
  DistantObject<FloatField>  _progressField;
  DistantObject<StringField> _statusField;
 
  int _numInputImages;
  PagedImageProperties** _inputImageProperties;
};
 
ML_END_NAMESPACE
 
#endif