ml::ModuleLoaderBackends Namespace Reference

A collection of some tool functions loading files with modules or other backends. More...

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

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

Detailed Description

A collection of some tool functions loading files with modules or other backends.

Enumeration Type Documentation

anonymous enum

anonymous enum

Constants used by backend modules, tested for equality in unit test.

Enumerator
InterleavedPlanarConfig	The MFL planar config enumerator kMFLfmtPcnfContig for "continuous" or interleaved such as RGBRGBRGB.

Definition at line 57 of file mlModuleLoaderBackends.h.

Function Documentation

checkOrCreateReusableModule()

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.

createAndSaveThumbNail()

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.

destroyMLImageFormatFileReaderInstance()

MLMODULE_LOADER_BACKENDS_EXPORT void ml::ModuleLoaderBackends::destroyMLImageFormatFileReaderInstance

(

MLImageFormat *&

instance

)

See corresponding function in ModuleLoaderBackends::CoreInterface.

getDCMTreeFromMLImageFile()

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.

getImagePropertiesWithImgFileReader()

MLMODULE_LOADER_BACKENDS_EXPORT std::string ml::ModuleLoaderBackends::getImagePropertiesWithImgFileReader	(	const std::string &	fileName,
		PagedImage &	pImgProps,
		std::string &	fileFormat
	)

See corresponding function in ModuleLoaderBackends::CoreInterface.

getImagePropertiesWithMLImageFormatReader()

MLMODULE_LOADER_BACKENDS_EXPORT MLErrorCode ml::ModuleLoaderBackends::getImagePropertiesWithMLImageFormatReader	(	const std::string &	fileName,
		PagedImage &	pImgProps
	)

See corresponding function in ModuleLoaderBackends::CoreInterface.

getPreferredLoader()

MLMODULE_LOADER_BACKENDS_EXPORT std::string ml::ModuleLoaderBackends::getPreferredLoader

(

const std::string &

fileName

)

See corresponding function in ModuleLoaderBackends::CoreInterface.

loadWithHistoLoad()

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.

loadWithImgFileLoader()

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.

loadWithMLImageFormat()

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.

loadWithMLItkImageFileReader()

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.

saveAsMLImageFormat()

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.

saveSubImgInFile()

MLMODULE_LOADER_BACKENDS_EXPORT MLErrorCode ml::ModuleLoaderBackends::saveSubImgInFile	(	const SubImage &	srcSubImg,
		const std::string &	outFileName
	)

See corresponding function in ModuleLoaderBackends::CoreInterface.