mlModuleLoaderBackends.h File Reference

A collection of some tool functions loading files with modules or other backends which are loaded on demand (if available), otherwise functions return errors or defaults. More...

#include "MLModuleLoaderBackendsSystem.h"
#include <DCMTree_Lib.h>
#include <mlModuleIncludes.h>
#include <mlAPI.h>

Go to the source code of this file.

Classes
class	ml::ModuleLoaderBackendsControl
	Small class only used for script wrapper and to observe global ModuleLoaderBackends a bit, do not use manually. More...

Namespaces
namespace	ml
	Main documentation file for ML users and developers.
namespace	ml::ModuleLoaderBackends
	A collection of some tool functions loading files with modules or other backends.

Enumerations
enum	{ ml::ModuleLoaderBackends::InterleavedPlanarConfig = 1 }
	Constants used by backend modules, tested for equality in unit test. More...

Functions
MLMODULE_LOADER_BACKENDS_EXPORT MLErrorCode	ml::ModuleLoaderBackends::loadWithMLImageFormat (const std::string &pageFileName, SubImage &outSubImg, const ImageVector &corrOffset, MLImageFormat **loader, bool loadFullImage=false)
	See corresponding function in ModuleLoaderBackends::CoreInterface.
MLMODULE_LOADER_BACKENDS_EXPORT MLErrorCode	ml::ModuleLoaderBackends::saveAsMLImageFormat (PagedImage &imgToSave, const std::string &outFileName, const std::string &mliCompress, bool updateMinMaxAfterSave)
	See corresponding function in ModuleLoaderBackends::CoreInterface.
MLMODULE_LOADER_BACKENDS_EXPORT void	ml::ModuleLoaderBackends::getDCMTreeFromMLImageFile (const std::string &mlImageFileName, DCMTree::Const_TreePtr &treePtr, size_t &numVols, MLErrorCode &fileLoadError, MLErrorCode &treeExtractError)
	See corresponding function in ModuleLoaderBackends::CoreInterface.
MLMODULE_LOADER_BACKENDS_EXPORT MLErrorCode	ml::ModuleLoaderBackends::loadWithImgFileLoader (const std::string &pageFileName, SubImage &outSubImg, const ImageVector &corrOffset, MLint dcmTiffExtZ, const bool isDCMTiff, bool loadFullImage=false)
	See corresponding function in ModuleLoaderBackends::CoreInterface.
MLMODULE_LOADER_BACKENDS_EXPORT MLErrorCode	ml::ModuleLoaderBackends::saveSubImgInFile (const SubImage &srcSubImg, const std::string &outFileName)
	See corresponding function in ModuleLoaderBackends::CoreInterface.
MLMODULE_LOADER_BACKENDS_EXPORT MLErrorCode	ml::ModuleLoaderBackends::createAndSaveThumbNail (PagedImage &srcImg, const std::string &outFile, MLint ext, bool useMiddleSlice=true, bool buildNoPreviewImageOnInvalidImage=false)
	See corresponding function in ModuleLoaderBackends::CoreInterface.
MLMODULE_LOADER_BACKENDS_EXPORT MLErrorCode	ml::ModuleLoaderBackends::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())
	See corresponding function in ModuleLoaderBackends::CoreInterface.
MLMODULE_LOADER_BACKENDS_EXPORT MLErrorCode	ml::ModuleLoaderBackends::checkOrCreateReusableModule (const std::string &dllName, const std::string &moduleName, const std::vector< std::string > &expectedFields, Module **module, Module **moduleToUse)
	See corresponding function in ModuleLoaderBackends::CoreInterface.
MLMODULE_LOADER_BACKENDS_EXPORT std::string	ml::ModuleLoaderBackends::getPreferredLoader (const std::string &fileName)
	See corresponding function in ModuleLoaderBackends::CoreInterface.
MLMODULE_LOADER_BACKENDS_EXPORT MLErrorCode	ml::ModuleLoaderBackends::loadWithHistoLoad (const std::string &fileName, SubImage &outSubImg, const ImageVector &corrOffset, Module **loaderToCreate, bool loadFullImage, PagedImage *pagedImg=nullptr, MLint level=0)
	See corresponding function in ModuleLoaderBackends::CoreInterface.
MLMODULE_LOADER_BACKENDS_EXPORT void	ml::ModuleLoaderBackends::destroyMLImageFormatFileReaderInstance (MLImageFormat *&instance)
	See corresponding function in ModuleLoaderBackends::CoreInterface.
MLMODULE_LOADER_BACKENDS_EXPORT std::string	ml::ModuleLoaderBackends::getImagePropertiesWithImgFileReader (const std::string &fileName, PagedImage &pImgProps, std::string &fileFormat)
	See corresponding function in ModuleLoaderBackends::CoreInterface.
MLMODULE_LOADER_BACKENDS_EXPORT MLErrorCode	ml::ModuleLoaderBackends::getImagePropertiesWithMLImageFormatReader (const std::string &fileName, PagedImage &pImgProps)
	See corresponding function in ModuleLoaderBackends::CoreInterface.

Detailed Description

A collection of some tool functions loading files with modules or other backends which are loaded on demand (if available), otherwise functions return errors or defaults.

Author

Wolf Spindler

Date

12/2011

Definition in file mlModuleLoaderBackends.h.