IVolume Interface Reference

import "Imaris.idl";

Inheritance diagram for IVolume:

Public Types
typedef enum IVolume::tMode	tMode
enum	tMode { eModeBlend = 0, eModeMIP = 1 }
Properties
tMode	mMode [get, set]
FLOAT	mThreshold [get, set]

---

Detailed Description

A Volume object can only appear once in a Surpass scene. It renders the voxel intensities of a 3D stack with multiple channels over time.

---

Member Typedef Documentation

typedef enum IVolume::tMode IVolume::tMode

Volume rendering mode

---

Member Enumeration Documentation

enum IVolume::tMode

Volume rendering mode

Enumerator:

eModeBlend	Voxels with a high intensity close to the camera obscure voxels behind them.
eModeMIP	The voxels with the highest intensities along Z are drawn.

---

Property Documentation

tMode IVolume::mMode [get, set]

Get current rendering mode.

Parameters:

aMode

[out] Rendering mode (tMode), can be either eModeBlend or eModeMIP

 %% The following MATLAB code gets the rendering mode of the Volume object.
 %% The Volume object is assumed to be selected in the Surpass Scene tree.
 aVolume=vImarisApplication.mSurpassSelection;
 aMode=aVolume.mMode
 aMode =
    eModeBlend
 

Set the rendering mode.

Parameters:

aMode

[in] Rendering mode (tMode), can be either eModeBlend or eModeMIP

 %% The following MATLAB code sets the rendering mode of the Volume object.
 %% The Volume object is assumed to be selected in the Surpass Scene tree.
 aVolume=vImarisApplication.mSurpassSelection;
 aMode='eModeMIP'; %% must be a string
 aVolume.mMode=aMode;
 

FLOAT IVolume::mThreshold [get, set]

Return the current clipping threshold.

Parameters:

aThreshold

[out] Intensity clipping threshold (float)

 %% The following MATLAB code gets the intensity clipping threshold.
 %% The Volume object is assumed to be selected in the Surpass Scene tree.
 aVolume=vImarisApplication.mSurpassSelection;
 aThreshold=aVolume.mThreshold
 aThreshold =
    0
 

Clip the rendering of all voxels with intensity lower than user-defined threshold.

Parameters:

aThreshold

[in] Intensity clipping threshold (float)

 %% The following MATLAB code clips the intensities of the Volume object based on a user-defined threshold.
 %% The Volume object is assumed to be selected in the Surpass Scene tree.
 aVolume=vImarisApplication.mSurpassSelection;
 aThreshold=128;
 aVolume.mThreshold=aThreshold;
 

---

The documentation for this interface was generated from the following file:

• Imaris.idl