MeVisLab Scripting Reference
MLSelectedClustersWrapper Class Reference

#include <mlSelectedClustersWrapper.h>

Inherits QObject.

Public Slots

MLuint getNumClusters () const
 
MLuint getNumSelectedClusters () const
 
MLuint getMinRankOfSelectedClusters () const
 
MLuint getMaxRankOfSelectedClusters () const
 
QList< MLdouble > getAllSelectedClustersBoundingBoxMin () const
 
QList< MLdouble > getAllSelectedClustersBoundingBoxMax () const
 
bool isUsing2DNeighborhood () const
 
MLuint getMaxClusterSizeInVoxel () const
 
MLdouble getVoxelVolumeInMilliliters () const
 
QList< MLuint > getImageExtent () const
 
QList< MLuint > getPageExtent () const
 
QList< MLdouble > getVoxelToWorldMatrix () const
 
QList< MLdouble > getWorldToVoxelMatrix () const
 
QList< MLuint > ranks () const
 
QList< MLuint > selectedRanks () const
 
bool isSelectedAtRank (MLuint rank) const
 
void deselectAllClusters ()
 
void setSelectedAtRank (MLuint rank, bool selectionState=true)
 
void setSelectedAtRanks (QList< MLuint > ranksToSelect)
 
void setSelectedAtPosition (QList< MLint > voxelCoordinate)
 
MLuint getRankAtPosition (QList< MLint > voxelCoordinate) const
 
QList< MLdouble > getBoundingBoxMinAtRank (MLuint rank) const
 
QList< MLdouble > getBoundingBoxMaxAtRank (MLuint rank) const
 
MLuint getNumVoxelsAtRank (MLuint rank) const
 
MLdouble getUserDataAtRank (MLuint rank) const
 
void setUserDataAtRank (MLuint rank, MLdouble userData)
 

Detailed Description

Access the clusters generated with the ComputeConnectedComponents module.

Member Function Documentation

◆ deselectAllClusters

void MLSelectedClustersWrapper::deselectAllClusters ( )
slot

Deselects all clusters.

◆ getAllSelectedClustersBoundingBoxMax

QList< MLdouble > MLSelectedClustersWrapper::getAllSelectedClustersBoundingBoxMax ( ) const
slot

Returns the max bounding box of all selected clusters.

Is -1, -1, -1 if no cluster is selected.

◆ getAllSelectedClustersBoundingBoxMin

QList< MLdouble > MLSelectedClustersWrapper::getAllSelectedClustersBoundingBoxMin ( ) const
slot

Returns the min bounding box of all selected clusters.

Is -1, -1, -1 if no cluster is selected.

◆ getBoundingBoxMaxAtRank

QList< MLdouble > MLSelectedClustersWrapper::getBoundingBoxMaxAtRank ( MLuint rank) const
slot

Returns the max bounding box of the cluster with the given rank.

◆ getBoundingBoxMinAtRank

QList< MLdouble > MLSelectedClustersWrapper::getBoundingBoxMinAtRank ( MLuint rank) const
slot

Returns the min bounding box of the cluster with the given rank.

◆ getImageExtent

QList< MLuint > MLSelectedClustersWrapper::getImageExtent ( ) const
slot

Returns the original image's extent.

◆ getMaxClusterSizeInVoxel

MLuint MLSelectedClustersWrapper::getMaxClusterSizeInVoxel ( ) const
slot

Returns the number of voxels in the largest cluster.

◆ getMaxRankOfSelectedClusters

MLuint MLSelectedClustersWrapper::getMaxRankOfSelectedClusters ( ) const
slot

Returns the maximum rank of all selected clusters and 0 if no cluster is selected.

◆ getMinRankOfSelectedClusters

MLuint MLSelectedClustersWrapper::getMinRankOfSelectedClusters ( ) const
slot

Returns the minimum rank of all selected clusters and 0 if no cluster is selected.

◆ getNumClusters

MLuint MLSelectedClustersWrapper::getNumClusters ( ) const
slot

Returns the number of clusters excluding the background cluster.

◆ getNumSelectedClusters

MLuint MLSelectedClustersWrapper::getNumSelectedClusters ( ) const
slot

Returns the number of currently selected clusters.

◆ getNumVoxelsAtRank

MLuint MLSelectedClustersWrapper::getNumVoxelsAtRank ( MLuint rank) const
slot

Returns the number of voxels of the cluster with the given rank.

◆ getPageExtent

QList< MLuint > MLSelectedClustersWrapper::getPageExtent ( ) const
slot

Returns the original image's page extent.

◆ getRankAtPosition

MLuint MLSelectedClustersWrapper::getRankAtPosition ( QList< MLint > voxelCoordinate) const
slot

Returns the rank of the cluster at the given position.

Returns 0 for the background cluster.

◆ getUserDataAtRank

MLdouble MLSelectedClustersWrapper::getUserDataAtRank ( MLuint rank) const
slot

Returns the user data value of the cluster at the given rank.

◆ getVoxelToWorldMatrix

QList< MLdouble > MLSelectedClustersWrapper::getVoxelToWorldMatrix ( ) const
slot

Returns the voxel-to-world matrix of the original image.

◆ getVoxelVolumeInMilliliters

MLdouble MLSelectedClustersWrapper::getVoxelVolumeInMilliliters ( ) const
slot

Returns the volume of a single voxel in ml.

◆ getWorldToVoxelMatrix

QList< MLdouble > MLSelectedClustersWrapper::getWorldToVoxelMatrix ( ) const
slot

Returns the world-to-voxel matrix of the original image.

◆ isSelectedAtRank

bool MLSelectedClustersWrapper::isSelectedAtRank ( MLuint rank) const
slot

Returns whether the cluster at the given rank is selected.

Note that the background cluster is always rank 0 and is never selected.

◆ isUsing2DNeighborhood

bool MLSelectedClustersWrapper::isUsing2DNeighborhood ( ) const
slot

Returns whether a 2D neighborhood was used during the analysis.

◆ ranks

QList< MLuint > MLSelectedClustersWrapper::ranks ( ) const
slot

Returns a list of ranks of all clusters.

◆ selectedRanks

QList< MLuint > MLSelectedClustersWrapper::selectedRanks ( ) const
slot

Returns a list of ranks of all selected clusters.

◆ setSelectedAtPosition

void MLSelectedClustersWrapper::setSelectedAtPosition ( QList< MLint > voxelCoordinate)
slot

Sets the cluster at the given position selected.

Note that the background cannot be selected.

◆ setSelectedAtRank

void MLSelectedClustersWrapper::setSelectedAtRank ( MLuint rank,
bool selectionState = true )
slot

Sets the selection state of the cluster at the given rank.

Note that the background cluster is always rank 0 and cannot be selected.

◆ setSelectedAtRanks

void MLSelectedClustersWrapper::setSelectedAtRanks ( QList< MLuint > ranksToSelect)
slot

Selects the clusters at the given ranks.

◆ setUserDataAtRank

void MLSelectedClustersWrapper::setUserDataAtRank ( MLuint rank,
MLdouble userData )
slot

Sets the user data value of the cluster at the given rank.