iARawFileParameters Struct Reference

Contains all metadata required to load a raw data file. More...

#include <iARawFileParameters.h>

Collaboration diagram for iARawFileParameters:

Public Member Functions
	iARawFileParameters ()
	Create default raw file parameters.
quint64	fileSize () const
	Size (in bytes) of the whole file with the current parameters.
bool	operator== (const iARawFileParameters &) const =default
	default comparison operator (only == required actually)
QVariantMap	toMap () const
	convert values to map
quint64	voxelBytes () const
	Size (in bytes) of the data of a single voxel.

Static Public Member Functions
static std::optional< iARawFileParameters >	fromMap (QVariantMap const &map)
	create an instance of iARawFileParameters from the given values; empty if given value not valid

Public Attributes
itk::CommonEnums::IOByteOrder	byteOrder
	The byte order (little endian or big endian) in ITK type constants.
quint32	headerSize
	Size of an optional header (which must be skipped), typically 0.
std::array< double, 3 >	origin
	Default origin of the dataset, typically at the global origin (0, 0, 0).
int	scalarType
	The scalar type used for storing single voxel values, as VTK type specifier.
std::array< unsigned int, 3 >	size
	Size of the dataset in voxels in all 3 dimensions.
std::array< double, 3 >	spacing
	Voxel spacing of the dataset (dimension of a single voxel in given unit).

Detailed Description

Contains all metadata required to load a raw data file.

Constructor & Destructor Documentation

iARawFileParameters()

iARawFileParameters::iARawFileParameters

(

)

Create default raw file parameters.

Member Function Documentation

fileSize()

quint64 iARawFileParameters::fileSize

(

)

const

Size (in bytes) of the whole file with the current parameters.

fromMap()

std::optional< iARawFileParameters > iARawFileParameters::fromMap ( QVariantMap const & map )

static

create an instance of iARawFileParameters from the given values; empty if given value not valid

operator==()

bool iARawFileParameters::operator== ( const iARawFileParameters & ) const

default

default comparison operator (only == required actually)

toMap()

QVariantMap iARawFileParameters::toMap

(

)

const

convert values to map

voxelBytes()

quint64 iARawFileParameters::voxelBytes

(

)

const

Size (in bytes) of the data of a single voxel.

Member Data Documentation

byteOrder

itk::CommonEnums::IOByteOrder iARawFileParameters::byteOrder

The byte order (little endian or big endian) in ITK type constants.

headerSize

quint32 iARawFileParameters::headerSize

Size of an optional header (which must be skipped), typically 0.

origin

std::array<double, 3> iARawFileParameters::origin

Default origin of the dataset, typically at the global origin (0, 0, 0).

scalarType

int iARawFileParameters::scalarType

The scalar type used for storing single voxel values, as VTK type specifier.

See VTK_UNSIGNED_SHORT and other defines at the same place in vtkType.h

size

std::array<unsigned int, 3> iARawFileParameters::size

Size of the dataset in voxels in all 3 dimensions.

spacing

std::array<double, 3> iARawFileParameters::spacing

Voxel spacing of the dataset (dimension of a single voxel in given unit).

---

The documentation for this struct was generated from the following files:

• libs/gui/iARawFileParameters.h
• libs/gui/iARawFileParameters.cpp