MeVisLab Toolbox Reference
mlDMFileReaderTools.h
Go to the documentation of this file.
1 // Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
2 // **InsertLicense** code
3 //----------------------------------------------------------------------------------
5 
10 //----------------------------------------------------------------------------------
11 
12 #pragma once
13 
14 #include "MLDMFileReaderSystem.h"
15 
17 #include <mlDMFileReaderDefs.h>
18 
19 ML_START_NAMESPACE
20 
22  MLDMFileReader_EXPORT std::string DMGetDataTypeAsString(DMEncodedStructureType encType);
23 
25  MLDMFileReader_EXPORT MLDataType DMEncodedStructureTypeToMLType(DMEncodedStructureType encType);
26 
29  MLDMFileReader_EXPORT MLDataType DMPixelDataTypeToMLType(DMEncodedVoxelDataType encType);
30 
32  MLDMFileReader_EXPORT MLuint64 DMGetEncodedSimpleTypeByteSize(DMEncodedStructureType encType);
33 
40  MLDMFileReader_EXPORT double DMGetSimpleEncodedMemoryValueAsDouble(DMFileReader &reader,
41  MLuint64 dataPos,
42  DMEncodedStructureType encType,
43  MLuint64 byteOffset=0);
44 
51  MLDMFileReader_EXPORT MLuint64 DMGetSimpleEncodedMemoryValueAsMLuint64(DMFileReader &reader,
52  MLuint64 dataPos,
53  DMEncodedStructureType encType,
54  MLuint64 byteOffset=0);
55 
62  MLDMFileReader_EXPORT MLint64 DMGetSimpleEncodedMemoryValueAsMLint64(DMFileReader &reader,
63  MLuint64 dataPos,
64  DMEncodedStructureType encType,
65  MLuint64 byteOffset=0);
67  MLDMFileReader_EXPORT DMTagPtr DMGetTag(const std::string &label,
68  const DMTagPtrVector &tagVec);
69 
71  MLDMFileReader_EXPORT DMTagPtrVector DMGetTags(const std::string &label,
72  const DMTagPtrVector &tagVec);
73 
78  MLDMFileReader_EXPORT DMTagPtrVector DMGetTags(const std::string &groupTagName1,
79  const std::string &groupTagName2,
80  const DMTagPtrVector &tagVec);
81 
87  MLDMFileReader_EXPORT DMTagPtrVector DMGetTags(const std::string &groupTagName1,
88  const std::string &groupTagName2,
89  const std::string &groupTagName3,
90  const DMTagPtrVector &tagVec);
91 
96  MLDMFileReader_EXPORT DMTagPtr DMGetTag(const std::string &groupTagName1,
97  const std::string &tagName,
98  const DMTagPtrVector &tagVec);
99 
105  MLDMFileReader_EXPORT DMTagPtr DMGetTag(const std::string &groupTagName1,
106  const std::string &groupTagName2,
107  const std::string &tagName,
108  const DMTagPtrVector &tagVec);
109 
116  MLDMFileReader_EXPORT DMTagPtr DMGetTag(const std::string &groupTagName1,
117  const std::string &groupTagName2,
118  const std::string &groupTagName3,
119  const std::string &tagName,
120  const DMTagPtrVector &tagVec);
121 
123  MLDMFileReader_EXPORT std::vector<DMImageDataStructPtr> DMSetUpImageStructs(DMFileReader &reader);
124 
125 ML_END_NAMESPACE
MLDMFileReaderSystem.h
Project global and OS specific declarations.
MLDMFileReader_EXPORT
#define MLDMFileReader_EXPORT
If included by external modules, exported symbols are declared as import symbols.
Definition: MLDMFileReaderSystem.h:21
ml::DMFileReader
A tool classes to load Digital Microscopy files.
Definition: mlDMFileReader.h:27
MLDataType
MLint32 MLDataType
MLDataType.
Definition: mlTypeDefs.h:596
mlDMFileReaderDefs.h
Project wide definitions.
MLuint64
UINT64 MLuint64
Introduce platform-independent 64-bit unsigned integer type.
Definition: mlTypeDefs.h:425
MLint64
INT64 MLint64
Include 64-bit integer support for Windows or Unix.
Definition: mlTypeDefs.h:412
ml::DMGetTag
MLDMFileReader_EXPORT DMTagPtr DMGetTag(const std::string &groupTagName1, const std::string &groupTagName2, const std::string &groupTagName3, const std::string &tagName, const DMTagPtrVector &tagVec)
If possible then search the first group tag with groupTagName1 in tagVec, then search the first tag w...
ml::DMGetEncodedSimpleTypeByteSize
MLDMFileReader_EXPORT MLuint64 DMGetEncodedSimpleTypeByteSize(DMEncodedStructureType encType)
Returns the byte size of the encoded simple, on arrays, structs or bad types it returns 0.
ml::DMTagPtr
boost::shared_ptr< DMTag > DMTagPtr
Boost shared-pointer type definitions for DMTagEntry.
Definition: mlDMFileReaderDefs.h:43
ml::DMGetTags
MLDMFileReader_EXPORT DMTagPtrVector DMGetTags(const std::string &groupTagName1, const std::string &groupTagName2, const std::string &groupTagName3, const DMTagPtrVector &tagVec)
If possible then search the first group tag with groupTagName1 in tagVec, and search first group tag ...
ml::DMPixelDataTypeToMLType
MLDMFileReader_EXPORT MLDataType DMPixelDataTypeToMLType(DMEncodedVoxelDataType encType)
Converts a DM pixel data type to the corresponding MLDataType or to ML_INVALID_DATA_TYPE if not possi...
ml::DMGetDataTypeAsString
MLDMFileReader_EXPORT std::string DMGetDataTypeAsString(DMEncodedStructureType encType)
Returns a human readable string version for the provided encType.
ml::DMGetSimpleEncodedMemoryValueAsMLint64
MLDMFileReader_EXPORT MLint64 DMGetSimpleEncodedMemoryValueAsMLint64(DMFileReader &reader, MLuint64 dataPos, DMEncodedStructureType encType, MLuint64 byteOffset=0)
ml::DMGetSimpleEncodedMemoryValueAsDouble
MLDMFileReader_EXPORT double DMGetSimpleEncodedMemoryValueAsDouble(DMFileReader &reader, MLuint64 dataPos, DMEncodedStructureType encType, MLuint64 byteOffset=0)
ml::DMEncodedVoxelDataType
DMEncodedVoxelDataType
Enumerator describing the DMReader encoded voxel data type; the enumerator value corresponds to the v...
Definition: mlDMFileReaderDefs.h:86
ml::DMTagPtrVector
std::vector< DMTagPtr > DMTagPtrVector
Vector of shared pointers to DMTags.
Definition: mlDMFileReaderDefs.h:49
ml::DMEncodedStructureTypeToMLType
MLDMFileReader_EXPORT MLDataType DMEncodedStructureTypeToMLType(DMEncodedStructureType encType)
Converts encType to the corresponding MLDataType or to ML_INVALID_DATA_TYPE if not possible.
ml::DMSetUpImageStructs
MLDMFileReader_EXPORT std::vector< DMImageDataStructPtr > DMSetUpImageStructs(DMFileReader &reader)
Search all image data structures in the open reader and return them as list.
ml::DMGetSimpleEncodedMemoryValueAsMLuint64
MLDMFileReader_EXPORT MLuint64 DMGetSimpleEncodedMemoryValueAsMLuint64(DMFileReader &reader, MLuint64 dataPos, DMEncodedStructureType encType, MLuint64 byteOffset=0)
ml::DMEncodedStructureType
DMEncodedStructureType
Enumerator describing the encoded type; the enumerator value is the same as the stored value in file.
Definition: mlDMFileReaderDefs.h:60