- Generated by
1.9.8
|
MeVisLab Toolbox Reference
|
Header information loader for files supported by xylib. More...
#include <XYLibHeader.h>
Public Member Functions | |
| XYLibHeader () | |
| Constructor. | |
| void | clear () |
| Clears the file name and the data buffer to the construction state. | |
| const std::string & | getFileName () const |
| Get the file name of the currently loaded header. | |
| const std::string & | getFormatName () const |
| Get the name of the file format of the currently loaded header. | |
| MLErrorCode | loadHeader (const std::string &fileName) |
| Loads the header from file and returns ML_RESULT_OK on success, otherwise an error code describing the problem. | |
| ImageVector | getImageExtent (double &minVal, double &maxVal) const |
| Returns the extent of the (sub)image, (0,0,0,0,0,0) if cleaned, not loaded files, on errors, or if header contents are ambiguous and right version cannot be verified with file size. | |
| Vector3 | getVoxelSize () const |
| Returns the voxel size of the image in mm, (1,1,1) if cleaned, not loaded, or on error. | |
| MLDataType | getDataType () const |
| Get the data type of the image as ML data type, ML_INVALID_DATA_TYPE if cleaned, not loaded, or on error. | |
| std::string | getDataTypeAsString () const |
| Get the data type of the image as descriptive string, "INVALID_DATA_TYPE" if cleaned, not loaded, or on error. | |
| std::string | getMetaDataDump () const |
| Get the meta data of the file as string dump. | |
| MLErrorCode | fillSubImage (SubImage &dstSubImage) |
| 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. | |
Header information loader for files supported by xylib.
Definition at line 27 of file XYLibHeader.h.
| ml::XYLibHeader::XYLibHeader | ( | ) |
Constructor.
| void ml::XYLibHeader::clear | ( | ) |
Clears the file name and the data buffer to the construction state.
| MLErrorCode ml::XYLibHeader::fillSubImage | ( | SubImage & | dstSubImage | ) |
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.
| dstSubImage | The subimage to be filled with data from the loaded file where the image regions overlap. Non overlapping regions are left unchanged. |
| MLDataType ml::XYLibHeader::getDataType | ( | ) | const |
Get the data type of the image as ML data type, ML_INVALID_DATA_TYPE if cleaned, not loaded, or on error.
| std::string ml::XYLibHeader::getDataTypeAsString | ( | ) | const |
Get the data type of the image as descriptive string, "INVALID_DATA_TYPE" if cleaned, not loaded, or on error.
| const std::string & ml::XYLibHeader::getFileName | ( | ) | const |
Get the file name of the currently loaded header.
| const std::string & ml::XYLibHeader::getFormatName | ( | ) | const |
Get the name of the file format of the currently loaded header.
| ImageVector ml::XYLibHeader::getImageExtent | ( | double & | minVal, |
| double & | maxVal | ||
| ) | const |
Returns the extent of the (sub)image, (0,0,0,0,0,0) if cleaned, not loaded files, on errors, or if header contents are ambiguous and right version cannot be verified with file size.
| std::string ml::XYLibHeader::getMetaDataDump | ( | ) | const |
Get the meta data of the file as string dump.
| Vector3 ml::XYLibHeader::getVoxelSize | ( | ) | const |
Returns the voxel size of the image in mm, (1,1,1) if cleaned, not loaded, or on error.
| MLErrorCode ml::XYLibHeader::loadHeader | ( | const std::string & | fileName | ) |
Loads the header from file and returns ML_RESULT_OK on success, otherwise an error code describing the problem.
1.9.8