MeVisLab Toolbox Reference
ml::DMImage Class Reference

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

#include <mlDMImage.h>

Public Member Functions

 DMImage (DMFileReader &reader, MLuint64 originPosition=0)
 Constructor initialized with its reader and the data structure position in the file. More...
 
DMTagGroupPtr getTagGroup () const
 Return constant access to the tag group. More...
 
void load ()
 Load the tag data structures such that all contents can be used. More...
 
std::string getAsString (std::string prefix="", const std::string &sep=", ", const size_t maxNumBinaryEntries=8, const size_t maxNumStringEntries=20) const
 Convert content to a human readable string with the prefix prefix before all lines and separator sep between all subcomponents. More...
 

Detailed Description

Representation for the DM file as data structure.

Definition at line 24 of file mlDMImage.h.

Constructor & Destructor Documentation

◆ DMImage()

ml::DMImage::DMImage ( DMFileReader reader,
MLuint64  originPosition = 0 
)

Constructor initialized with its reader and the data structure position in the file.

Member Function Documentation

◆ getAsString()

std::string ml::DMImage::getAsString ( std::string  prefix = "",
const std::string &  sep = ", ",
const size_t  maxNumBinaryEntries = 8,
const size_t  maxNumStringEntries = 20 
) const

Convert content to a human readable string with the prefix prefix before all lines and separator sep between all subcomponents.

If a binary tag is displayed then the number of shown values is controlled with maxNumBinaryEntries; if there are more then "..." is displayed instead. If a binary tag of type Uint16 which might be a unicoded string then the number of shown values is controlled with maxNumStringEntries; if there are more then "..." is displayed instead.

◆ getTagGroup()

DMTagGroupPtr ml::DMImage::getTagGroup ( ) const

Return constant access to the tag group.

◆ load()

void ml::DMImage::load ( )

Load the tag data structures such that all contents can be used.


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