IMeasurementPoints Interface Reference

import "Imaris.idl";

Inheritance diagram for IMeasurementPoints:

Public Member Functions
HRESULT	Get ([out] VARIANT *aPositionsXYZ,[out] VARIANT *aIndicesT,[out] VARIANT *aNames)
HRESULT	GetIndicesT ([out, retval] VARIANT *aIndicesT)
HRESULT	GetNames ([out, retval] VARIANT *aNames)
HRESULT	GetPositionsXYZ ([out, retval] VARIANT *aPositionsXYZ)
HRESULT	Set ([in] VARIANT aPositionsXYZ,[in] VARIANT aIndicesT,[in] VARIANT aNames)

---

Detailed Description

A measurement point defines a location in 4D (3D + time) and a name. An "IMeasurementPoints" object can be used to measure 3d distances and channel intensities.

---

Member Function Documentation

HRESULT IMeasurementPoints::Get	(	[out] VARIANT *	aPositionsXYZ,
		[out] VARIANT *	aIndicesT,
		[out] VARIANT *	aNames
	)

Get all measurement point, names, and time indices at once. It is equivalent to calling "GetPositionsXYZ", "GetNames", and "GetIndicesT" in sequence.

Parameters:

	aPositionsXYZ	[out] A 2D array (N x 3) of float [x y z]N, where N is the number of measurement points.
	aIndicesT	[out] An 1D array of integers. The sequence and number of the time indices must correspond to the sequence and number of measurement point positions aPositionsXYZ.
	aNames	[out] An 1D array of float. The sequence and number of the radii must correspond to the sequence and number of measurement point positions aPositionsXYZ.

 %% The following MATLAB code gets the N positions, names and time indices for the measurement points.
 %% The MeasurementPoints object is assumed to be selected in the Surpass Scene tree.
 vMeasurementPoints = vImarisApplication.mSurpassSelection;
 [vPositionsXYZ, vIndicesT, vNames] = vMeasurementPoints.Get;
 

HRESULT IMeasurementPoints::GetIndicesT

(

[out, retval] VARIANT *

aIndicesT

)

Get the time index for all measurement points. It returns a 1D array of integers. Each index corresponds to a measurement point position of "GetPositionsXYZ". Indices starts at 0.

Parameters:

aIndicesT

[out] Time indices for all N measurement points [t0 t1 t2 ... t(N-1)]

 %% The following MATLAB code returns the tN time indices of the measurement points.
 %% The MeasurementPoints object is assumed to be selected in the Surpass Scene tree.
 vMeasurementPoints = vImarisApplication.mSurpassSelection;
 vIndicesT = vMeasurementPoints.GetIndicesT
 vIndicesT =
        0           1
 

HRESULT IMeasurementPoints::GetNames

(

[out, retval] VARIANT *

aNames

)

Get the names for all N spots. It returns a 1D array of string.

Parameters:

aNames

[out] Names of all N spots [r0 r1 r2 ... t(N-1)]

 %% The following MATLAB code returns the rN names of the measurement points.
 %% The MeasurementPoints object is assumed to be selected in the Surpass Scene tree.
 vMeasurementPoints = vImarisApplication.mSurpassSelection;
 vNames = vMeasurementPoints.GetNames
 vNames =
        'A'    'B'
 

HRESULT IMeasurementPoints::GetPositionsXYZ

(

[out, retval] VARIANT *

aPositionsXYZ

)

Get the vertex positions of all (N) measurement points as a 2D array (N x 3) of float [x y z]N.

Parameters:

aPositionsXYZ

[out] 2D array of positions [x y z]N

 %% The following MATLAB code returns the [x,y,z]-coordinates of the measurement points.
 %% The MeasurementPoints object is assumed to be selected in the Surpass Scene tree.
 vMeasurementPoints = vImarisApplication.mSurpassSelection;
 vPositionsXYZ = aMeasurementPoints.GetPositionsXYZ
 vPositionsXYZ =
       45.3925   45.0123    2.6857
       46.2532    0.9108   10.5750
 

HRESULT IMeasurementPoints::Set	(	[in] VARIANT	aPositionsXYZ,
		[in] VARIANT	aIndicesT,
		[in] VARIANT	aNames
	)

Set all measurement point positions, names, and time indices at once.

Parameters:

	aPositionsXYZ	[in] A 2D array (N x 3) of float [x y z]N, where N is the number of measurement points.
	aIndicesT	[in] An 1D array of integers. The sequence and number of the time indices must correspond to the sequence and number of measurement point positions aPositionsXYZ.
	aNames	[in] An 1D array of string. The sequence and number of the names must correspond to the sequence and number of measurement point positions aPositionsXYZ. If the array is empty, automatic names are generated (A, B, C, etc.)

 %% The following MATLAB code sets the N positions, names and time indices for the measurement points.
 %% The MeasurementPoints object is assumed to be selected in the Surpass Scene tree.
 vMeasurementPoints = vImarisApplication.mSurpassSelection;
 %% Make sure that none of the specified values are out of range!
 vPositionsXYZ = [10 37 10; 15 20 8];
 vIndicesT = [0 0];
 vNames = ['A' 'B'];
 vMeasurementPoints.Set(vPositionsXYZ, vIndicesT, vNames);
 

---

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

• Imaris.idl