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

#include <mlDMImageDataStruct.h>

Public Member Functions
	DMImageDataStruct (DMTagPtr imageDataGroup, DMFileReader &reader)
	Constructor initializing the data structure from the tag which is expected to be an ImageDataGroup.

bool	isUsableAsMLImage () const
	Return true if the image seems to be a usable ML image, otherwise false.

std::string	getAsString (std::string prefix="", const std::string &sep=", ") const
	Convert content to a human readable string with the prefix prefix before all lines and separator sep between all subcomponents.

Public Attributes
Vector3	origin
	World origin of image.

Vector3	pixelSize
	Pixel scaling.

MLint	dimensionX
	Image extents-X.

MLint	dimensionY
	Image extents-Y.

MLuint64	pixelDepth
	Number of bytes per pixel.

MLuint64	dmDataType
	Corresponding ML data type.

MLDataType	mlDataType
	Corresponding ML data type.

bool	isInverted
	True if the data shall be displayed inverted.

DMTagPtr	dataPtr
	Tag pointer with the image data.

Detailed Description

Representation for the DM file as data structure.

Definition at line 25 of file mlDMImageDataStruct.h.

Constructor & Destructor Documentation

◆ DMImageDataStruct()

ml::DMImageDataStruct::DMImageDataStruct	(	DMTagPtr	imageDataGroup,
		DMFileReader &	reader
	)

Constructor initializing the data structure from the tag which is expected to be an ImageDataGroup.

The reader must be that one the imageDataGroup comes from.

Member Function Documentation

◆ getAsString()

std::string ml::DMImageDataStruct::getAsString	(	std::string	prefix = `""`,
		const std::string &	sep = `", "`
	)		const

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

◆ isUsableAsMLImage()

bool ml::DMImageDataStruct::isUsableAsMLImage ( ) const

Return true if the image seems to be a usable ML image, otherwise false.

Member Data Documentation

◆ dataPtr

DMTagPtr ml::DMImageDataStruct::dataPtr

Tag pointer with the image data.

Definition at line 57 of file mlDMImageDataStruct.h.

◆ dimensionX

MLint ml::DMImageDataStruct::dimensionX

Image extents-X.

Definition at line 39 of file mlDMImageDataStruct.h.

◆ dimensionY

MLint ml::DMImageDataStruct::dimensionY

Image extents-Y.

Definition at line 42 of file mlDMImageDataStruct.h.

◆ dmDataType

MLuint64 ml::DMImageDataStruct::dmDataType

Corresponding ML data type.

Definition at line 48 of file mlDMImageDataStruct.h.

◆ isInverted

bool ml::DMImageDataStruct::isInverted

True if the data shall be displayed inverted.

Definition at line 54 of file mlDMImageDataStruct.h.

◆ mlDataType

MLDataType ml::DMImageDataStruct::mlDataType

Corresponding ML data type.

Definition at line 51 of file mlDMImageDataStruct.h.

◆ origin

Vector3 ml::DMImageDataStruct::origin

World origin of image.

Definition at line 33 of file mlDMImageDataStruct.h.

◆ pixelDepth

MLuint64 ml::DMImageDataStruct::pixelDepth

Number of bytes per pixel.

Definition at line 45 of file mlDMImageDataStruct.h.

◆ pixelSize

Vector3 ml::DMImageDataStruct::pixelSize

Pixel scaling.

Definition at line 36 of file mlDMImageDataStruct.h.

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

FMEstable/ReleaseMeVis/Projects/FileReader/MLDMFileReader/Sources/mlDMImageDataStruct.h

Public Member Functions

Public Attributes