MeVis/Foundation/Sources/MLImageFormatBase/mlImageFormat.h

Go to the documentation of this file.

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

//----------------------------------------------------------------------------------
#ifndef __mlImageFormat_H
#define __mlImageFormat_H

// Resolve platform independencies.
#ifndef __MLImageFormatBaseSystem_H
#include "MLImageFormatBaseSystem.h"
#endif

#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif

#ifndef __mlImageFormatTools_H
#include "mlImageFormatTools.h"
#endif

// Implement everything in ML namespace.
ML_START_NAMESPACE
 
  class MLImageFormatTagList;

  //----------------------------------------------------------------------
  //----------------------------------------------------------------------
  class MLIMAGEFORMATBASE_EXPORT MLImageFormat {

  public: 

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

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

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

    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);

    MLErrorCode openForReading();

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

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

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

    MLErrorCode updateMinMaxTagValuesInOpenFile(MLldouble    newMinVoxelValue, 
                                                MLldouble    newMaxVoxelValue,
                                                std::string *errorDescription = NULL);

    MLErrorCode close();


    MLErrorCode remove();


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


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

    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;

    MLImageFormatInfos *_infos;

    MLImageFormatTools::MLImageFormatNotifyCB *_callback;

    void               *_userData;

    bool                _arePartialPagesEnabled;
    
    MLdouble            _dataPreparationTime;

    MLdouble            _pureSaveTime;

  };

ML_END_NAMESPACE


#endif // of __mlImageFormat_H