ICells Interface Reference

import "Imaris.idl";

Inheritance diagram for ICells:
IDataItem

Public Member Functions

HRESULT AddCell ([in] ULONG aTime,[in] IDataSet *aDataset)
HRESULT AddNucleus ([in] ULONG aCellIndex,[in] IDataSet *aDataset)
HRESULT AddVesicle ([in] ULONG aCellIndex,[in] VARIANT aData)
HRESULT GetCell ([in] ULONG aCellIndex,[out, retval] IDataSet **aCell)
HRESULT GetCellColor ([out] FLOAT *aR,[out] FLOAT *aG,[out] FLOAT *aB,[out] FLOAT *aA)
HRESULT GetCenterOfMass ([out, retval] VARIANT *aCenterOfMass)
HRESULT GetIndicesT ([out, retval] VARIANT *aIndicesT)
HRESULT GetNucleiCenterOfMass ([in] ULONG aCellIndex,[out, retval] VARIANT *aNucleiCenterOfMass)
HRESULT GetNucleus ([in] ULONG aCellIndex,[in] ULONG aNucleusIndex,[out, retval] IDataSet **aNucleus)
HRESULT GetNucleusColor ([out] FLOAT *aR,[out] FLOAT *aG,[out] FLOAT *aB,[out] FLOAT *aA)
HRESULT GetNucleusTrackEdges ([out, retval] VARIANT *aNucleusTrackEdges)
HRESULT GetNumberOfCells ([out, retval] ULONG *aNumOfCells)
HRESULT GetNumberOfNuclei ([out, retval] VARIANT *aNumOfNuclei)
HRESULT GetSelectedIndices ([out, retval] VARIANT *aCellIndices)
HRESULT GetSelectedNucleusIndices ([out, retval] VARIANT *aNucleusIndices)
HRESULT GetSelectedVesiclesIndices ([out, retval] VARIANT *aVesiclesIndices)
HRESULT GetTimePoint ([in] ULONG aTimeIndex,[out, retval] BSTR *aTimePoint)
HRESULT GetTrackEdges ([out, retval] VARIANT *aTrackEdges)
HRESULT GetVesicles ([in] ULONG aCellIndex,[out, retval] VARIANT *aVesicles)
HRESULT GetVesiclesColor ([out] FLOAT *aR,[out] FLOAT *aG,[out] FLOAT *aB,[out] FLOAT *aA)
HRESULT GetVesiclesTrackEdges ([out, retval] VARIANT *aVesiclesTrackEdges)
HRESULT RemoveCell ([in] ULONG aCellIndex)
HRESULT RemoveNucleus ([in] ULONG aCellIndex,[in] ULONG aNucleusIndex)
HRESULT RemoveVesicle ([in] ULONG aCellIndex,[in] ULONG aVesicleIndex)
HRESULT SetCell ([in] ULONG aCellIndex,[in] IDataSet *aCell)
HRESULT SetCellColor ([in] FLOAT aR,[in] FLOAT aG,[in] FLOAT aB,[in] FLOAT aA)
HRESULT SetNucleus ([in] ULONG aCellIndex,[in] ULONG aNucleusIndex,[in] IDataSet *aNucleus)
HRESULT SetNucleusColor ([in] FLOAT aR,[in] FLOAT aG,[in] FLOAT aB,[in] FLOAT aA)
HRESULT SetNucleusTrackEdges ([in] VARIANT aNucleusTrackEdges)
HRESULT SetSelectedIndices ([in] VARIANT aCellIndices)
HRESULT SetSelectedNucleusIndices ([in] VARIANT aNucleusIndices)
HRESULT SetSelectedVesiclesIndices ([in] VARIANT aVesiclesIndices)
HRESULT SetTimePoint ([in] ULONG aTimeIndex,[in] BSTR aTimePoint)
HRESULT SetTrackEdges ([in] VARIANT aTrackEdges)
HRESULT SetVesicles ([in] ULONG aCellIndex,[in] VARIANT aVesicles)
HRESULT SetVesiclesColor ([in] FLOAT aR,[in] FLOAT aG,[in] FLOAT aB,[in] FLOAT aA)
HRESULT SetVesiclesTrackEdges ([in] VARIANT aVesiclesTrackEdges)

Detailed Description

This class allows an exchange of cell data.


Member Function Documentation

HRESULT ICells::AddCell ( [in] ULONG  aTime,
[in] IDataSet aDataset 
)

Add a cell to a time point.

Parameters:
aTime [in] Time point index (index counting starts with 0)
aDataset [in] uint8 type of IDataSet*
 %% The following MATLAB code adds the cell to time point 10.
 %% The Cells object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 aDataset = vCell.GetCell(10);
 vCells.AddCell(0,aDataset);
 
HRESULT ICells::AddNucleus ( [in] ULONG  aCellIndex,
[in] IDataSet aDataset 
)

Add a nucleus to a cell

Parameters:
aCellIndex [in] cell to be contained in
aDataset [in] uint8 type of IDataSet*
 %% The following MATLAB code adds the nucleus with index 1 of cell 0 to cell 10.
 %% The Cells object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 aDataset = vCell.GetNucleus(0,1);
 vCells.AddNucleus(10,aDataset);
 
HRESULT ICells::AddVesicle ( [in] ULONG  aCellIndex,
[in] VARIANT  aData 
)

Add a vesicle to a cell.

Parameters:
aCellIndex [in] cell to be contained in
aData [in] array of X-,Y-,Z- coordinates and a radius value (all float)
 %% The following MATLAB code adds a vesicle to (1.5, 2.3, 3.8) with radius 5.0 to 
 %% the cell with index 5. The coordinates of the vesicle must be in the cell.
 %% The Cells object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 vCell.AddVesicle(5, [1.5, 2.3, 3.8, 5.0]);
 
HRESULT ICells::GetCell ( [in] ULONG  aCellIndex,
[out, retval] IDataSet **  aCell 
)

Get the mask of a cell. It returns a 2D/3D IDataset with values being either 0 or 1.

Parameters:
aCellIndex [in]
aCell [out] IDataset of cell with index aCellIndex
 %% The following MATLAB code returns the boolean mask of the first cell object.
 %% The cell surface component object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 aCell=vCells.GetCell(0);
 
HRESULT ICells::GetCellColor ( [out] FLOAT *  aR,
[out] FLOAT *  aG,
[out] FLOAT *  aB,
[out] FLOAT *  aA 
)

Get the diffusion color of all cells. It returns the color as an RGBA value.

Parameters:
aR [out] Red channel ranging from (0,1)
aG [out] Green channel ranging from (0,1)
aB [out] Blue channel ranging from (0,1)
aA [out] Alpha value (1-opacity) ranging from (0,1)
 %% The following MATLAB code gets the diffusion color of all cells of the current cell surface component.
 %% The cell surface component object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 [aR,aG,aB,aA] = vCells.GetColor();
 
HRESULT ICells::GetCenterOfMass ( [out, retval] VARIANT *  aCenterOfMass  ) 

Get the centers of mass of all cells. It returns an Nx3 array.

Parameters:
aCenterOfMass [out]
 %% The following MATLAB code gets the centers of mass of all cells.
 %% The cell surface component object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 aCenterOfmass = vCells.GetCenterOfMass()
 aCenterOfMass =
		90.3025		79.5936		16.1544
		171.0964	191.1426	16.1926
		101.3420	78.0807		16.1535
		164.8343	196.7478	16.1917
		106.3916	80.5567		16.1530
		155.5373	191.0897	16.1916
		...		...		...
 
HRESULT ICells::GetIndicesT ( [out, retval] VARIANT *  aIndicesT  ) 

Get the time index for all cells. It returns a 1D array of integers. Indices starts at 0.

Parameters:
aIndicesT [out] Time indices for all N cells [t0 t1 t2 ... t(N-1)]
 %% The following MATLAB code returns the tN time indices of cell objects.
 %% The cell surface component object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 aIndicesT=vCells.GetIndicesT
 aIndicesT =
		0		1
 
HRESULT ICells::GetNucleiCenterOfMass ( [in] ULONG  aCellIndex,
[out, retval] VARIANT *  aNucleiCenterOfMass 
)

Get the centers of mass of each nuclei of a cell.

Parameters:
aCellIndex [in] Cell containing the nuclei
aNucleiCenterOfMass [out] Nx3 array holding N centers of mass with their coordinates (x,y,z)
 %% The following MATLAB code gets the center of mass of the nucleus in cell with index 2.
 %% The cell surface component object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 vNucleiCenterOfMass = vCells.GetNucleiCenterOfMass(2)
 vNucleiCenterOfMass =
		94.5635		64.4428		16.0000
	
HRESULT ICells::GetNucleus ( [in] ULONG  aCellIndex,
[in] ULONG  aNucleusIndex,
[out, retval] IDataSet **  aNucleus 
)

Get the mask of a nucleus. It returns an IDataset with values being either 0 or 1.

Parameters:
aCellIndex [in]
aNucleusIndex [in]
aNucleus [out] IDataset of nucleus with index aNucleusIndex contained in cell with aCellIndex
 %% The following MATLAB code returns the boolean mask of the 1st nucleus object in the 2nd cell.
 %% The cell surface component object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 aNucleus=vCells.GetNucleus(1,0)
 aNucleus =
		0		1
 
HRESULT ICells::GetNucleusColor ( [out] FLOAT *  aR,
[out] FLOAT *  aG,
[out] FLOAT *  aB,
[out] FLOAT *  aA 
)

Get the diffusion color of all nuclei. It returns the color as an RGBA value.

Parameters:
aR [out] Red channel ranging from (0,1)
aG [out] Green channel ranging from (0,1)
aB [out] Blue channel ranging from (0,1)
aA [out] Alpha value (1-opacity) ranging from (0,1)
 %% The following MATLAB code gets the diffusion color of all nuclei of the current cell surface component.
 %% The cell surface component object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 [aR,aG,aB,aA] = vCells.GetNucleusColor();
 
HRESULT ICells::GetNucleusTrackEdges ( [out, retval] VARIANT *  aNucleusTrackEdges  ) 

Get the edges (connections) between nuclei. A 2D array (Nx4) of integers is returned. The numbers are indices to nuclei within cells. Each quadruple of indices represents an edge. Please note that the indices are not necessarily sorted.

Parameters:
aNucleusTrackEdges [out] 2D array of (Nx4) indices [cellIndexA, nucleusIndexA, cellIndexB, nucleusIndexB]
 %% The following MATLAB code gets the edges of nuclei of the Cells object (graph).
 %% The Cells object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 aNucleusTrackEdges=vCells.GetNucleusTrackEdges;
 aNucleusTrackEdges =
		0		4		1		5
		4		7		5		8
		7		10		8		11
		1		5		2		6
		5		8		6		9
		...		...		...		...
 
HRESULT ICells::GetNumberOfCells ( [out, retval] ULONG *  aNumOfCells  ) 

Get the number of all cells.

Parameters:
aNumOfCells [out]
 %% The following MATLAB code gets the number of all cells.
 %% The cell surface component object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 aNumOfCell = vCells.GetNumberOfCells()
 aNumCell =
		12
 
HRESULT ICells::GetNumberOfNuclei ( [out, retval] VARIANT *  aNumOfNuclei  ) 

Get the number of nuclei per cell in a Nx1 array where N is the number of cells.

Parameters:
aNumOfNuclei [out] Number of Nuclei
 %% The following MATLAB code gets the number of nuclei per cell. Index in the array is the corresponding cell index + 1.
 %% The cell surface component object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 vNumOfNuclei = vCells.GetNumberOfNuclei
 vNumOfNuclei =
		1
		1
		1
		1
		1
		1
	
HRESULT ICells::GetSelectedIndices ( [out, retval] VARIANT *  aCellIndices  ) 

Get the sub-selection. Sub-selection consists of cells indices only, no tracks.

Parameters:
aCellIndices [out] Nx1 array of indices
 %% The following MATLAB code gets the sub-selection of a Cells object.
 %% The Cells object is assumed to be selected in the Surpass Scene tree.
 vCells = vImarisApplication.mSurpassSelection;
 vIndices = vCells.GetSelectedIndices
 vIndices =
		3
		13
 
HRESULT ICells::GetSelectedNucleusIndices ( [out, retval] VARIANT *  aNucleusIndices  ) 

Get the sub-selection. Sub-selection consists of nuclei indices only, no tracks.

Parameters:
aNucleusIndices [out] Nx2 array of indices of a cell containing the nucleus
 %% The following MATLAB code gets the sub-selection of nuclei.
 %% The Cells object is assumed to be selected in the Surpass Scene tree.
 vCells = vImarisApplication.mSurpassSelection;
 aNucleusIndices = vCells.GetSelectedNucleusIndices
 aNucleusIndices =
		1		8
		2		4	
 
HRESULT ICells::GetSelectedVesiclesIndices ( [out, retval] VARIANT *  aVesiclesIndices  ) 

Get the sub-selection. Sub-selection consists of vesicles indices only, no tracks.

Parameters:
aVesiclesIndices [out] Nx2 array of indices of a cell containing the vesicle
 %% The following MATLAB code gets the sub-selection of nuclei.
 %% The Cells object is assumed to be selected in the Surpass Scene tree.
 vCells = vImarisApplication.mSurpassSelection;
 aVesiclesIndices = vCells.GetSelectedVesiclesIndices
 aVesiclesIndices =
		0		0
		1		10	
 
HRESULT ICells::GetTimePoint ( [in] ULONG  aTimeIndex,
[out, retval] BSTR *  aTimePoint 
)

Get the time calibration.

Parameters:
aTimeIndex [in] Time index (index counting starts with 0)
aTimePoint [out] Time calibration "YYYY-MM-DD HH:MM:SS.SSS".
 %% The following MATLAB code gets the time calibration for the specified time point.
 %% The Cells object is assumed to be selected in the Surpass Scene tree.
 aTimeIndex=25;
 vCells=vImarisApplication.mSurpassSelection;
 aTimePoint=vCells.GetTimePoint(aTimeIndex)
 aTimePoint =
	2006-05-11 13:30:00.000
 
HRESULT ICells::GetTrackEdges ( [out, retval] VARIANT *  aTrackEdges  ) 

Get the edges (connections) between the cells. A 2D array (Nx2) of integers is returned. The numbers are indices to cells within the Cells object. Each pair of indices represents an edge. Please note that the indices are not necessarily sorted.

Parameters:
aTrackEdges [out] 2D array of (Nx2) cells indices
 %% The following MATLAB code gets the edges of the Cells object (graph).
 %% The Cells object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 aTrackEdges=vCells.GetTrackEdges;
 aTrackEdges =
		0		4
		4		7
		7		10
		1		5
		5		8
		...		...
 
HRESULT ICells::GetVesicles ( [in] ULONG  aCellIndex,
[out, retval] VARIANT *  aVesicles 
)

Get the positions and radii of all vesicles contained in a certain cell.

Parameters:
aCellIndex [in] Index identifying a cell.
aVesicles [out] Kx4 array containing positions and radii of K vesicles
 %% The following MATLAB code gets the positions and radii of all vesicles of the first cell. The return value is a 
 %% 4x4 matrix (X, Y, Z, radius).
 %% The cell surface component object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 vVesicles = vCells.GetVesicles(0)
 vVesicles =
		66.7421		98.3521		16.4987		5.0000
		84.6999		95.9813		16.4986		5.0000
		110.8900	96.1161		16.4985		5.0000
		115.0850	105.8250	16.4985		5.0000
 
HRESULT ICells::GetVesiclesColor ( [out] FLOAT *  aR,
[out] FLOAT *  aG,
[out] FLOAT *  aB,
[out] FLOAT *  aA 
)

Get the diffusion color of all vesicles. It returns the color as an RGBA value.

Parameters:
aR [out] Red channel ranging from (0,1)
aG [out] Green channel ranging from (0,1)
aB [out] Blue channel ranging from (0,1)
aA [out] Alpha value (1-opacity) ranging from (0,1)
 %% The following MATLAB code gets the diffusion color of all vesicles of the current cell surface component.
 %% The cell surface component object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 [aR,aG,aB,aA] = vCells.GetVesiclesColor();
 
HRESULT ICells::GetVesiclesTrackEdges ( [out, retval] VARIANT *  aVesiclesTrackEdges  ) 

Get the edges (connections) between the vesicles. A 2D array (Nx4) of integers is returned. The numbers are indices to vesicles within cells within the Cells object. Each quadruple of indices represents an edge. Please note that the indices are not necessarily sorted.

Parameters:
aVesiclesTrackEdges [out] 2D array of (Nx4) indices [cellIndexA, vesicleIndexA, cellIndexB, vesicleIndexB]
 %% The following MATLAB code gets the edges of vesicles of the Cells object (graph).
 %% The Cells object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 aVesiclesTrackEdges=vCells.GetVesiclesTrackEdges;
 aVesiclesTrackEdges =
		0		5		1		5
		4		7		5		8
		7		8		8		11
		1		5		2		6
		3		8		2		9
		...		...		...		...
 
HRESULT ICells::RemoveCell ( [in] ULONG  aCellIndex  ) 

Remove a cell and its nucleus/nuclei and vesicle/s

Parameters:
aCellIndex [in] cell index
 %% The following MATLAB code removes the cell with index 8.
 %% The Cells object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 vCells.RemoveCell(8);
 
HRESULT ICells::RemoveNucleus ( [in] ULONG  aCellIndex,
[in] ULONG  aNucleusIndex 
)

Remove a nucleus.

Parameters:
aCellIndex [in] cell index
aNucleusIndex [in] nucleus index
 %% The following MATLAB code removes the nucleus with index 8 contained in cell with index 12.
 %% The Cells object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 vCells.RemoveNucleus(12,8);
 
HRESULT ICells::RemoveVesicle ( [in] ULONG  aCellIndex,
[in] ULONG  aVesicleIndex 
)

Remove a vesicle.

Parameters:
aCellIndex [in] cell index
aVesicleIndex [in] vesicle index
 %% The following MATLAB code removes the vesicle with index 6 contained in cell with index 9.
 %% The Cells object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 vCells.RemoveVesicle(9,6);
 
HRESULT ICells::SetCell ( [in] ULONG  aCellIndex,
[in] IDataSet aCell 
)

Set the data (mask) of a cell.

Parameters:
aCellIndex [in]
aCell [in]
 %% The following MATLAB code sets a new boolean mask of the first cell object.
 %% The cell surface component object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 vCells.SetCell(0, aCell);
 
HRESULT ICells::SetCellColor ( [in] FLOAT  aR,
[in] FLOAT  aG,
[in] FLOAT  aB,
[in] FLOAT  aA 
)

Set the diffusion color of all cells. Color is represented as an RGBA value.

Parameters:
aR [in] Red channel ranging from (0,1)
aG [in] Green channel ranging from (0,1)
aB [in] Blue channel ranging from (0,1)
aA [in] Alpha value (1-opacity) ranging from (0,1)
 %% The following MATLAB code sets the diffusion color of all cells to red with full opacity.
 %% The cell surface component object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 vCells.SetColor(1.0,0.0,0.0,0.0);
 
HRESULT ICells::SetNucleus ( [in] ULONG  aCellIndex,
[in] ULONG  aNucleusIndex,
[in] IDataSet aNucleus 
)

Set the mask of a nucleus.

Parameters:
aCellIndex [in]
aNucleusIndex [in]
aNucleus [in]
 %% The following MATLAB code sets a new boolean mask of the first nucleus object in the second cell.
 %% The cell surface component object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 vCells.SetNucleus(1, 0, aNucleus);
 
HRESULT ICells::SetNucleusColor ( [in] FLOAT  aR,
[in] FLOAT  aG,
[in] FLOAT  aB,
[in] FLOAT  aA 
)

Set the diffusion color of all nuclei. Color is represented as an RGBA value.

Parameters:
aR [in] Red channel ranging from (0,1)
aG [in] Green channel ranging from (0,1)
aB [in] Blue channel ranging from (0,1)
aA [in] Alpha value (1-opacity) ranging from (0,1)
 %% The following MATLAB code sets the diffusion color of all nuclei to red with full opacity.
 %% The cell surface component object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 vCells.SetNucleusColor(1.0,0.0,0.0,0.0);
 
HRESULT ICells::SetNucleusTrackEdges ( [in] VARIANT  aNucleusTrackEdges  ) 

Set the edges (connections) between nuclei in cells. The numbers are indices to nuclei within cells within the Cells object. Each quadruple of indices represents an edge. The indices do not need to be sorted.

Parameters:
aNucleusTrackEdges [in] 2D array of (Nx4) indices [cellIndexA, nucleusIndexA, cellIndexB, nucleusIndexB]
 %% The following MATLAB code sets edges of nuclei in cells (graph).
 %% The Cells object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 aNucleusTrackEdges = [ [0, 3, 1, 5] ; [4, 10, 6, 12] ];
 vCells.SetNucleusTrackEdges(aNucleusTrackEdges);
 
HRESULT ICells::SetSelectedIndices ( [in] VARIANT  aCellIndices  ) 

Set the sub-selection. Sub-selection consists of cells indices only, no tracks.

Parameters:
aCellIndices [in] Nx1 array
 %% The following MATLAB code sets the sub-selection of the first 6 cells of a Cells object.
 %% The Cells object is assumed to be selected in the Surpass Scene tree.
 vCells = vImarisApplication.mSurpassSelection;
 aCellIndices = 0:5;
 vCells.SetSelectedIndices(aCellIndices);
 
HRESULT ICells::SetSelectedNucleusIndices ( [in] VARIANT  aNucleusIndices  ) 

Set the sub-selection. Sub-selection consists of nuclei indices only, no tracks.

Parameters:
aNucleusIndices [in] Nx2 array of indices of a cell containing the nucleus
 %% The following MATLAB code sets the sub-selection of the vesicle with index 8 in the 2nd cell 
 %% and the one with index 4 in the 3rd cell.
 %% The Cells object is assumed to be selected in the Surpass Scene tree.
 vCells = vImarisApplication.mSurpassSelection;
 aNucleusIndices = [1,8;2,4];
 vCells.SetSelectedIndices(aNucleusIndices);
 
HRESULT ICells::SetSelectedVesiclesIndices ( [in] VARIANT  aVesiclesIndices  ) 

Set the sub-selection. Sub-selection consists of vesicles indices only, no tracks.

Parameters:
aVesiclesIndices [in] Nx2 array of indices of a cell containing the vesicle
 %% The following MATLAB code sets the sub-selection of the 9th vesicle in the 2nd cell 
 %% and the 5th in the 3rd cell.
 %% The Cells object is assumed to be selected in the Surpass Scene tree.
 vCells = vImarisApplication.mSurpassSelection;
 aVesiclesIndices = [1,8;2,4];
 vCells.SetSelectedIndices(aVesiclesIndices);
 
HRESULT ICells::SetTimePoint ( [in] ULONG  aTimeIndex,
[in] BSTR  aTimePoint 
)

Set the time calibration.

Parameters:
aTimeIndex [in] Time index (index counting starts with 0)
aTimePoint [in] Time calibration "YYYY-MM-DD HH:MM:SS.SSS".
 %% The following MATLAB code sets the time calibration for the specified time point.
 %% The Cells object is assumed to be selected in the Surpass Scene tree.
 aTimeIndex=25;
 aTimePoint='2006-05-11 13:30:00.000';
 vCells=vImarisApplication.mSurpassSelection;
 vCells.SetTimePoint(aTimeIndex,aTimePoint);
 
HRESULT ICells::SetTrackEdges ( [in] VARIANT  aTrackEdges  ) 

Set the edges (connections) between the cells. The numbers are indices to cells within the Cells object. Each pair of indices represents an edge. The indices do not need to be sorted.

Parameters:
aTrackEdges [in] 2D array of (Nx2) cells indices
 %% The following MATLAB code sets the edges of the Cells object (graph).
 %% The Cells object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 aTrackEdges = [ [0 1]; [1 7] ];
 vCells.SetTrackEdges(aTrackEdges);
 
HRESULT ICells::SetVesicles ( [in] ULONG  aCellIndex,
[in] VARIANT  aVesicles 
)

Set the positions and radii of vesicles to be contained in a certain cell.

Parameters:
aCellIndex [in] Index identifying a cell
aVesicles [in] Kx4 array containing positions and radii of K vesicles
 %% The following MATLAB code sets the positions and radii of 1 vesicle of the cell with index 4.
 %% Existing vesicle is removed. Use AddVesicles() for adding.
 %% The cell surface component object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 vVesicles = vCell.SetVesicles(4,[103.4,97.9,15.1,7.0]);
 
HRESULT ICells::SetVesiclesColor ( [in] FLOAT  aR,
[in] FLOAT  aG,
[in] FLOAT  aB,
[in] FLOAT  aA 
)

Set the diffusion color of all vesicles. Color is represented as an RGBA value.

Parameters:
aR [in] Red channel ranging from (0,1)
aG [in] Green channel ranging from (0,1)
aB [in] Blue channel ranging from (0,1)
aA [in] Alpha value (1-opacity) ranging from (0,1)
 %% The following MATLAB code sets the diffusion color of all nuclei to red with full opacity.
 %% The cell surface component object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 vCells.SetVesiclesColor(1.0,0.0,0.0,0.0);
 
HRESULT ICells::SetVesiclesTrackEdges ( [in] VARIANT  aVesiclesTrackEdges  ) 

Set the edges (connections) between vesicles in cells. The numbers are indices to vesicles within cells within the Cells object. Each quadruple of indices represents an edge. The indices do not need to be sorted.

Parameters:
aVesiclesTrackEdges [in] 2D array of (Nx4) indices [cellIndexA, vesicleIndexA, cellIndexB, vesicleIndexB]
 %% The following MATLAB code sets the edges of vesicles in cells of the Cells object (graph).
 %% The Cells object is assumed to be selected in the Surpass Scene tree.
 vCells=vImarisApplication.mSurpassSelection;
 aVesiclesTrackEdges = [ [0, 3, 1, 5] ; [4, 10, 6, 12] ];
 vCells.SetVesiclesTrackEdges(aVesiclesTrackEdges);
 

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

Generated on Mon Jun 14 20:23:41 2010 for Imaris 7.1 COM Interface by  doxygen 1.6.1