mlModuleLoaderBackendsInterface.h

Go to the documentation of this file.

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
// **InsertLicense** code
//----------------------------------------------------------------------------------

//----------------------------------------------------------------------------------
#pragma once
 
// Local includes
#include "MLModuleLoaderBackendsSystem.h"
 
// DICOM tree prototypes
#include <DCMTree_Lib.h>
 
// ML includes
#include <mlModuleIncludes.h>
#include <mlAPI.h>
 
ML_START_NAMESPACE
 
// Forward of internally used classes.
class MLImageFormat;
class ProgressLogger;
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
class MLMODULE_LOADER_BACKENDS_EXPORT CoreModuleLoaderBackendInterface {
public:
  CoreModuleLoaderBackendInterface() = default;
  CoreModuleLoaderBackendInterface(const CoreModuleLoaderBackendInterface&) = default;
  CoreModuleLoaderBackendInterface& operator=(const CoreModuleLoaderBackendInterface&) = default;

  virtual ~CoreModuleLoaderBackendInterface();

  virtual MLErrorCode loadWithMLImageFormat(const std::string &pageFileName,
                                            SubImage          &outSubImg,
                                            const ImageVector &corrOffset,
                                            MLImageFormat     **loader,
                                            bool              loadFullImage=false) = 0;

  virtual MLErrorCode saveAsMLImageFormat(PagedImage        &imgToSave,
                                          const std::string &outFileName,
                                          const std::string &mliCompress,
                                          bool              updateMinMaxAfterSave) = 0;
  
  virtual void getDCMTreeFromMLImageFile(const std::string      &mlImageFileName,
                                         DCMTree::Const_TreePtr &treePtr,
                                         size_t                 &numVols,
                                         MLErrorCode            &fileLoadError,
                                         MLErrorCode            &treeExtractError) = 0;

  virtual MLErrorCode loadWithImgFileLoader(const std::string &pageFileName,
                                            SubImage          &outSubImg,
                                            const ImageVector &corrOffset,
                                            MLint             dcmTiffExtZ,
                                            const bool        isDCMTiff,
                                            bool              loadFullImage=false) = 0;

  virtual MLErrorCode saveSubImgInFile(const SubImage    &srcSubImg,
                                       const std::string &outFileName) = 0;

  virtual MLErrorCode createAndSaveThumbNail(PagedImage        &srcImg,
                                             const std::string &outFile,
                                             MLint             ext,
                                             bool              useMiddleSlice=true,
                                             bool              buildNoPreviewImageOnInvalidImage=false) = 0;

  virtual MLErrorCode loadWithMLItkImageFileReader(const std::string       &pageFileName,
                                                   SubImage                &outSubImg,
                                                   const ImageVector       &corrOffset,
                                                   MLDataType              fileDataType,
                                                   Module                  **loader,
                                                   DCMTree::Const_TreePtr  constTreePtr,
                                                   bool                    dstIsRGB,
                                                   std::string            *metaDataDump=nullptr,
                                                   bool                   loadFullImage=false,
                                                   size_t                 itkLoadDim=3,
                                                   bool                   hideErrorPosts=false,
                                                   const SubImageBox      &expectedImageExtent=SubImageBox()) = 0;
  
  virtual MLErrorCode loadWithHistoLoad(const std::string      &fileName,
                                        SubImage               &outSubImg,
                                        const ImageVector      &corrOffset,
                                        Module                 **loaderToCreate,
                                        bool                   loadFullImage,
                                        PagedImage             *pagedImg=nullptr,
                                        MLint                  level=0) = 0;

  virtual void destroyMLImageFormatFileReaderInstance(MLImageFormat *&instance) = 0;

  virtual std::string getImagePropertiesWithImgFileReader(const std::string &fileName,
                                                          PagedImage &pImgProps,
                                                          std::string &fileFormat) = 0;

  virtual MLErrorCode getImagePropertiesWithMLImageFormatReader(const std::string &fileName,
                                                                PagedImage &pImgProps) = 0;

  ML_ABSTRACT_ROOT_CLASS_HEADER(CoreModuleLoaderBackendInterface);
};
 
ML_END_NAMESPACE