Representation for the DM file as data structure. More...

#include <mlDMFileReaderPlugin.h>

Inheritance diagram for ml::DMFileReaderPlugin:

Public Member Functions
	DMFileReaderPlugin ()
	Constructor.

	~DMFileReaderPlugin () override
	Destructor. If still open the the file will also be closed.

bool	isSupported (const std::string &fileName) const override
	Applies a fast check whether the file is probably supported or not, for example via the suffix.

MLErrorCode	loadFile (const std::string &fileName) override
	Opens and loads a file such that getPagedImageProperties() and fillSubImage() can be used to retrieve information from the file.

size_t	getNumberOfImagesInFile () override
	Returns the number of images which are accessible in the loaded file; normally one, but some formats can contain more than on image per file.

const PagedImage &	getPagedImageProperties () override
	Returns the properties of the currently loaded image.

MLErrorCode	fillSubImage (SubImage &dstSubImage) override
	Copy overlapping regions in dstSubImage with image data from the loaded file; note that the calculation of the overlapping region depends on whether a PagedImage was set with setReferenceForFillingInReferenceCoordinates or not.

std::string	getTagDump (const size_t maxNumBinaryEntries=8, const size_t maxNumStringEntries=20) override
	This function returns a tag dump of the loaded file or "" if not possible.

void	close () override
	Closes the file and cleans up data structures.

bool	supportsFillingInReferenceCoordinates () const override
	Returns true if the loader instance support SubImage filling in reference coordinates, otherwise false.

Public Member Functions inherited from ml::FileReaderPluginsBase
	FileReaderPluginsBase ()
	Constructor.

virtual	~FileReaderPluginsBase ()
	Destructor cleaning up allocated structures and closing a possibly open file.

virtual double	getPluginPriority () const
	Returns a priority over other loader plugins, low priorities mean that other loader plugins with higher priorities which can also read the file should be preferred if there are any.

virtual std::string	getCodedImageIndexString (unsigned int imgIdx)
	If getNumberOfImagesInFile() is <=1 then the plugin string id getTypeId()->getName() is returned, otherwise the string getTypeId()->getName() plus "*#" and the imgIdx.

virtual unsigned int	extractImageIndexValue (const std::string &codedLoaderPluginString)
	From a string of the format "LoaderPluginName+#IDX" extract "IDX" as unsigned int, check whether it is smaller than the number of images in getNumberOfImagesInFile() and if yes then return it.

virtual void	setSelectedImageIndex (size_t idx=0)
	Selects which image from inside the loaded file shall be used.

virtual size_t	getSelectedImageIndex () const
	Returns the currently selected image from inside the loaded file.

virtual void	setReferenceForFillingInReferenceCoordinates (const PagedImage *refImg=nullptr)
	If a valid PagedImage pointer is passed then each fillSubImage operation will take into account the difference between the world origin of the given reference PagedImage and ensure that the copySubImage operation fills dstSubImg in world coordinates of refImg; if nullptr is passed then subimage data will be copied from the file assuming that it is located at voxel coordinates (0,0,0,0,0,0) Loaders which do not support world coordinates will silently ignore the given reference image.

virtual const PagedImage *	getReferenceForFillingInReferenceCoordinates () const
	Returns the recently set "enabled" state set with setSubImageFillingInReferenceCoordinates().

Static Public Member Functions
static std::string	getStringIdentifier ()
	Returns the string identifier for this plugin.

Static Public Member Functions inherited from ml::FileReaderPluginsBase
static FileReaderPluginsBase *	createLoaderInstance (const std::string &fileName)
	Factory functionality: Instantiate a loader for the file name fileName and return a new instance of it or return nullptr if no loader can be created.

Additional Inherited Members
Protected Member Functions inherited from ml::FileReaderPluginsBase
ImageVector	_determineWorldDifferenceAsVoxelShift (const PagedImage &destination) const
	Determines a translation vector for SubImages boxes which represents the world difference between the given two PagedImage.

Detailed Description

Representation for the DM file as data structure.

Definition at line 31 of file mlDMFileReaderPlugin.h.

Constructor & Destructor Documentation

◆ DMFileReaderPlugin()

ml::DMFileReaderPlugin::DMFileReaderPlugin ( )

Constructor.

◆ ~DMFileReaderPlugin()

ml::DMFileReaderPlugin::~DMFileReaderPlugin ( )

override

Destructor. If still open the the file will also be closed.

Member Function Documentation

◆ close()

void ml::DMFileReaderPlugin::close ( )

overridevirtual

Closes the file and cleans up data structures.

Property requests and fillSubImage calls will not operate successfully any more after this call.

Implements ml::FileReaderPluginsBase.

◆ fillSubImage()

MLErrorCode ml::DMFileReaderPlugin::fillSubImage ( SubImage & dstSubImage )

overridevirtual

Copy overlapping regions in dstSubImage with image data from the loaded file; note that the calculation of the overlapping region depends on whether a PagedImage was set with setReferenceForFillingInReferenceCoordinates or not.

Loaders which do not support filling in reference coordinates (which return false on supportsFillingInReferenceCoordinates()) will silently ignore the reference image.

Parameters

dstSubImage The subimage to be filled with data from the loaded file where the image regions overlap. Non overlapping regions are left unchanged.

Returns: ML_RESULT_OK on success or an error or a descriptive code explaining the error. On error free operation and empty overlapping region also ML_RESULT_OK is returned.

Implements ml::FileReaderPluginsBase.

◆ getNumberOfImagesInFile()

size_t ml::DMFileReaderPlugin::getNumberOfImagesInFile ( )

overridevirtual

Returns the number of images which are accessible in the loaded file; normally one, but some formats can contain more than on image per file.

Implements ml::FileReaderPluginsBase.

◆ getPagedImageProperties()

const PagedImage & ml::DMFileReaderPlugin::getPagedImageProperties ( )

overridevirtual

Returns the properties of the currently loaded image.

Validity can be determined with isValid() on returned object.

Implements ml::FileReaderPluginsBase.

◆ getStringIdentifier()

static std::string ml::DMFileReaderPlugin::getStringIdentifier ( )

static

Returns the string identifier for this plugin.

◆ getTagDump()

std::string ml::DMFileReaderPlugin::getTagDump	(	const size_t	maxNumBinaryEntries = 8,
		const size_t	maxNumStringEntries = 20 )

overridevirtual

This function returns a tag dump of the loaded file or "" if not possible.

If a binary value information is displayed then the number of shown values is controlled with maxNumBinaryEntries; if there are more then "..." is displayed instead. If a string value is displayed then the number of shown characters is controlled with maxNumStringEntries; if there are more then "..." is displayed instead.

Reimplemented from ml::FileReaderPluginsBase.

◆ isSupported()

bool ml::DMFileReaderPlugin::isSupported ( const std::string & fileName ) const

overridevirtual

Applies a fast check whether the file is probably supported or not, for
example via the suffix.

If false is returned then file is definitely not loadable; if true then opening with loadFile() is worth a try.

Implements ml::FileReaderPluginsBase.

◆ loadFile()

MLErrorCode ml::DMFileReaderPlugin::loadFile ( const std::string & fileName )

overridevirtual

Opens and loads a file such that getPagedImageProperties() and fillSubImage() can be used to retrieve information from the file.

Corresponding close is performed with close() or the destructor.

Parameters

fileName The absolute path to the file to be loaded.

Returns: ML_RESULT_OK on successfully opened file or a descriptive code explaining the error.

Implements ml::FileReaderPluginsBase.

◆ supportsFillingInReferenceCoordinates()

bool ml::DMFileReaderPlugin::supportsFillingInReferenceCoordinates ( ) const

overridevirtual

Returns true if the loader instance support SubImage filling in reference coordinates, otherwise false.

Reimplemented from ml::FileReaderPluginsBase.

The documentation for this class was generated from the following file:

FMEstable/ReleaseMeVis/Projects/FileReader/MLFileReaderPlugins/Sources/mlDMFileReaderPlugin.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DMFileReaderPlugin()

◆ ~DMFileReaderPlugin()

Member Function Documentation

◆ close()

◆ fillSubImage()

◆ getNumberOfImagesInFile()

◆ getPagedImageProperties()

◆ getStringIdentifier()

◆ getTagDump()

◆ isSupported()

◆ loadFile()

◆ supportsFillingInReferenceCoordinates()