IApplication Interface Reference

import "Imaris.idl";

Public Types

typedef enum IApplication::tViewer tViewer
enum  tViewer {
  eViewerSlice = 0, eViewerSection = 1, eViewerGallery = 2, eViewerEasy3D = 3,
  eViewerSurpass = 5, eViewerColoc = 6
}

Public Member Functions

HRESULT AddImaris5Password ([in] BSTR aPassword)
HRESULT DataSetPushUndo (BSTR aUndoName)
HRESULT Execute ([in] BSTR aCommand)
HRESULT FileOpen ([in] BSTR aFileName,[in, defaultvalue("")] BSTR aOptions)
HRESULT FileSave ([in] BSTR aFileName,[in, defaultvalue("")] BSTR aOptions)
HRESULT GetChannelVisibility ([in] ULONG aIndexC,[out, retval] VARIANT_BOOL *aVisible)
HRESULT GetCurrentFileName ([out, retval] BSTR *aFileName)
HRESULT Quit ()
HRESULT SaveSnapShot ([in] BSTR aFileName)
HRESULT SetChannelVisibility ([in] ULONG aIndexC,[in] VARIANT_BOOL aVisible)
HRESULT SetLicenseString ([in] BSTR aLicenseString)

Properties

IDataSet mDataSet [get, set]
IFactory mFactory [get]
IImageProcessing mImageProcessing [get]
LONG mMainWnd [get]
ISurpassCamera mSurpassCamera [get]
LONG mSurpassCameraToolBarWnd [get]
IDataContainer mSurpassScene [get, set]
IDataItem mSurpassSelection [get, set]
LONG mSurpassToolBarWnd [get]
VARIANT_BOOL mUserControl [get, set]
BSTR mVersion [get]
tViewer mViewer [get, set]
VARIANT_BOOL mVisible [get, set]
VARIANT_BOOL mVisibleChannelVisibility [get, set]
VARIANT_BOOL mVisibleColocToolBar [get, set]
VARIANT_BOOL mVisibleDisplayAdjustment [get, set]
VARIANT_BOOL mVisibleEasy3dCameraToolBar [get, set]
VARIANT_BOOL mVisibleEasy3dToolBar [get, set]
VARIANT_BOOL mVisibleFull3dCameraToolBar [get, set]
VARIANT_BOOL mVisibleFull3dToolBar [get, set]
VARIANT_BOOL mVisibleGalleryCameraToolBar [get, set]
VARIANT_BOOL mVisibleGalleryToolBar [get, set]
ULONG mVisibleIndexT [get, set]
VARIANT_BOOL mVisibleInfoToolBar [get, set]
VARIANT_BOOL mVisibleMainMenu [get, set]
VARIANT_BOOL mVisibleMainToolBar [get, set]
VARIANT_BOOL mVisibleSectionCameraToolBar [get, set]
VARIANT_BOOL mVisibleSectionToolBar [get, set]
VARIANT_BOOL mVisibleSliceCameraToolBar [get, set]
VARIANT_BOOL mVisibleSliceMeasurementToolBar [get, set]
VARIANT_BOOL mVisibleSliceToolBar [get, set]
VARIANT_BOOL mVisibleStatusBar [get, set]
VARIANT_BOOL mVisibleSurpassCameraToolBar [get, set]
VARIANT_BOOL mVisibleSurpassKeyFrameToolBar [get, set]
VARIANT_BOOL mVisibleSurpassToolBar [get, set]
VARIANT_BOOL mVisibleTimeToolBar [get, set]

Detailed Description

This class is the entry point to Imaris. The main members through which to access image raw data and image meta data are "mDataSet" and "mSurpassScene". There is also a set of methods which allows a basic inquiry and setup of Imaris' configuration. The Imaris application is started with the creation of an "Imaris.Application" object, and terminates when deleting it. Note that the client application has to delete every instance of any Imaris class to bring Imaris to exit. 

 %% The following MATLAB code starts Imaris and makes it visible...
  vImarisApplication=actxserver('Imaris.Application');
  vImarisApplication.mVisible=true;
  %% ... and loads a file.
  vImarisApplication.FileOpen('c:\program files\bitplane\imaris 4\images\retina.ims', '');
  %% We let Imaris survive when "vImarisApplication" is deleted
  vImarisApplication.mUserControl=true;

Member Typedef Documentation

typedef enum IApplication::tViewer IApplication::tViewer

Identification of Imaris' main viewers.

Member Enumeration Documentation

enum IApplication::tViewer

Identification of Imaris' main viewers.

Enumerator:
eViewerSlice 

simple xy section

eViewerSection 

xy, xz and yz (extended) section

eViewerGallery 

slide by slide in a gallery

eViewerEasy3D 

orthogonal mip / blend

eViewerSurpass 

ortho section, volume, isosurface, etc.

eViewerColoc 

statistics of overlapping channels (colocalization)

Member Function Documentation

HRESULT IApplication::AddImaris5Password ( [in] BSTR  aPassword  ) 

Add a password to the list of the passwords to be tried for loading compressed Imaris5 files. AddImaris5Password must be called before FileOpen to be effective.

 %% The following MATLAB code return the name of the dataset opened in Imaris
 vPassword = 'retinapass';
 vFileName = 'C:\Retina.ims';
 vImarisApplication.AddImaris5Password(vPassword);
 vImarisApplication.FileOpen(vFileName);
HRESULT IApplication::DataSetPushUndo ( BSTR  aUndoName  ) 

Makes a copy of the current dataset. The user can pop this copy by executing "undo" from the edit menu. The size of the stack is limited (number of undo steps). The default stack size is 1. Use "Clone" for a custom undo-system.

Parameters:
aUndoName [in] Name for the undo point (string): it will be displayed in the Edit :: Undo {aUndoName} menu
 %% The following MATLAB code creates an undo point
 vImarisApplication.DataSetPushUndo;
HRESULT IApplication::Execute ( [in] BSTR  aCommand  ) 

Execute a command

Deprecated

HRESULT IApplication::FileOpen ( [in] BSTR  aFileName,
[in, defaultvalue("")] BSTR  aOptions 
)

Opens a File. The file format can either be detected automatically or defined manually. Furthermore the dataset can be resampled and cropped while loading. This enables more sophisticated handling with huge datasets.

Parameters:
aFileName [in] Full path to a file
aOptions [in] Set up extra options to specify file format, resampling or cropping parameters for loading. Use "" for default options (automatic file type detection, no cropping and no resampling)

  • reader="Imaris3"
    Advice to use the "Bitplane Imaris 3" format. There are several other formats available:
    All Formats, Imaris3, Imaris2, ICS, Lsm510, Lsm410, AxioVision, LeicaSingle, LeicaSeries, LeicaVista, Biorad, TILLvisION, MetamorphSTK, DeltaVision, Olympus, OlympusCellR, OlympusOIF, IPLab, OmeXml, SeriesAdjustable, TiffSeries, BmpSeries.
  • croplimitsmin="x0 y0 z0 c0 t0"
    Minimum crop position for x, y, z, ch and t. Use "0 0 0 0 0" for croplimitsmin and croplimitsmax to disable cropping.
  • croplimitsmax="x y z c t"
    The point next to the maximum crop position for x, y, z, ch and t. If one of the components is set to zero, the maximum crop position is automatically set to the size of the dataset along the corresponding dimension.
  • resample="rx ry rz rc rt"
  • LoadDataSet="eDataSetYes | eDataSetNo | eDataSetWithDialog"
    Down-sampling factor for x, y, z, ch and t. "1 1 1 1 1" does not resample. The size of the loaded dataset is equal to "(croplimitsmax - croplimitsmin) / resample" along each dimension (e.g. "(x-x0)/rx").
Returns:
  • S_OK if method was executed without error
  • DISP_E_EXCEPTION if something failed (see ErrorInfo).
 %% The following MATLAB code opens the example image "retina.ims" with the Imaris3 reader, with cropping and resampling enabled for x and y (while loading all slices, all channels, all time points)
 vImarisApplication.FileOpen('c:\program files\bitplane\imaris 4\images\retina.ims', ...
                             ['reader="Imaris3" ' ...
                              'croplimitsmin="10 10 0 0 0" ' ...
                              'croplimitsmax="150 100 0 0 0" ' ...
                              'resample="2 2 1 1 1"']);
HRESULT IApplication::FileSave ( [in] BSTR  aFileName,
[in, defaultvalue("")] BSTR  aOptions 
)

Saves a file. The file format is by default the native Imaris format (Imaris3). Alternatively the format can be specified by the save options.

Parameters:
aFileName [in] Full path to file
aOptions [in] Set up extra parameters for saving a dataset. The default "" saves the data as an Imaris file (Imaris3).

  • writer="Imaris3"
    Advice to use the "Bitplane Imaris 3" format. There are several other formats available: Imaris3, Imaris2, SeriesAdjustable, TiffSeriesRGBA, ICS, OlympusCellR, OmeXml, BMPSeries, AVI: compressed. *
Returns:
  • S_OK if method was executed without error
  • DISP_E_EXCEPTION if something failed (see ErrorInfo).
 %% The following MATLAB code saves current dataset as "retina1.ims" with the Imaris3 writer
  vImarisApplication.FileSave('c:\retina1.ims',
                              'writer="Imaris3"');
HRESULT IApplication::GetChannelVisibility ( [in] ULONG  aIndexC,
[out, retval] VARIANT_BOOL *  aVisible 
)

Get the visibility of a channel

Parameters:
aIndexC [in] Channel index (index counting starts with 0)
aVisible [out] Visibility flag: true (1) visible, false (0) hidden
 %% The following MATLAB code gets the visibility of the selected channel
 aIndexC=0;
 aVisible=vImarisApplication.GetChannelVisibility(aIndexC)
 aVisible =
    0
HRESULT IApplication::GetCurrentFileName ( [out, retval] BSTR *  aFileName  ) 

Return the name of the dataset opened in Imaris

 %% The following MATLAB code return the name of the dataset opened in Imaris
 vFileName = vImarisApplication.GetCurrentFileName
 vFileName = 
   'C:\Retina.ims'
HRESULT IApplication::Quit (  ) 

Close Imaris. In fact the main windows is only invisible and Imaris terminates when the instance of the client's application class is deleted.

 %% The following MATLAB code closes Imaris
 vImarisApplication.Quit;
HRESULT IApplication::SaveSnapShot ( [in] BSTR  aFileName  ) 

Create a Snapshot file

 %% The following MATLAB code saves a snapshot of the current view
 vImarisApplication.SaveSnapShot('C:\Snapshot.tif');
HRESULT IApplication::SetChannelVisibility ( [in] ULONG  aIndexC,
[in] VARIANT_BOOL  aVisible 
)

Set the visibility of a channel

Parameters:
aIndexC [in] Channel index (index counting starts with 0)
aVisible [in] Visibility flag: true (1) visible, false (0) hidden
 %% The following MATLAB code sets the selected channel to hidden
 aIndexC=0;
 aVisible=0;
 vImarisApplication.SetChannelVisibility(aIndexC,aVisible);
HRESULT IApplication::SetLicenseString ( [in] BSTR  aLicenseString  ) 

Enable access to most of the members of Imaris classes (license protection). Without a valid license a COM exception is thrown. Methods which are needed for basic configuration do not check for a license. "SetLicenseString" enables to temporary add such a license to Imaris. Please contact Bitplane for more detailed information.

Parameters:
aLicenseString [in] License string
Returns:
S_OK if method was executed without error
DISP_E_EXCEPTION if something failed (see ErrorInfo).
 %% The following MATLAB code sets a license string (of course the license below is not valid)
  vImarisApplication.SetLicenseString('FEATURE ImarisIPSS ...');

Property Documentation

IDataSet IApplication::mDataSet [get, set]

Get the current dataset. Imaris has always one active dataset. This means that multiple dataset objects can be created and initialized, but only one of them can be visualized. After starting Imaris "mDataSet" is an empty dataset (size of all dimensions is zero, data type is unknown). See IDataSet for more details.

Parameters:
aDataSet [out] Current (active) Dataset
 %% The following MATLAB code gets the current dataset
 aDataSet=vImarisApplication.mDataSet;

Set a new current dataset. Imaris has always one active dataset. This means that multiple dataset objects can be created and initialized, but only one of them can be visualized. After starting Imaris "mDataSet" is an empty dataset (size of all dimensions is zero, data type is unknown). See IDataSet for more details.

Parameters:
aDataSet [in] Dataset
 %% The following MATLAB code creates and sets a dataset
 aDataSet=vImarisApplication.mFactory.CreateDataSet;
 vImarisApplication.mDataSet=aDataSet;
IFactory IApplication::mFactory [get]

Get a factory to create and compare various objects in Imaris (read only).

Parameters:
aFactory [out] IFactory object
 %% The following MATLAB code gets the IFactory object
 aFactory=vImarisApplication.mFactory;
IImageProcessing IApplication::mImageProcessing [get]

Get the Image Processing

Parameters:
aImageProcessing [out] Image Processing object
 %% The following MATLAB code gets the Image Processing object
 aImageProcessing=vImarisApplication.aImageProcessing
LONG IApplication::mMainWnd [get]

Get the handle of the main window (read only).

Parameters:
aMainWnd [out] Handle of the main window (integer)
 %% The following MATLAB code gets the handle of the main window
 aMainWnd=vImarisApplication.mMainWnd
 mMainWnd =
    460106
ISurpassCamera IApplication::mSurpassCamera [get]

Get the Surpass camera (orientation, position, zoom)

Parameters:
aSurpassCamera [out] Surpass camera object
 %% The following MATLAB code gets the Surpass camera
 aSurpassCamera=vImarisApplication.mSurpassCamera;
LONG IApplication::mSurpassCameraToolBarWnd [get]

Get the handle of the surpass camera toolbar widow (read only).

Parameters:
aSurpassCameraToolBarWnd [out] Handle of the surpass camera toolbar window
 %% The following MATLAB code gets the handle of the surpass camera toolbar window
 aSurpassCameraToolBarWnd=vImarisApplication.mSurpassCameraToolBarWnd;
 aSurpassCameraToolBarWnd =
   656764
IDataContainer IApplication::mSurpassScene [get, set]

Get the root node of the surpass scene. See IDataContainer for more details.

Parameters:
aSurpassScene [out] Surpass scene
 aSurpassScene=vImarisApplication.mSurpassScene;

Set the root node of the surpass scene. See IDataContainer for more details.

Parameters:
aSurpassScene [in] Surpass scene
  %% The following MATLAB code creates a surpass scene and adds a few objects to it
  %%
  %% Create the surpass scene
  vSurpassScene=vImarisApplication.mFactory.CreateDataContainer;
  vSurpassScene.mName = 'My surpasss scene';
  %% Add a light source
  vLightSource=vImarisApplication.mFactory.CreateLightSource;
  vLightSource.mName='My light source';
  %% Set up the surpass scene
  vImarisApplication.mSurpassScene=vSurpassScene;
  vImarisApplication.mSurpassScene.AddChild(vLightSource);
IDataItem IApplication::mSurpassSelection [get, set]

Get the currently selected object in the surpass tree. If nothing is selected, "null" (or zero) is returned.

Parameters:
aDataItem [out] Currently selected dataitem
 %% The following MATLAB code gets the currently selected dataitem
 aDataItem=vImarisApplication.mSurpassSelection;

Set the currently selected object in the surpass tree. Set it to "null" (or zero) to remove any selection.

Parameters:
aDataItem [in] Currently selected dataitem
 %% The following MATLAB code sets the currently selected dataitem to ...
 %% ...nothing
 vImarisApplication.mSurpassSelection=0;
 %% ... to the Volume object (which is the selected object in the SurpassScene)
 vImarisApplication.mSurpassSelection=vImarisApplication.mSurpassSelection;
LONG IApplication::mSurpassToolBarWnd [get]

Get the handle of the surpass toolbar window (read only).

Parameters:
aSurpassToolBarWnd [out] Handle of the surpass toolbar window
 %% The following MATLAB code gets the handle of the surpass toolbar window
 aSurpassToolBarWnd=vImarisApplication.mSurpassToolBarWnd;
 aSurpassToolBarWnd =
   656136
VARIANT_BOOL IApplication::mUserControl [get, set]

Get the execution control of the application.

Parameters:
aUserControl [out] Execution control of Imaris. If it is "true" (1), Imaris terminates when the last instance of a COM object is deleted. If "false" (0), Imaris keeps on running even if the client is terminated. When Imaris is started by a user (from command line or double-click on the icon), the default value is "true".
 %% The following MATLAB code gets the execution control of Imaris
 aUserControl=vImarisApplication.mUserControl
 aUserControl =
    1

Set the execution control of the application.

Parameters:
aUserControl [in] Execution control of Imaris. If set to "true" (1), Imaris terminates when the last instance of a COM object is deleted. If set to "false" (0), Imaris keeps on running even if the client is terminated. If Imaris is started by a client, the default value is "false". When Imaris is started by a user (from command line or double-click on the icon), the default value is "true".
 %% The following MATLAB code sets the execution control of Imaris to true
 vImarisApplication.mUserControl=1;
BSTR IApplication::mVersion [get]

Return the program version and date of Imaris.

Parameters:
aVersion [out] Program version and date of Imaris (string)
 %% The following MATLAB code gets the program version and date of Imaris
 aVersion=vImarisApplication.mVersion
 aVersion =
    Imaris 5.0.0 [May 11 2006]
tViewer IApplication::mViewer [get, set]

Get the active viewer.

Parameters:
aViewer [out] Active viewer
 %% The following MATLAB code gets the active viewer
 aViewer=vImarisApplication.mViewer
 aViewer =
    eViewerSurpass

Set the active viewer.

Parameters:
aViewer [out] Active viewer
 %% The following MATLAB code sets the active viewer
 aViewer='eViewerSection';
 vImarisApplication.mViewer=aViewer;
VARIANT_BOOL IApplication::mVisible [get, set]

Get the visibility of the main window.

Parameters:
aVisible [out] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code gets the visibility of the main window
 aVisible=vImarisApplication.mVisible
 aVisible =
    1
 %% The following MATLAB code toggles the visibility of the main window
 vImarisApplication.mVisible=~vImarisApplication.mVisible;

Set the visibility of the main window.

Parameters:
aVisible [in] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code sets the main window to visible
 aVisible=1;
 vImarisApplication.mVisible=aVisible;
 %% The following MATLAB code toggles the visibility of the main window
 vImarisApplication.mVisible=~vImarisApplication.mVisible;
VARIANT_BOOL IApplication::mVisibleChannelVisibility [get, set]

Get the visibility of the channel visibility tool bar (all views).

Parameters:
aVisible [out] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code gets the visibility of the channel visibility tool bar
 aVisible=vImarisApplication.mVisibleChannelVisibility
 aVisible =
    1

Set the visibility of the channel visibility tool bar (all views).

Parameters:
aVisible [in] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code sets the visibility of the channel visibility tool bar
 aVisible=1;
 vImarisApplication.mVisibleChannelVisibility=aVisible;
VARIANT_BOOL IApplication::mVisibleColocToolBar [get, set]

Get the visibility of the coloc tool bar (coloc view).

Parameters:
aVisible [out] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code gets the visibility of the coloc tool bar
 aVisible=vImarisApplication.mVisibleColocToolBar
 aVisible =
    1

Set the visibility of the coloc tool bar (coloc view).

Parameters:
aVisible [in] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code sets the visibility of the coloc tool bar
 aVisible=1;
 vImarisApplication.mVisibleColocToolBar=aVisible;
VARIANT_BOOL IApplication::mVisibleDisplayAdjustment [get, set]

Get the visibility of the display adjustments tool bar (all views).

Parameters:
aVisible [out] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code gets the visibility of the display adjustments tool bar
 aVisible=vImarisApplication.mVisibleDisplayAdjustment
 aVisible =
    1

Set the visibility of the display adjustments tool bar (all views).

Parameters:
aVisible [in] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code sets the visibility of the display adjustments tool bar
 aVisible=1;
 vImarisApplication.mVisibleDisplayAdjustment=aVisible;
VARIANT_BOOL IApplication::mVisibleEasy3dCameraToolBar [get, set]

Get the visibility of the camera tool bar (easy3d view).

Deprecated. Use property mVisibleStatusBar instead.

Set the visibility of the camera tool bar (easy3d view).

Deprecated. Use property mVisibleStatusBar instead.

VARIANT_BOOL IApplication::mVisibleEasy3dToolBar [get, set]

Get the visibility of the easy 3D tool bar (easy3d view).

Parameters:
aVisible [out] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code gets the visibility of the easy 3D tool bar
 aVisible=vImarisApplication.mVisibleEasy3dToolBar
 aVisible =
    1

Set the visibility of the easy 3D tool bar (easy3d view).

Parameters:
aVisible [in] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code sets the visibility of the easy 3D tool bar
 aVisible=1;
 vImarisApplication.mVisibleEasy3dToolBar=aVisible;
VARIANT_BOOL IApplication::mVisibleFull3dCameraToolBar [get, set]

Get the visibility of the camera tool bar (full3d view).

Deprecated.

Set the visibility of the camera tool bar (full3d view).

Deprecated.

VARIANT_BOOL IApplication::mVisibleFull3dToolBar [get, set]

Get the visibility of the full 3d rendering tool bar (full3d view).

Deprecated.

Set the visibility of the full 3d rendering tool bar (full3d view).

Deprecated.

VARIANT_BOOL IApplication::mVisibleGalleryCameraToolBar [get, set]

Get the visibility of the camera tool bar (gallery view).

Deprecated. Use property mVisibleStatusBar instead.

Set the visibility of the camera tool bar (gallery view).

Deprecated. Use property mVisibleStatusBar instead.

VARIANT_BOOL IApplication::mVisibleGalleryToolBar [get, set]

Get the visibility of the gallery tool bar (gallery view).

Parameters:
aVisible [out] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code gets the visibility of the gallery tool bar
 aVisible=vImarisApplication.mVisibleGalleryToolBar
 aVisible =
    1

Set the visibility of the gallery tool bar (gallery view).

Parameters:
aVisible [in] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code sets the visibility of the gallery tool bar
 aVisible=1;
 vImarisApplication.mVisibleGalleryToolBar=aVisible;
ULONG IApplication::mVisibleIndexT [get, set]

Get the time index of the currently visible time point.

Parameters:
aVisibleIndexT [out] Index of the currently visible time point (index counting starts with 0)
 %% The following MATLAB code gets the currently visible time point
 aVisibleIndexT=vImarisApplication.mVisibleIndexT
 aVisible =
    19

Set the time index of the currently visible time point.

Parameters:
aVisibleIndexT [in] Index of the time point to be displayed (index counting starts with 0)
 %% The following MATLAB code sets the time point to be displayed
 aVisibleIndexT=21;
 vImarisApplication.mVisibleIndexT=aVisibleIndexT;
VARIANT_BOOL IApplication::mVisibleInfoToolBar [get, set]

Get the visibility of the info tool bar (weblink).

Deprecated. Use property mVisibleMainToolBar instead.

Set the visibility of the info tool bar (weblink).

Deprecated. Use property mVisibleMainToolBar instead.

VARIANT_BOOL IApplication::mVisibleMainMenu [get, set]

Get the visibility of the main menu bar.

Parameters:
aVisible [out] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code gets the visibility of the main menu bar
 aVisible=vImarisApplication.mVisibleMainMenu
 aVisible =
    1

Set the visibility of the main menu bar.

Parameters:
aVisible [in] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code sets the visibility of the main menu bar
 aVisible=1;
 vImarisApplication.mVisibleMainMenu=aVisible;
VARIANT_BOOL IApplication::mVisibleMainToolBar [get, set]

Get the visibility of the main tool bar (file open, viewer selection).

Parameters:
aVisible [out] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code gets the visibility of the main tool bar
 aVisible=vImarisApplication.mVisibleMainToolBar
 aVisible =
    1

Set the visibility of the main tool bar (file open, viewer selection).

Parameters:
aVisible [in] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code sets the visibility of the main tool bar
 aVisible=1;
 vImarisApplication.mVisibleMainToolBar=aVisible;
VARIANT_BOOL IApplication::mVisibleSectionCameraToolBar [get, set]

Get the visibility of the camera tool bar (section view).

Deprecated. Use property mVisibleStatusBar instead.

Set the visibility of the camera tool bar (section view).

Deprecated. Use property mVisibleStatusBar instead.

VARIANT_BOOL IApplication::mVisibleSectionToolBar [get, set]

Get the visibility of the section tool bar (section view).

Parameters:
aVisible [out] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code gets the visibility of the section tool bar
 aVisible=vImarisApplication.mVisibleSectionToolBar
 aVisible =
    1

Set the visibility of the section tool bar (section view).

Parameters:
aVisible [in] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code sets the visibility of the section tool bar
 aVisible=1;
 vImarisApplication.mVisibleSectionToolBar=aVisible;
VARIANT_BOOL IApplication::mVisibleSliceCameraToolBar [get, set]

Get the visibility of the camera tool bar (slice view).

Deprecated. Use property mVisibleStatusBar instead.

Set the visibility of the camera tool bar (slice view).

Deprecated. Use property mVisibleStatusBar instead.

VARIANT_BOOL IApplication::mVisibleSliceMeasurementToolBar [get, set]

Get the visibility of the measurement tool bar (slice view).

Parameters:
aVisible [out] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code gets the visibility of the measurement tool bar
 aVisible=vImarisApplication.mVisibleSliceMeasurementToolBar
 aVisible =
    1

Set the visibility of the measurement tool bar (slice view).

Parameters:
aVisible [in] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code sets the visibility of the measurement tool bar
 aVisible=1;
 vImarisApplication.mVisibleSliceMeasurementToolBar=aVisible;
VARIANT_BOOL IApplication::mVisibleSliceToolBar [get, set]

Get the visibility of the slice tool bar (slice view).

Parameters:
aVisible [out] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code gets the visibility of the slice tool bar
 aVisible=vImarisApplication.mVisibleSliceToolBar
 aVisible =
    1

Set the visibility of the slice tool bar (slice view).

Parameters:
aVisible [in] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code sets the visibility of the slice tool bar
 aVisible=1;
 vImarisApplication.mVisibleSliceToolBar=aVisible;
VARIANT_BOOL IApplication::mVisibleStatusBar [get, set]

Get the visibility of the status bar (voxel intensitie, zoom, etc.)

Parameters:
aVisible [out] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code gets the visibility of the status bar
 aVisible=vImarisApplication.mVisibleStatusBar
 aVisible =
    1

Set the visibility of the status bar (voxel intensitie, zoom, etc.)

Parameters:
aVisible [in] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code sets the visibility of the status bar
 aVisible=1;
 vImarisApplication.mVisibleStatusBar=aVisible;
VARIANT_BOOL IApplication::mVisibleSurpassCameraToolBar [get, set]

Get the visibility of the camera tool bar (surpass view).

Parameters:
aVisible [out] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code gets the visibility of the camera tool bar
 aVisible=vImarisApplication.mVisibleSurpassCameraToolBar
 aVisible =
    1

Set the visibility of the camera tool bar (surpass view).

Parameters:
aVisible [in] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code sets the visibility of the camera tool bar
 aVisible=1;
 vImarisApplication.mVisibleSurpassCameraToolBar=aVisible;
VARIANT_BOOL IApplication::mVisibleSurpassKeyFrameToolBar [get, set]

Get the visibility of the keyframe tool bar (surpass view).

Parameters:
aVisible [out] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code gets the visibility of the keyframe tool bar
 aVisible=vImarisApplication.mVisibleSurpassKeyFrameToolBar
 aVisible =
    1

Set the visibility of the keyframe tool bar (surpass view).

Parameters:
aVisible [in] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code sets the visibility of the keyframe tool bar
 aVisible=1;
 vImarisApplication.mVisibleSurpassKeyFrameToolBar=aVisible;
VARIANT_BOOL IApplication::mVisibleSurpassToolBar [get, set]

Get the visibility of the surpass tool bar (surpass view).

Parameters:
aVisible [out] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code gets the visibility of the surpass tool bar
 aVisible=vImarisApplication.mVisibleSurpassToolBar
 aVisible =
    1

Set the visibility of the surpass tool bar (surpass view).

Parameters:
aVisible [in] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code sets the visibility of the surpass tool bar
 aVisible=1;
 vImarisApplication.mVisibleSurpassToolBar=aVisible;
VARIANT_BOOL IApplication::mVisibleTimeToolBar [get, set]

Get the visibility of the time tool bar (all views).

Parameters:
aVisible [out] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code gets the visibility of the time tool bar
 aVisible=vImarisApplication.mVisibleTimeToolBar
 aVisible =
    1

Set the visibility of the time tool bar (all views).

Parameters:
aVisible [in] Visibility: 0 not visible, 1 visible
 %% The following MATLAB code sets the visibility of the time tool bar
 aVisible=1;
 vImarisApplication.mVisibleTimeToolBar=aVisible;
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