labelvolshow

Display labeled volume

Description

Display labeled volumetric data, creating a labelvolshow object with properties that control the appearance of the display. You can embed the intensity volume with the labeled volume and display both volumes at once.

Creation

Syntax

labelvolshow(L)

labelvolshow(L,V)

labelvolshow(___,Name,Value)

h = labelvolshow(___)

Description

labelvolshow(L) displays 3-D labeled volume L in a figure.

labelvolshow(L,V) displays 3-D labeled volume L and 3-D intensity volume V in a figure. L and V must be the same size.

labelvolshow(___,Name,Value) displays volumes, using one or more name-value pairs to set labelvolshow properties that control visualization of the volumes. For a list of these properties, see Properties. Enclose each property in single quotes. For example, 'BackgroundColor'.

h = labelvolshow(___) returns a labelvolshow object, h, with properties that can be used to control visualization of the volumes. Use input arguments from any of the previous syntaxes.

Input Arguments

L — Labeled volume

3-D numeric array

Labeled volume, specified as a 3-D numeric array (m-by-n-by-p).

Data Types: single | double | int8 | int16 | int32 | uint8 | uint16 | uint32 | categorical

V — Intensity volume

3-D numeric array

Intensity volume, specified as a 3-D numeric array (m-by-n-by-p).

Data Types: single | double | int8 | int16 | int32 | uint8 | uint16 | uint32 | logical

Properties

BackgroundColor — Color of background

[0.3 0.75 0.93] (default) | RGB triplet | color name | short color name

Color of the background, specified as a MATLAB^® ColorSpec. The intensities must be in the range [0,1].

CameraPosition — Location of camera

[4 4 2.5] (default) | three-element vector

Location of the camera, or the viewpoint, specified as a three-element vector of the form [x y z]. This vector defines the axes coordinates of the camera location, which is the point from which you view the axes. The camera is oriented along the view axis, which is a straight line that connects the camera position and the camera target. Changing the CameraPosition property changes the point from which you view the volume. For an illustration, see Camera Graphics Terminology (MATLAB). Interactively rotating the volume modifies the value of this property.

CameraUpVector — Vector defining upwards direction

[0 0 1] (default) | three-element vector

Vector defining upwards direction, specified as a three-element vector of the form [x y z]. By default, labelvolshow defines the z-axis as the up direction ([0 0 1]). For an illustration, see Camera Graphics Terminology (MATLAB). Interactively rotating the volume modifies the value of this property.

CameraTarget — Point used as camera target

[0 0 0] (default) | three-element vector

Point used as the camera target, specified as a three-element vector of the form [x y z]. The camera is oriented along the view axis, which is a straight line that connects the camera position and the camera target. For an illustration, see Camera Graphics Terminology (MATLAB).

CameraViewAngle — Field of view

15 (default) | numeric scalar

Field of view, specified as a scalar angle greater than or equal to 0 and less than 180. The greater the angle, the larger the field of view. Also, with bigger angles, objects appear smaller in the scene. For an illustration, see Camera Graphics Terminology (MATLAB).

InteractionsEnabled — Interactivity of volume

true (default) | false

Interactivity of the volume, specified as true (1) or false (0). When true (default), you can zoom in and out on the labeled volume using the mouse scroll wheel, and rotate the volume by clicking and dragging. Rotation and zoom are performed about the value specified by CameraTarget. When this value is false, you cannot interact with the volume.

LabelColor — Color of labels

random colormap (default) | numLabels-by-3 numeric array

Color of labels, specified as a numLabels-by-3 numeric array with values in the range [0 1]. numLabels represents the number of labels in the labeled volume.

LabelOpacity — Opacity of labels

true for all labels except Label 0 (default) | numLabels-by-1 numeric vector

Opacity of labels, specified as a numLabels-by-1 numeric vector with values in the range [0 1]. numLabels represents the number of labels in the labeled volume. LabelOpacity is not supported when embedding volumes together.

LabelsPresent — List of label values

numLabels-by-1 numeric array

This property is read-only.

List of label values, specified as a numLabels-by-1 numeric array.numLabels represents the number of labels in the labeled volume.

LabelVisibility — Visibility of labels

true for all labels except Label 0 (default) | numLabels-by-1 logical mask

Visibility of labels, specified as a numLabels-by-1 logical mask. numLabels represents the number of labels in the labeled volume.

Parent — Parent of labelvolshow object

gcf (default) | uipanel | figure

Parent of the labelvolshow object, specified as a handle to a uipanel or figure. If you do not specify a parent, the parent of the labelvolshow object is gcf.

ScaleFactors — Scale factors used to rescale volume

[1 1 1] (default) | 1-by-3 positive numeric vector

Scale factors used to rescale volumes, specified as a 1-by-3 positive numeric vector. The values in the array correspond to the scale factor applied in the x-, y-, and z-direction.

ShowIntensityVolume — Display intensity volume

true | false

Display intensity volume, specified as true (1) or false (0). When the value is true, the function displays both the labeled volume and the intensity volume. When the value is false, the function only displays the labeled volume. The default is true when the labelvolshow object contains both a labeled volume and an intensity volume. The default is false when the object contains only a labeled volume.

VolumeOpacity — Opacity of volume

0.5 (default) | scalar in the range [0 1]

Opacity of volume, specified as a scalar in the range [0 1]. This value defines the opacity of volume data when both labeled and intensity volumes are embedded together. All the embedded volume intensities above the VolumeThreshold value have the opacity of VolumeOpacity.

VolumeThreshold — Threshold of volume intensities

0.4 (default) | normalized numeric scalar

Threshold of volume intensities, specified as a normalized numeric scalar in the range [0 1]. All the volume intensities below this threshold value have an opacity of 0.

Object Functions

setVolume

Set new labelvolshow object

Examples

View Labeled Volume With and Without Intensity Volume

Create a synthetic volume and categorize the values to create a labeled volume.

vol = rand(100,100,3);
labeledVol = discretize(vol,[0 .25 .75 1],'categorical',...
    {'small','medium','large'});

View the labeled volume and the intensity volume.

h = labelvolshow(labeledVol,vol);

Hide the intensity volume.

h.ShowIntensityVolume = false;

View Labeled Volume and Change Color and Opacity

Create a synthetic volume and categorize the values to create a labeled volume.

vol = rand(100,100,3);
labeledVol = discretize(vol,[0 .25 .75 1],'categorical',...
    {'small','medium','large'});

Display the labeled volume.

h = labelvolshow(labeledVol,vol);

Change the color and opacity.

h.LabelColor(end,:) = [1 1 0];
h.LabelOpacity(2) = 0.1;