mlImageFormat.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_H
#define ML_IMAGE_FORMAT_H

 
// Resolve platform independencies.
#include "MLImageFormatBaseSystem.h"
 
#include "mlModuleIncludes.h"
 
#include "mlImageFormatTools.h"
 
// Implements everything in ML namespace.
ML_START_NAMESPACE

  class MLImageFormatTagList;
 
  //----------------------------------------------------------------------
  //----------------------------------------------------------------------
  class MLIMAGEFORMATBASE_EXPORT MLImageFormat {
 
  public:
 
    //----------------------------------------------------------------------
    //----------------------------------------------------------------------

    MLImageFormat(const std::string &fileName = "");

    MLImageFormat(MLImageFormatAbstractFileHandle* fileHandle);

    virtual ~MLImageFormat();
 
 
    //----------------------------------------------------------------------
    //----------------------------------------------------------------------

    const std::string          &getFileName() const;

    bool                       isOpen() const;

    const PagedImage           *getImageProperties() const;

    const MLImageFormatInfos   *getInternalInfos() const;

    MLImageFormatTagList       &getTagList();

    const MLImageFormatTagList &getConstTagList() const;

    const MLImageFormatTagList &getConstUserTagList() const;

    const MLImageFormatTagList &getConstPrivateTagList() const;

    const MLImageFormatTagList &getConstCompressionTagList() const;

    bool                        arePartialPagesEnabled() const;

    void                        enablePartialPages(bool enable);

    static std::string          buildFileNameWithExtension(std::string fileName);
 
 
    //----------------------------------------------------------------------
    //----------------------------------------------------------------------
    MLErrorCode open(bool                       truncate         = false,
                     const std::string          &compressorName  = "",
                     const MLImageFormatTagList &compressionArgs = MLImageFormatTagList::getDefaultEmptyTagList(),
                     const MLImageFormatTagList &userTagList     = MLImageFormatTagList::getDefaultEmptyTagList(),
                     const MLImageFormatTagList &privateTagList  = MLImageFormatTagList::getDefaultEmptyTagList(),
                     const std::string          &defaultVoxelVal = "0",
                     bool                       rewritable       = true,
                     bool                       suppressReadCheckSumTests = false);

    MLErrorCode openForReading(bool suppressReadCheckSumTests = false);

    MLErrorCode save(PagedImage           &inImg,
                     const SubImageBox    &box = SubImageBox(),
                     const ScaleShiftData &scaleShiftData = ScaleShiftData(),
                     bool                 onlyCreate=false);

    MLErrorCode overwrite(PagedImage           &inImg,
                          const SubImageBox    &box = SubImageBox(),
                          const ScaleShiftData &scaleShiftData = ScaleShiftData());

    MLErrorCode overwrite(const SubImage       &inputSubImg,
                          const ScaleShiftData &scaleShiftData = ScaleShiftData());

    MLErrorCode updateMinMaxTagValuesInOpenFile(MLdouble    newMinVoxelValue,
                                                MLdouble    newMaxVoxelValue,
                                                std::string *errorDescription = nullptr);

    MLErrorCode close();
 

    MLErrorCode remove();
 

    MLErrorCode getTile(SubImage             &subImgToFill,
                        bool                  useFileDataType = false,
                        bool                  useFileRegion   = false,
                        const ScaleShiftData &scaleShiftData  = ScaleShiftData());
 

    void setCallback(MLImageFormatTools::MLImageFormatNotifyCB *callback = nullptr,
                     void                                      *userData = nullptr);

    MLImageFormatTools::MLImageFormatNotifyCB *getCallbackFunction() const;

    void *getCallbackFunctionData() const;

 
    //----------------------------------------------------------------------
    //----------------------------------------------------------------------
    MLdouble            getDataPreparationTime() const;

    MLdouble            getPureSaveTime() const;

    void                resetTimeMeasurements();
 
  protected:

    MLErrorCode _overwriteHeaderAndPageList();
 
  private:

    MLImageFormat(const MLImageFormat &);

    MLImageFormat& operator=(const MLImageFormat &){ return *this; };
 

    std::string         _fileName;

    MLImageFormatAbstractFileHandle* _fileHandle;

    MLImageFormatInfos *_infos;

    MLImageFormatTools::MLImageFormatNotifyCB *_callback;

    void               *_userData;

    bool                _arePartialPagesEnabled;

    MLdouble            _dataPreparationTime;

    MLdouble            _pureSaveTime;

          MLImageFormatTagList _defaultEmptyTagList;
    const MLImageFormatTagList _defaultEmptyConstTagList;
    const MLImageFormatTagList _defaultEmptyUserTagList;
    const MLImageFormatTagList _defaultEmptyPrivateTagList;
    const MLImageFormatTagList _defaultEmptyCompressionTagList;
 
  };
 
ML_END_NAMESPACE
 
 
#endif // of __mlImageFormat_H