ConnectedComponentsInfo

MLModule

author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	MLCluster
definition	MLCluster.def
see also	ComputeConnectedComponents, ConnectedComponentsToImage, FilterConnectedComponents
keywords	region, segmentation, cluster, neighborhood, select

Purpose

The module ConnectedComponentsInfo shows information about connected components clusters in an image.

It also shows cluster information for a selectable voxel or for a specific cluster given by its rank.

Details

The module has a Info Fields Are Valid; this is the field where a field listener should be attached to.

The min/max bounding box fields for single clusters or for all selected clusters combined are meant to be connected to the start and end fields of a SubImage module; the max bounding box position (the end of the bounding box) is meant to be inclusive.

Windows

Default Panel

Input Fields

inClusters

name: inClusters, type: SelectedClusters(MLBase)

For accessing this object via scripting, see the Scripting Reference: MLSelectedClustersWrapper.

Parameter Fields

Field Index

Bounding Box (selectedClustersBoundingBox): String	Info Cluster Is Selected: Bool	Num Selected Clusters: Integer
Bounding Box (infoClusterBoundingBox): String	Info Cluster Num Voxels: Integer	Page Extent: Vector6
Bounding Box Max (selectedClustersBoundingBoxMax): Vector3	Info Cluster Rank: Integer	Position: Vector3
Bounding Box Max (infoClusterBoundingBoxMax): Vector3	Info Cluster User Data: Double	Rank: Integer
Bounding Box Min (selectedClustersBoundingBoxMin): Vector3	Info Fields Are Valid: Bool	Selection Mode: Enum
Bounding Box Min (infoClusterBoundingBoxMin): Vector3	Is Selection Inverted: Bool	Update: Trigger
Clear: Trigger	Is using 2D neighborhood: Bool	Update Mode: Enum
Highest Rank Selected Clusters: Integer	Lowest Rank Selected Clusters: Integer	Voxel To World Matrix: Matrix
Image Extent: Vector6	Max Cluster Size In Voxel: Integer	Voxel Volume In Milliliters: Double
Info Cluster Is Background: Bool	Num Clusters: Integer	World To Voxel Matrix: Matrix

Visible Fields

Update Mode

name: updateMode, type: Enum, default: AutoUpdate

Defines the module’s update behavior.

Values:

Title	Name	Description
​Clear	​AutoClear	​The module clears its fields on any input change or on changing the info voxel’s position.
​Update	​AutoUpdate	​The module computes all output field values on any input change or change to the info voxel position.

Update

name: update, type: Trigger

When pressed, the module computes anew.

Clear

name: clear, type: Trigger

When pressed, the module’s output is cleared.

Num Clusters

name: numClusters, type: Integer, persistent: no

Shows the total number of clusters in the image.

Num Selected Clusters

name: numSelectedClusters, type: Integer, persistent: no

Shows the number of selected/filtered clusters.

Is Selection Inverted

name: isSelectionInverted, type: Bool, persistent: no

Shows whether the selection was inverted.

Lowest Rank Selected Clusters

name: lowestRankSelectedClusters, type: Integer, persistent: no, deprecated name: minRankSelectedClusters

Shows the lowest rank of all selected clusters.

Note that lowest rank number is higher than the highest rank number. The lower the rank, the higher the number. The lower the rank, the smaller the cluster.

Highest Rank Selected Clusters

name: highestRankSelectedClusters, type: Integer, persistent: no, deprecated name: maxRankSelectedClusters

Shows the highest rank of all selected clusters.

Note that highest rank number is lower than the lowest rank number. The higher the rank, the lower the number. The higher the rank, the larger the cluster.

Bounding Box Min (selectedClustersBoundingBoxMin)

name: selectedClustersBoundingBoxMin, type: Vector3, persistent: no

Shows the minimum bounding box of all currently selected clusters.

Bounding Box Max (selectedClustersBoundingBoxMax)

name: selectedClustersBoundingBoxMax, type: Vector3, persistent: no

Shows the maximum bounding box of all currently selected clusters. This position is inclusive.

Bounding Box (selectedClustersBoundingBox)

name: selectedClustersBoundingBox, type: String, persistent: no

Shows the bounding box of all selected clusters as a string.

This string can be directly connected to the bounding box string of the SubImage module in Start+End mode.

Is using 2D neighborhood

name: isUsing2DNeighborhood, type: Bool, persistent: no

Shows whether a 2D neighborhood was used to compute the clusters.

Max Cluster Size In Voxel

name: maxClusterSizeInVoxel, type: Integer, persistent: no

Shows the number of voxels of the largest cluster after filtering/selecting.

Image Extent

name: imageExtent, type: Vector6, persistent: no

Shows the input image’s extent.

Page Extent

name: pageExtent, type: Vector6, persistent: no

Shows the input image’s page extent.

Voxel To World Matrix

name: voxelToWorldMatrix, type: Matrix, persistent: no

Shows the input image’s voxel-to-world matrix.

World To Voxel Matrix

name: worldToVoxelMatrix, type: Matrix, persistent: no

Shows the input image’s world-to-voxel matrix.

Voxel Volume In Milliliters

name: voxelVolumeInMilliliters, type: Double, persistent: no

Shows the volume of a single voxel in milliliters.

Selection Mode

name: infoClusterSelectionMode, type: Enum, default: SelectByPosition

Defines the selection mode for clusters.

Values:

Title	Name	Description
​Position	​SelectByPosition	​The selection is based on a position set in Position.
​Rank	​SelectByRank	​The selection is based on a cluster’s rank set in Rank.

Position

name: selectInfoClusterByVoxelPosition, type: Vector3, default: 0 0 0

Sets a voxel position and by that, selects a single info cluster where this voxel is part of for further investigation.

Rank

name: selectInfoClusterByRank, type: Integer, default: 1, minimum: 0

Sets a rank of a cluster that should be selected.

If a value 0 or greater than the maximum amount of clusters is chosen, the background cluster is selected.

Info Cluster Is Background

name: infoClusterIsBackground, type: Bool, persistent: no

Shows whether the selected single info cluster is the background.

Info Cluster Is Selected

name: infoClusterIsSelected, type: Bool, persistent: no

Shows whether the selected single info cluster is selected.

Info Cluster Num Voxels

name: infoClusterNumVoxels, type: Integer, persistent: no

Shows the number of voxel of the single selected cluster where the selected voxel is part of.

Info Cluster Rank

name: infoClusterRank, type: Integer, persistent: no

Shows the rank of the single selected cluster.

Info Cluster User Data

name: infoClusterUserData, type: Double, persistent: no

Shows the user data value stored in the single selected cluster.

The user data value can only be changed by Python scripting, the value is set to the cluster’s rank by default.

Bounding Box Min (infoClusterBoundingBoxMin)

name: infoClusterBoundingBoxMin, type: Vector3, persistent: no

Shows the minimum corner position of the selected cluster’s bounding box.

Bounding Box Max (infoClusterBoundingBoxMax)

name: infoClusterBoundingBoxMax, type: Vector3, persistent: no

Shows the maximum corner position of the selected cluster’s bounding box. This position is inclusive.

Bounding Box (infoClusterBoundingBox)

name: infoClusterBoundingBox, type: String, persistent: no

Shows the bounding box of the selected cluster as a string.

This string can be directly connected to the bounding box string of the SubImage module in Start+End mode.

Info Fields Are Valid

name: infoFieldsAreValid, type: Bool, persistent: no

Shows whether the information fields are valid. This field is cleared only once but triggered on each valid update.