mlImageFormatIOBase.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, 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_IMAGE_FORMAT_IOBASE_H
#define ML_IMAGE_FORMAT_IOBASE_H
 
 
 
#include "MLImageFormatSystem.h"
 
// ML includes
#include "mlModuleIncludes.h"
 
#include "mlImageFormatTools.h"
 
 
ML_START_NAMESPACE
 
// Forward declaration.
class MLImageFormat;
class MLImageFormatCompressionParams;
 
// ----------------------------------------------------------
// ----------------------------------------------------------
class MLIMAGEFORMAT_EXPORT MLImageFormatIOBase : public Module
{
public:
 
  // Define number of user tags to support as fields and in GUI.
  enum { NumUserTags = 10 };
 
  MLImageFormatIOBase(int numIns=0, int numOuts=0);
 
  ~MLImageFormatIOBase() override;
 
  MLImageFormatTagList getUserTagList() const;
 
  virtual void updateUserTagFieldsFromLoader(const MLImageFormat &loader);
 
  virtual void updateTagListFieldFromLoader(const MLImageFormat &loader);
 
protected:
 
  // ----------------------------------------------------------
  // ----------------------------------------------------------
  void activateAttachments() override;
 
  void handleNotification (Field *field) override;
 
  // ----------------------------------------------------------
  // ----------------------------------------------------------
  virtual void _setStatus(std::string str      = "",
                          float       progress = 0.0,
                          MLErrorCode err      = ML_RESULT_OK);
 
 
  virtual void _setProgress(float progressVal);
 
  virtual void _resetTagFields();
 
  virtual bool _setDefaultCompressor(const std::string &defaultCompName);
 
  virtual void _remove(const std::string &fileName, bool updateStatus);
 
  static void  _saveCB(double progress,
                       void  *usrData);
 
  void  _saveCBMethod(double progress);
 
 
  MLErrorCode _overWriteWithInputImage(PagedImage    &inImg,
                                       MLImageFormat &fileToUpdate,
                                       ImageVector    voxelShift                = ImageVector(0),
                                       PagedImage    *imgPropsToUpdate          = nullptr,
                                       bool          suppressWorldCoordinateUse = false);
 
  // ----------------------------------------------------------
  // ----------------------------------------------------------
  MLImageFormatCompressionParams &_getCompressorParams   ()       { return *_compressorParams   ; }
  BoolField                      &_getIsSavingFld        ()       { return *_isSavingFld        ; }
 
  const StringField              &_getTrueFileNameFld    () const { return *_trueFileNameFld    ; }
  const NotifyField              &_getStopFld            () const { return *_stopFld            ; }
  NotifyField                    &_getRemoveFld          () const { return *_removeFld          ; }
  const StringField              &_getStatusFld          () const { return *_statusFld          ; }
  const ProgressField            &_getProgressFld        () const { return *_progressFld        ; }
  const StringField              &_getTagListFld         () const { return *_tagListFld         ; }
  StringField* const*             _getUserTagFlds        () const { return  _userTagFld         ; }
  StringField                    &_getNonConstTagListFld () const { return *_tagListFld         ; }
  StringField                   **_getNonConstUserTagFlds()       { return  _userTagFld         ; }
  ImageVectorField               &_getRegionOffsetFld    () const { return *_regionOffsetFld    ; }
  BoolField                      &_getSuppressWorldPosFld() const { return *_suppressWorldPosFld; }
 
private:
 
  // ----------------------------------------------------------
  // ----------------------------------------------------------
 
  MLImageFormatCompressionParams *_compressorParams;
 
 
  // ----------------------------------------------------------
  // ----------------------------------------------------------
 
  StringField   *_trueFileNameFld;
 
  ProgressField *_progressFld;
 
  NotifyField   *_stopFld;
 
  NotifyField   *_removeFld;
 
  StringField   *_statusFld;
 
  BoolField     *_isSavingFld;
 
  StringField   *_tagListFld;
 
  StringField   *_userTagFld[NumUserTags];
 
  ImageVectorField   *_regionOffsetFld;
 
  BoolField     *_suppressWorldPosFld;
 
 
  ML_MODULE_CLASS_HEADER(MLImageFormatIOBase)
};
 
 
ML_END_NAMESPACE
 
#endif // __mlImageFormatIOBase_H