MeVisLab Scripting Reference
MLCSOVoxelSetWrapper Class Reference

#include <mlCSOVoxelSetWrapper.h>

Public Slots

void addCSOVoxelSetGroupId (int id)
void addVoxelValuePositions (const QVariantList &positions, const QList< double > &voxelValues)
QList< double > getBoundingBoxV1 () const
QList< double > getBoundingBoxV2 () const
QString getCreator () const
MLCSOVoxelSetListWrapper * getCSOVoxelSetListWrapper () const
QString getDescription () const
unsigned int getEndingSlice () const
MLCSOVoxelSetGroupWrapper * getGroupAt (unsigned int index) const
QString getLabel () const
unsigned int getNumGroups () const
quint64 getNumSlices () const
quint64 getNumTotalVoxels () const
unsigned int getStartingSlice () const
int getTimepoint () const
int getUniqueId () const
QList< double > getVoxelPositionAtSlice (unsigned int sliceIndex, unsigned int voxelIndex) const
QList< double > getVoxelPositionOfTotal (quint64 index) const
double getVoxelValueAtSlice (unsigned int sliceIndex, unsigned int voxelIndex) const
double getVoxelValueOfTotal (unsigned int index) const
int groupIdAt (unsigned int index) const
unsigned int numVoxelsOnSliceAt (unsigned int sliceIndex) const
void setCreator (const QString &creator)
void setDescription (const QString &desc)
void setLabel (const QString &label)
void setTimepoint (int index)
void setUniqueId (int uid)

Properties

QString creator
MLCSOVoxelSetListWrapper * csoVoxelSetListWrapper
QString description
unsigned int endingSlice
QString label
unsigned int numGroups
quint64 numSlices
quint64 numTotalVoxels
unsigned int startingSlice
int timepoint
int uniqueId

Detailed Description

A class that wraps CSOVoxelSet objects for use in scripting.

Member Function Documentation

◆ addCSOVoxelSetGroupId

void MLCSOVoxelSetWrapper::addCSOVoxelSetGroupId ( int id)
slot

Adds the group with the given id to this CSOVoxelSet.

◆ addVoxelValuePositions

void MLCSOVoxelSetWrapper::addVoxelValuePositions ( const QVariantList & positions,
const QList< double > & voxelValues )
slot

Adds a vector of positions and values.

◆ getBoundingBoxV1

QList< double > MLCSOVoxelSetWrapper::getBoundingBoxV1 ( ) const
slot

Returns the minimum corner of the voxel bounding box.

◆ getBoundingBoxV2

QList< double > MLCSOVoxelSetWrapper::getBoundingBoxV2 ( ) const
slot

Returns the maximum corner of the voxel bounding box.

◆ getCreator

QString MLCSOVoxelSetWrapper::getCreator ( ) const
slot

Returns the creator of the CSOVoxelSet.

◆ getCSOVoxelSetListWrapper

MLCSOVoxelSetListWrapper * MLCSOVoxelSetWrapper::getCSOVoxelSetListWrapper ( ) const
slot

Returns the internal pointer to the embracing CSOVoxelSetList.

◆ getDescription

QString MLCSOVoxelSetWrapper::getDescription ( ) const
slot

Returns the description of this CSO.

◆ getEndingSlice

unsigned int MLCSOVoxelSetWrapper::getEndingSlice ( ) const
slot

Returns the ending slice.

◆ getGroupAt

MLCSOVoxelSetGroupWrapper * MLCSOVoxelSetWrapper::getGroupAt ( unsigned int index) const
slot

Returns the group at the specified index.

◆ getLabel

QString MLCSOVoxelSetWrapper::getLabel ( ) const
slot

Returns the label of this CSO.

◆ getNumGroups

unsigned int MLCSOVoxelSetWrapper::getNumGroups ( ) const
slot

Returns the number of groups this CSO is in.

◆ getNumSlices

quint64 MLCSOVoxelSetWrapper::getNumSlices ( ) const
slot

Returns the number of slices the voxels are spread over.

◆ getNumTotalVoxels

quint64 MLCSOVoxelSetWrapper::getNumTotalVoxels ( ) const
slot

Returns the number of total voxel positions.

◆ getStartingSlice

unsigned int MLCSOVoxelSetWrapper::getStartingSlice ( ) const
slot

Returns the starting slice.

◆ getTimepoint

int MLCSOVoxelSetWrapper::getTimepoint ( ) const
slot

Returns the time point.

◆ getUniqueId

int MLCSOVoxelSetWrapper::getUniqueId ( ) const
slot

Returns the unique ID of this CSOVoxelSet.

◆ getVoxelPositionAtSlice

QList< double > MLCSOVoxelSetWrapper::getVoxelPositionAtSlice ( unsigned int sliceIndex,
unsigned int voxelIndex ) const
slot

Returns voxel position [x,y] on a certain slice at a certain index.

◆ getVoxelPositionOfTotal

QList< double > MLCSOVoxelSetWrapper::getVoxelPositionOfTotal ( quint64 index) const
slot

Returns a voxel position regardless of its slice.

◆ getVoxelValueAtSlice

double MLCSOVoxelSetWrapper::getVoxelValueAtSlice ( unsigned int sliceIndex,
unsigned int voxelIndex ) const
slot

Returns a voxel value for a given slice at a given index.

◆ getVoxelValueOfTotal

double MLCSOVoxelSetWrapper::getVoxelValueOfTotal ( unsigned int index) const
slot

Returns a voxel value at a given index.

◆ groupIdAt

int MLCSOVoxelSetWrapper::groupIdAt ( unsigned int index) const
slot

Returns the group ID at the specified index.

◆ numVoxelsOnSliceAt

unsigned int MLCSOVoxelSetWrapper::numVoxelsOnSliceAt ( unsigned int sliceIndex) const
slot

Returns the number of voxels for the given slice.

◆ setCreator

void MLCSOVoxelSetWrapper::setCreator ( const QString & creator)
slot

Sets the creator of the CSOVoxelSet.

References creator.

◆ setDescription

void MLCSOVoxelSetWrapper::setDescription ( const QString & desc)
slot

Sets the description of this CSO.

◆ setLabel

void MLCSOVoxelSetWrapper::setLabel ( const QString & label)
slot

Sets the label of this CSO.

References label.

◆ setTimepoint

void MLCSOVoxelSetWrapper::setTimepoint ( int index)
slot

Sets the time point.

◆ setUniqueId

void MLCSOVoxelSetWrapper::setUniqueId ( int uid)
slot

Sets the unique ID.

Property Documentation

◆ creator

QString MLCSOVoxelSetWrapper::creator
readwrite

Getter/setter for creator of the CSOVoxelSet.

Referenced by setCreator().

◆ csoVoxelSetListWrapper

MLCSOVoxelSetListWrapper* MLCSOVoxelSetWrapper::csoVoxelSetListWrapper
read

Wrapper for the associated list object.

◆ description

QString MLCSOVoxelSetWrapper::description
readwrite

Getter/setter for description of the CSOVoxelSet.

◆ endingSlice

unsigned int MLCSOVoxelSetWrapper::endingSlice
read

Get last slice.

◆ label

QString MLCSOVoxelSetWrapper::label
readwrite

Getter/setter for label of the CSOVoxelSet.

Referenced by setLabel().

◆ numGroups

unsigned int MLCSOVoxelSetWrapper::numGroups
read

Get number of groups this CSOVoxelSet belongs to.

◆ numSlices

quint64 MLCSOVoxelSetWrapper::numSlices
read

Get number of slices.

◆ numTotalVoxels

quint64 MLCSOVoxelSetWrapper::numTotalVoxels
read

Get total number of voxels within this CSOVoxelSet.

◆ startingSlice

unsigned int MLCSOVoxelSetWrapper::startingSlice
read

Get first slice.

◆ timepoint

int MLCSOVoxelSetWrapper::timepoint
readwrite

Getter/setter for timepoint of the CSOVoxelSet.

◆ uniqueId

int MLCSOVoxelSetWrapper::uniqueId
readwrite

Getter/setter for uniqueId of the CSOVoxelSet.