MeVis/Foundation/Sources/MLBackgroundTasks/mlModuleBackgroundTask.h

Go to the documentation of this file.

// **InsertLicense** code
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------


#ifndef __mlModuleBackgroundTask_H
#define __mlModuleBackgroundTask_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 threadsafe!
    getImagePropertyContainer().clear();
  }

  const ImageVector& getPageExtent() const { return _pageExtent; }

protected:
  ImageVector _pageExtent;
};

//----------------------------------------------------------------------------------------------------

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

  virtual ~ModuleBackgroundTask();

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

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

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

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

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

  virtual void setProgress(float progress);

  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