_AddOptConf, _AddOptConfForFluo, _ApplyObjectivesXYOffset, _BackupOptConf, _DeviceManagerv2, _ExploreOptConf, _JoystickManager, _ListOfPoints, _ManageDevices, _OptConfSelStimulDevice, _ProbesAndFilters, _RestoreOptConf, _ShutterSelStimulDevice, _WritePort, AddOptConf, BackupOptConf, BlockPort, ClearPort, ClosePort, CopyUserData, DeleteLightPathLastUsed, DeleteOptConf, DeleteOptConfs, DeleteUserData, EnablePortCursors, EnableSelectOCFromFilter, GetCurrentLightPathName, GetLightPathCount, GetLightPathIndexName, GetOptConfCount, GetOptConfName, GetSelectedOptConf, Mosaic_SetPattern, OpenPort, ReadPort, ReadPortEx, RestoreOptConf, RestoreOptConfEx, SelectLightPath, SelectOptConf, SelectSetupAndHWConfiguration, SelectSetupAndHWConfigurationNoDialog, SetOpticalConfChanged, SetSaveCameraSetting, SetSaveExposure, SetSaveExposureSetting, ShowDeviceControlDocker, ShowDeviceManagerPad, Stg_ConnectDevice, Stg_DisconnectDevice, Stg_IsStatusStored, Stg_StatusGet, Stg_StatusSet, Stg_StatusStoreAs, SwitchObjectiveAlert, UnblockPort, UnselectOptConf, WaitDeviceTimeOut, WritePort, WritePortAndWait, WritePortEx
Interactive command to this function: Calibration > New Optical Configuration 
Description
AddOptConf( char *CurrOptConf, char *Objective, intNosepieceSetting, intCameraSetting, intMicroscopeSetting, intShutterType, intShutterType2);
This function creates and adds optical configuration to the system. An interactive equivalent of this function is the _AddOptConf function.
Parameters
See Also
_AddOptConf, DeleteOptConf
Description
BackupOptConf(
char *Filename
);This function saves settings of the current optical configurations to an XML file.
See Also
RestoreOptConf
Description
DeleteOptConf(
CurrOptConf
);This function deletes the specified optical configuration.
Note
Objective of the same name will not be deleted.
See Also
AddOptConf, DeleteObjective
Description
EnableSelectOCFromFilter(
int Enabled
);Changes status of the “Select corresponding optical configuration when filter changed” options within the Edit > Options 
window.
Description
int GetOptConfCount();
This function returns a number of defined optical configurations.
Description
GetOptConfName( intIndex, char *CurrOptConf, intObjectiveNameMaxLength);
This function returns the pointer to the name of an optical configuration determined by the Index parameter (position of the configuration in the configurations list). It represents one line of a virtual ordered list of the defined optical configurations.
Description
GetSelectedOptConf( char *OptConfObj, char *OptConfCam, char *OptConfMic, intObjectiveNameMaxLength);
This function returns names of active optical configurations that have an objective, camera, or a microscope settings assigned to them.
Parameters
Description
RestoreOptConf(
char *Filename
);This function loads optical configuration settings from an .xml file.
See Also
BackupOptConf
Description
RestoreOptConfEx( char *Filename, intOptions);
This function loads optical configuration settings from an .xml file.
Parameters
Options This parameter specifies how to deal with items which already exist in the software.
Opens a dialog window and asks the user what to do. | |
Imports all items from the file. If an item already exists in the software it will be overwritten. | |
Imports only items which do not already exist in the application. | |
Imports all items from the file. If an item already exists in the software, an index number will be appended to its name. | |
Deletes all items in the software and imports all items from the file. |
See Also
BackupOptConf
Description
SelectOptConf(
char OptConf
);This function selects the specified optical configuration and makes it active.
See Also
_ExploreOptConf, _ExploreObjectives
Description
SetOpticalConfChanged(
int OpticalConf
);This function corresponds to the Edit > General Options > Appearance > When optical configuration settings changed combo box. Sets the behaviour after changing the settings of the Optical Configuration.
Parameters
See Also
_GeneralOptions
Description
SetSaveCameraSetting(
int SaveSetting
);This function corresponds to the Edit > General Options > General > Save all camera settings to optical configuration automatically check box. Sets a behaviour after changing camera settings.
See Also
_GeneralOptions
Description
SetSaveExposure(
int SaveExposure
);Sets status of the Save brightness to optical configuration automatically option. See Edit > Options .
See Also
_GeneralOptions
Description
SetSaveExposureSetting(
int SaveExposure
);Sets status of the Save brightness to optical configuration automatically option. See Edit > Options .
Description
UnselectOptConf(
char CurrOptConf
);This function deactivates an active optical configuration.
Parameters
Note
This function is called when you right click an active optical configuration button and select the Unselect command from the context menu.
This function runs the Calibration > New Optical Configuration command.
Description
_AddOptConf();
This function opens the New Optical Configuration dialog window.
See Also
_ExploreOptConf
This function runs the Calibration > New Optical Configuration for Fluorescent Probe command.
Description
_AddOptConfForFluo();
It displays a dialog window for creating optical configurations including excitation and emission filter characteristics.
See Also
_AddOptConf, AddOptConf
Description
_BackupOptConf();
This function displays the Export Optical Configurations dialog window. The current set of optical configurations can be saved via this window.
This function runs the Calibration > Optical Configurations 
command.
Description
_ExploreOptConf();
The function displays the Optical Configurations dialog window.
Description
_OptConfSelStimulDevice();
This function opens a dialog window which selects an optical configuration used by the stimulation device.
This function runs the Devices > Matching Fluorescent Probes and Filters command.
Description
_ProbesAndFilters();
Description
_RestoreOptConf();
This function displays the Import Optical Configurations dialog window. Optical configurations previously saved can be loaded via this window.
Description
_ShutterSelStimulDevice();
Opens the Use Shutter as Stimulation Device window enabling to select which shutters are used as stimulation devices.
Description
Stg_ConnectDevice(
char *PhysicalDeviceName
);Connects a physical device specified by its full name. The device must exist in the device manager device list and must be currently disconnected.
Description
Stg_DisconnectDevice(
char *PhysicalDeviceName
);Disconnects the physical device specified by its full name. The device must exist in the device manager device list and must be currently connected.
Description
Stg_IsStatusStored( char *PhysicalDeviceKey, char *LogicalDeviceType, char *LogicalDeviceKey, char *StatusName);
Finds out whether the specified status is stored or not.
Parameters
For an example use case, please see: Stg_StatusStoreAs.
Description
Stg_StatusGet( char *PhysicalDeviceKey, char *LogicalDeviceType, char *LogicalDeviceKey, charBuffer);
This function can be used to find out which device status was set the last. The status is changed after you call the Stg_StatusSet function. Stg_StatusGet will return "".
Parameters
For an example use case, please see: Stg_StatusStoreAs.
Description
Stg_StatusSet( char *PhysicalDeviceKey, char *LogicalDeviceType, char *LogicalDeviceKey, char *StatusName, intStatusUseCache);
Loads the status and sets it to the device.
Parameters
For an example use case, please see: Stg_StatusStoreAs.
Description
Stg_StatusStoreAs( char *PhysicalDeviceKey, char *LogicalDeviceType, char *LogicalDeviceKey, char *StatusName);
Stores the device status into C:\ProgramData\Laboratory Imaging\Platform\DeviceStatusStorage.bin.
Parameters
Example use case showing dynamic changing of the XY stage settings:
char buffer[1000];
int buffer_size;
// Nikon / Prior stage versions:
char *physDevKey = "Nikon Ti"; //"ProScan III";
char *logDevType = "XY"; //"XY";
char *logDevKey = "XYDrive"; //"XY Drive";
// You can store status for the given (physDevKey, logDevType, logDevKey) using Stg_StatusStoreAs(physDevKey, logDevType, logDevKey,"SLOW");
if(1 == Stg_IsStatusStored(physDevKey, logDevType, logDevKey,"SLOW"))
{
// 1 means cache will be used if available -> only differences are set and the function executes faster:
Stg_StatusSet(physDevKey, logDevType, logDevKey,"SLOW",1);
StgMoveXY(1000.00000,1000.00000,1);
}
if(1 == Stg_IsStatusStored(physDevKey, logDevType, logDevKey,"FAST"))
{
// You can find out which device status was set last by using:
Stg_StatusGet(physDevKey, logDevType, logDevKey, buffer);
// Please note that if the status is changed after you call Stg_StatusSet, StgStatusGet will return ""
Int_CreateWindow(1, "Current status", WP_TOPLEFT, 0, 0, 800, 400, buffer, 1, 1, 0, 1, 1, 1, "Courier,,10");
if(strcpy(buffer,"FAST")) // not equal
{
Stg_StatusSet(physDevKey, logDevType, logDevKey,"FAST",1); // use cache again
}
StgMoveXY(-1000.00000,-1000.00000,1);
} Description
SwitchObjectiveAlert();
If turned on (default state), a message box with a warning text is displayed when switching between oil and water/air objectives.
This function runs the Devices > Apply Objectives XY Offset command.
Description
_ApplyObjectivesXYOffset();
Applies XY offsets between objectives based on the values set in the Objective XY Offset dialog window.
This function runs the Devices > Device Manager 
command.
Description
_DeviceManagerv2(
int OverviewMode
);Opens the Device Manager dialog window.
Description
_JoystickManager();
Opens the Device Manager dialog window displaying all connected joysticks and foot pedals together with their plugins shown in the combo box. Move the joystick/pedal to highlight it in the list.
This function is supported by the Filter Particle Analysis application.
This function runs the Devices > List of Points command.
Description
_ListOfPoints();
This function displays the list of points for Multipoint Acquisition.
Description
TRUE _ManageDevices();
Displays a dialog box allowing the user to manage the installed devices.
See Also
Stg_IsLightPresent, Stg_IsFilterPresent, Stg_IsShutterPresent, Stg_IsNosepiecePresent
Description
Mosaic_SetPattern(
char Mosaic_pwsPath
);Sets the illumination pattern for Andor Mosaic.
Description
CopyUserData( char *UserName, char *UserNameDestination);
Copies the user settings such as OCs, other user settings and visibility of modality buttons.
Description
DeleteLightPathLastUsed(
char *Name
);Deletes the last used light path.
Description
DeleteUserData(
char *UserName
);Deletes all device manager data for the specified user.
Description
GetLightPathIndexName( intIndex, char *Name, intMaxTextLength);
Retrieves the name of the light path specified by the index.
Description
GetCurrentLightPathName( char *Name, intMaxTextLength);
Retrieves the name of the currently selected light path.
Description
SelectLightPath(
char *Name
);Selects the light path specified by its name.
This function runs the Devices > Select HW Configuration command.
Description
SelectSetupAndHWConfiguration();
Opens the Setup and Configuration dialog enabling the user to select a hardware configuration or Offline Analysis.
Description
SelectSetupAndHWConfigurationNoDialog( char *SetupName, char *HWConfigName);
Selects the specified Hardware Setup and Hardware Configuration without showing the Setup and Configuration dialog window.
Parameters
This function runs the Devices > Show Lightpath Scheme 
command.
Description
ShowDeviceManagerPad(
int Show
);Opens the Lightpath Scheme.
Description
BlockPort(
int SerialPort
);This function stops the application-to-device default communication on the defined port. This makes the port free to be used by macro applications.
Parameters
See Also
UnblockPort
Description
ClearPort(
int SerialPort
);This function clears the input and output COM buffers.
Parameters
See Also
WritePort, ReadPort, OpenPort, ClosePort, _WritePort
Description
ClosePort(
int SerialPort
);This function closes the opened serial port.
Parameters
Note
If the port is opened, you can close it. If you use scanning stage or light control unit with LIM drivers, these ports are opened automatically when you start NIS-Elements and it is strongly recommended not to close them manually.
See Also
WritePort, ReadPort, OpenPort, ClearPort, _WritePort
Description
EnablePortCursors(
int Enabled
);This function shows/hides cursor, when calling Read/WritePortEx functions.
See Also
ReadPortEx, WaitDeviceTimeOut, WritePortEx
Description
OpenPort( intSerialPort, intBaudRate, intDataBits, char *Parity, intStopBits);
This function sets the port parameters and opens it.
Parameters
Return Values
See Also
WritePort, ReadPort, ClosePort, ClearPort, _WritePort
Description
ReadPort( intSerialPort, intOutString, intLength);
This function reads a string from a serial port. Fixed timeout period is 500 ms.
Parameters
Return Values
Description
int ReadPortEx( intcomm, char *buf, inttoRead, intterminated, inttimeout);
This function reads a string from a serial port. Ending character and timeout can be specified.
Parameters
Return Values
See Also
WritePortEx, WaitDeviceTimeOut
Description
UnblockPort(
int SerialPort
);This function restores the application-to-device default communication on the defined port. The communication may have been stopped by the BlockPort function.
Parameters
See Also
BlockPort
Description
WaitDeviceTimeOut(
int TimeOutEx
);This function sets up the time-out duration when writing/reading to the serial port.
Parameters
Note
This function is called from Write Command to Serial Port dialog box (menu Macro, Write to Port).
See Also
WritePortEx, ReadPortEx
Interactive command to this function: Macro > Write to Port
Description
WritePort( intSerialPort, char *OutString, intCR_Terminated, intWaitForDevice);
This function sends a string to a serial port, and optionally waits for answer. The port must be opened before calling this function. An interactive equivalent is the _WritePort function.
Parameters
OutString OutString is a buffer that typically includes text characters but sometimes also non text characters (e.g. line feed or carriage return). For these cases it is possible to use a special notation, both decimal and hexadecimal inside this OutString.
| Decimal notation |
|---|
| \ddd, where d is 0-9 |
| Hexadecimal notation |
|---|
| \xhh, where h is 0-9 or A-D or a-f |
| Examples of decimal and hexadecimal notation |
|---|
| LF: \010, \x0d, \x0D |
| CR: \013, \x0a, \x0A |
CR_Terminated If CR_Terminated==1, CR character (carriage return, 13 decimally) is appended to the end of the string. Most devices communicate with commands separated by CR.
WaitForDevice If WaitForDevice==1, the system is waiting for answer from the device. If CR_Terminated==1, then the system is waiting for the CR character. If CR_Terminated==0, the system is waiting for the string of characters terminated by 250 ms gap. If there is no answer from the device after time-out, (by default 1 s), it stops and returns error value. You can change the time-out value by double clicking the bottom line of the Write Command to Serial Port dialog box or using the function WaitDeviceTimeOut.
Return Values
Timeout expired - no characters returned (if waiting for answer is performed) | |
Characters successfully send (if waiting for answer is not performed) | |
Length of answer from the device | |
(-ERR_BADPORTOPENWRITE) - invalid handle (e.g. port is not opened or error during clearing the port) | |
(-ERR_BADPORTWRITE) - error writing to the port (e.g. timeout expired during writing characters) |
Examples: 1) ASI MS2000 - switch ZMotor to left WritePortAndWait(port, "EP Z=-1\013", 13); WritePortAndWait(port, "SS Z\013", 13); WritePortAndWait(port, "RESET\013", 13); or WritePort(port, "EP Z=-1", 13, 1, null); WritePort(port, "SS Z", 13, 1); WritePort(port, "RESET", 13, 1); 2) Sutter LambdaSC - open/close WritePortAndWait(port, "\xaa", 13); //open WritePortAndWait(port, "\xac", 13); //close 3) Prior Proscan/Optiscan WritePortAndWait(port, "7 1 1\013", 13); //set filter 1 position 1 4) Conex Polarizer - set position WritePortAndWait(port, "xxPA00\013", 13); //move absolute (xx=deviceid) 5) Uniblitz shutter - open/close WritePort(port, "\x40", 0, 0); //open shutter WritePort(port, "\x41", 0, 0); //close
See Also
WritePortEx, WritePortAndWait, WaitDeviceTimeOut, ReadPort
Description
WritePortAndWait( intSerialPort, char *OutString, intEndChar);
This function is a simplified version of WritePortEx function. It sends character string OutString to serial port and waits for the response terminated by EndChar. The waiting for EndChar is limited by timeout specified by the function WaitDeviceTimeOut (default value is 1s).
Parameters
OutString OutString is a buffer that typically includes text characters but sometimes also non text characters (e.g. line feed or carriage return). For these cases it is possible to use a special notation, both decimal and hexadecimal inside this OutString.
| Decimal notation |
|---|
| \ddd, where d is 0-9 |
| Hexadecimal notation |
|---|
| \xhh, where h is 0-9 or A-D or a-f |
| Examples of decimal and hexadecimal notation |
|---|
| LF: \010, \x0d, \x0D |
| CR: \013, \x0a, \x0A |
Return Values
Response can be read using ReadPort.
timeout expired - no characters returned (if waiting for answer is performed) | |
characters successfully send (if waiting for answer is not performed) | |
length of answer from the device | |
(-ERR_BADPORTOPENWRITE) - invalid handle (e.g. port is not opened or error during clearing the port) | |
(-ERR_BADPORTWRITE) - error writing to the port (e.g. timeout expired during writing characters) |
Examples: 1) ASI MS2000 // Z Motor is attached to the left knob // RESET command is an exeptional one, it replies the char : WritePortAndWait(port, "EP Z=-1\013", 13); WritePortAndWait(port, "SS Z\013", 13); WritePortAndWait(port, "RESET\013", ':'); or WritePort(port, "EP Z=-1", 13, 1, null); WritePort(port, "SS Z", 13, 1); WritePort(port, "RESET\013", ':', 1); 2) Sutter LambdaSC - open/close //open shutter WritePortAndWait(port, "\xaa", 13); //close shutter WritePortAndWait(port, "\xac", 13); 3) Prior Proscan/Optiscan //set FW #1 to the position #2 WritePortAndWait(port, "7 1 2\013", 13); 4) Conex Polarizer // set position, xx means deviceID WritePortAndWait(port, "xxPA00\013", 13); //move absolute 5) Uniblitz shutter This device does not reply to the commands open/close, Elements does not wait for the reply, a simplified function WritePort is used. //open shutter WritePort(port, "\x40", 0, 0); //close WritePort(port, "\x41", 0, 0);
See Also
WritePort, WritePortEx, WaitDeviceTimeOut, ReadPort
Description
WritePortEx( intSerialPort, char *OutString, intCR_Terminated, intWaitForDevice, char *outbuff, intappend);
This function sends a string to a serial port, and optionally waits for answer. The port must be opened before calling this function. An interactive equivalent is the _WritePort function.
Parameters
OutString OutString is a buffer that typically includes text characters but sometimes also non text characters (e.g. line feed or carriage return). For these cases it is possible to use a special notation, both decimal and hexadecimal inside this OutString.
| Decimal notation |
|---|
| \ddd, where d is 0-9 |
| Hexadecimal notation |
|---|
| \xhh, where h is 0-9 or A-D or a-f |
| Examples of decimal and hexadecimal notation |
|---|
| LF: \010, \x0d, \x0D |
| CR: \013, \x0a, \x0A |
CR_Terminated If terminated >=0 or <-1, it is appended to the end of the string. If terminated=-1, nothing is appended, only the string is send.
WaitForDevice If wait==1, the system is waiting for answer from the device. If terminated >=0, then the system is waiting for the "terminated" value. If terminated <-1, the system is waiting for the absolute value of the "terminated" parameter. If terminated==-1, the system is waiting for the string of characters terminated by 250 ms gap. If there is no answer from the device after a time-out (1 s by default), it stops and displays an error message.
Return Values
timeout expired - no characters returned (if waiting for answer is performed) | |
characters successfully send (if waiting for answer is not performed) | |
length of answer from the device | |
(-ERR_BADPORTOPENWRITE) - invalid handle (e.g. port is not opened or error during clearing the port) | |
(-ERR_BADPORTWRITE) - error writing to the port (e.g. timeout expired during writing characters) |
Note
This function is typically called, when you invoke the Write to Port command (Macro menu). An interactive equivalent is _WritePort.
See Also
WritePort, WritePortAndWait, WaitDeviceTimeOut, ReadPort