MLPagedImageWrapper Class Reference

This class allows scripting read access to a ml::PagedImage. More...

Inherited by MLWriteablePagedImageWrapper.

List of all members.

Public Types

enum  DataTypes {
  MLuint8Type = ::MLuint8Type, MLint8Type = ::MLint8Type, MLuint16Type = ::MLuint16Type, MLint16Type = ::MLint16Type,
  MLuint32Type = ::MLuint32Type, MLint32Type = ::MLint32Type, MLuint64Type = ::MLuint64Type, MLint64Type = ::MLint64Type,
  MLfloatType = ::MLfloatType, MLdoubleType = ::MLdoubleType, MLldoubleType = ::MLldoubleType
}

Public Slots

Property read access
int dataType () const
const char * dataTypeName () const
QStringList getCDimensionInfos () const
QList< QDateTime > getTDimensionInfos () const
QStringList getUDimensionInfos () const
QList< qint64 > imageExtent () const
bool isGlobalDummyImage () const
QList< double > mapVoxelToWorld (double x, double y, double z) const
QList< double > mapVoxelToWorld (QList< double > vector) const
QList< double > mapWorldToVoxel (double x, double y, double z) const
QList< double > mapWorldToVoxel (QList< double > vector) const
double maxVoxelValue () const
double minVoxelValue () const
int numPyDataType () const
QList< qint64 > pageExtent () const
QList< double > voxelSize () const
QVariantList voxelToWorldMatrix () const
QVariantList worldToVoxelMatrix () const
Image access
QImage getSliceAsQImage (qint64 z=0, qint64 t=0, qint64 u=0)
QPixmap getSliceAsQPixmap (qint64 z=0, qint64 t=0, qint64 u=0)
PySubImage getTile (const QList< qint64 > &pos, const QList< qint64 > &extent, int dataType=-2, double scale=1.0, double shift=0.)

Properties

int MLcomplexdType
int MLcomplexfType
int MLcomplexldType


Detailed Description

This class allows scripting read access to a ml::PagedImage.

It is available via MLABImageField::image().


Member Enumeration Documentation

static datatypes via enum

Enumerator:
MLuint8Type  MLuint8Type.
MLint8Type  MLint8Type.
MLuint16Type  MLuint16Type.
MLint16Type  MLint16Type.
MLuint32Type  MLuint32Type.
MLint32Type  MLint32Type.
MLuint64Type  MLuint64Type.
MLint64Type  MLint64Type.
MLfloatType  MLfloatType.
MLdoubleType  MLdoubleType.
MLldoubleType  MLldoubleType.

Enumerator:
UseImageExtent  special value that can be used when using getTile()


Member Function Documentation

int MLPagedImageWrapper::dataType (  )  const [slot]

get datatype as ML datatype id

const char* MLPagedImageWrapper::dataTypeName (  )  const [slot]

get name of the current datatype as string

QStringList MLPagedImageWrapper::getCDimensionInfos (  )  const [slot]

get information about C dimension

QImage MLPagedImageWrapper::getSliceAsQImage ( qint64  z = 0,
qint64  t = 0,
qint64  u = 0 
) [slot]

Get the selected slice as a QImage.

This returned image is either an RGB or an RGBA image, depending on the number of channels of the image. Only images with at least 3 color channels are supported, an empty image is returned otherwise.

QPixmap MLPagedImageWrapper::getSliceAsQPixmap ( qint64  z = 0,
qint64  t = 0,
qint64  u = 0 
) [slot]

Get the selected slice as a QPixmap, see getSliceAsQImage for details.

QList<QDateTime> MLPagedImageWrapper::getTDimensionInfos (  )  const [slot]

get information about T dimension

PySubImage MLPagedImageWrapper::getTile ( const QList< qint64 > &  pos,
const QList< qint64 > &  extent,
int  dataType = -2,
double  scale = 1.0,
double  shift = 0. 
) [slot]

Get the image tile defined by the box [pos,pos+extent-1] as a PySubImage (which is derived from NumPy's ndarray).

The ordering of the dimensions in pos and extent is (x,y,z,c,t,u). The returned image is an N dimensional image where N == len(extent). So if you request an image of extent (256,256), you will get a 2D image. If you request (256,256,3,1,1,1), you will get a 6D image, regardless of the size of 1 of the trailing dimensions. If pos or extent contain less than 6 dimensions, they are filled with 0 for pos and 1 for extent. If one of the values of extent contains the ImageExtent enum, that value is filled with the image extent. If no datatype is given, the datatype of the input image is used. The data is stored in the ML Memory manager and is owned by the Python scripting engine, it will be automatically garbage collected when the reference to it is lost. Note: This method is only callable via Python scripting. Have a look at the PythonGetTileExample module and example network to see how getTile() is used.

QStringList MLPagedImageWrapper::getUDimensionInfos (  )  const [slot]

get information about U dimension

QList<qint64> MLPagedImageWrapper::imageExtent (  )  const [slot]

get the image extent in (x,y,z,c,t,u) order

bool MLPagedImageWrapper::isGlobalDummyImage (  )  const [inline, slot]

check if the image is the dummy image

QList<double> MLPagedImageWrapper::mapVoxelToWorld ( double  x,
double  y,
double  z 
) const [slot]

transform the given 3d input vector to world coordinates

QList<double> MLPagedImageWrapper::mapVoxelToWorld ( QList< double >  vector  )  const [slot]

transform the given 3d input vector to world coordinates

QList<double> MLPagedImageWrapper::mapWorldToVoxel ( double  x,
double  y,
double  z 
) const [slot]

transform the given 3d input vector to voxel coordinates

QList<double> MLPagedImageWrapper::mapWorldToVoxel ( QList< double >  vector  )  const [slot]

transform the given 3d input vector to voxel coordinates

double MLPagedImageWrapper::maxVoxelValue (  )  const [inline, slot]

get the maximum voxel value (which defines an upper bound to the values in the image data, not the really present max value)

double MLPagedImageWrapper::minVoxelValue (  )  const [inline, slot]

get the minimum voxel value (which defines a lower bound to the values in the image data, not the really present min value)

int MLPagedImageWrapper::numPyDataType (  )  const [slot]

get datatype as numpy datatype id

QList<qint64> MLPagedImageWrapper::pageExtent (  )  const [slot]

get the page extent in (x,y,z,c,t,u) order

QList<double> MLPagedImageWrapper::voxelSize (  )  const [slot]

get the voxelsize in (vx, vy, vz) order

QVariantList MLPagedImageWrapper::voxelToWorldMatrix (  )  const [slot]

get the voxel to world matrix

QVariantList MLPagedImageWrapper::worldToVoxelMatrix (  )  const [slot]

get the world to voxel matrix


Property Documentation

int MLPagedImageWrapper::MLcomplexdType [read]

MLcomplexdType.

int MLPagedImageWrapper::MLcomplexfType [read]

MLcomplexfType.

int MLPagedImageWrapper::MLcomplexldType [read]

MLcomplexdfType.


Generated on Sat Sep 3 18:38:03 2011 for MeVisLab Scripting Reference by  doxygen 1.5.8