MLMultiFileVolumeWrapper Class Reference

#include <mlMultiFileVolumeWrapper.h>

Inherits QObject.

Public Slots
Access to wrapped MultiFileVolume object.
QStringList	getFilenames () const
QString	getPageFileName (qint64 z, qint64 t, qint64 u=0) const
void	modifyPageFileName (QString newFilename, qint64 z, qint64 t, qint64 u=0)
QString	getFirstFileName () const
void	setFirstFileName (QString filename)
QObject *	getDicomTree ()
QObject *	getPagedImage ()
QObject *	getImageProperties ()
bool	isValidImage () const
QVariantList	getExtent () const
quint64	getZExt () const

Properties
Qt property definitions for the wrapper.
QVariantList	extent
quint64	zExt
quint64	tExt
quint64	uExt
double	importTime
QString	filterLabel
QString	filterConfig
QString	issues
QString	dicomSMFTagTreeCacheFileName

Detailed Description

This class is an object wrapper for MultiFileVolume objects for Python.

Member Function Documentation

getDicomTree

QObject * MLMultiFileVolumeWrapper::getDicomTree ( )

slot

Returns the DicomTree (see MLABDicomTree documentation).

This allows accessing the DICOM tags (if available).

getExtent

QVariantList MLMultiFileVolumeWrapper::getExtent ( ) const

slot

Returns the extent of the volume (x,y,z,c,t,u).

getFilenames

QStringList MLMultiFileVolumeWrapper::getFilenames ( ) const

slot

Returns a list of all fileHandles.

getFirstFileName

QString MLMultiFileVolumeWrapper::getFirstFileName ( ) const

slot

Returns the fileHandle of the first frame.

getImageProperties

QObject * MLMultiFileVolumeWrapper::getImageProperties ( )

slot

Returns the image properties as PagedImage (see MLPagedImageWrapper documentation).

This allows accessing the image properties ONLY, getTile() is not supported!

getPagedImage

QObject * MLMultiFileVolumeWrapper::getPagedImage ( )

slot

Returns the PagedImage (see MLPagedImageWrapper documentation).

This allows accessing the image properties ONLY, getTile() is not supported!

getPageFileName

QString MLMultiFileVolumeWrapper::getPageFileName ( qint64 z, qint64 t, qint64 u = 0 ) const

slot

Returns the fileHandle for the specified frame.

getZExt

quint64 MLMultiFileVolumeWrapper::getZExt ( ) const

slot

Getter(s) used for the corresponding Q_PROPERTY.

isValidImage

bool MLMultiFileVolumeWrapper::isValidImage ( ) const

slot

Returns if the MultiFileVolume contains a a valid image volume.

modifyPageFileName

void MLMultiFileVolumeWrapper::modifyPageFileName ( QString newFilename, qint64 z, qint64 t, qint64 u = 0 )

slot

Modifies the fileHandle for the specified frame.

setFirstFileName

void MLMultiFileVolumeWrapper::setFirstFileName ( QString filename )

slot

Modifies the fileHandle of the first frame.

Property Documentation

dicomSMFTagTreeCacheFileName

QString MLMultiFileVolumeWrapper::dicomSMFTagTreeCacheFileName

read

dicomSMFTagTreeCacheFileName

extent

QVariantList MLMultiFileVolumeWrapper::extent

read

extent of the volume (x,y,z,c,t,u)

filterConfig

QString MLMultiFileVolumeWrapper::filterConfig

read

The configuration used during creation process if it has been assigned, otherwise empty; see MultiFileVolume::getInputFilterConfig() and MultiFileVolume::_inputFilterConfig.

filterLabel

QString MLMultiFileVolumeWrapper::filterLabel

read

The filterLabel if any has been assigned, otherwise empty, see MultiFileVolume::getInputFilterLabel() and MultiFileVolume::_inputFilterLabel.

importTime

double MLMultiFileVolumeWrapper::importTime

read

The time needed to import MultiFileVolume.

issues

QString MLMultiFileVolumeWrapper::issues

read

Issues belonging to the MultiFileVolume, see MultiFileVolume::getIssues() for details.

tExt

quint64 MLMultiFileVolumeWrapper::tExt

read

The t extent of the grid of pageFileNames.

uExt

quint64 MLMultiFileVolumeWrapper::uExt

read

The u extent of the grid of pageFileNames.

zExt

quint64 MLMultiFileVolumeWrapper::zExt

read

The z extent of the grid of pageFileNames.