Stg_GetMultiLaserCount Description
Stg_GetMultiLaserCount();
This function retrieves information about the multi-laser count.
Stg_GetMultiLaserLineNDFilter Description
Stg_GetMultiLaserLineNDFilter(
char MultiLaserName,
int LaserLine
);
Returns whether the ND filter is in or out on the specified laser line.
Parameters
char MultiLaserName name of the multilaser line
int LaserLine Index number of the laser line.
Stg_GetMultiLaserLineName Description
Stg_GetMultiLaserLineName(
char *MultiLaserName,
int LaserLine,
char *LaserLineName
);
This function retrieves the name of a multi-laser line.
Parameters
char *MultiLaserName Name of the multi-laser device.
Note
The actual string used in this parameter is displayed within the Device Manager next to the corresponding Multilaser logical device.
int LaserLine Index number of the laser line.
char *LaserLineName Multi laser line name buffer.
Stg_GetMultiLaserLineUsed Description
Stg_GetMultiLaserLineUsed(
char *MultiLaserName,
int LaserLine
);
Returns the actual usage of the desired line for the Multi-laser logical device.
Parameters
char *MultiLaserName Name of the multi-laser device.
Note
The actual string used in this parameter is displayed within the Device Manager next to the corresponding Multilaser logical device.
int LaserLine Index number of the laser line.
Return Values
TRUE if the line is currently in use, otherwise FALSE.
Stg_GetMultiLaserModality Description
int Stg_GetMultiLaserModality(
char *MultiLaserName
);
This function returns modality for the Multi-laser logical device.
Parameters
char *MultiLaserName Name of the multi-laser device.
Note
The actual string used in this parameter is displayed within the Device Manager next to the corresponding Multilaser logical device.
Return Values
int 0 | Any combination of lines active is possible (supported by SFC, LUSU [extended mode]) |
1 | Only one line can be active and cannot be disabled (supported by DG4/5, LUSU [standard mode], Harald Hein laser switcher) |
2 | Only one line can be active and can be disabled. |
Stg_GetMultiLaserName Description
Stg_GetMultiLaserName(
int MultiLaserIndex,
char *MultiLaserName
);
This function retrieves information about the multi-laser.
Parameters
int MultiLaserIndex index of the multilaser
char *MultiLaserName Name of the multi-laser device.
Note
The actual string used in this parameter is displayed within the Device Manager next to the corresponding Multilaser logical device.
Stg_GetMultiLaserNumLines Description
int Stg_GetMultiLaserNumLines(
char *MultiLaserName
);
This function returns the line count for the Multi-laser logical device.
Parameters
char *MultiLaserName Name of the multi-laser device.
Note
The actual string used in this parameter is displayed within the Device Manager next to the corresponding Multilaser logical device.
Return Values
int Line count (0 if the device not present).
Stg_GetMultiLaserOpMode Description
Stg_GetMultiLaserOpMode(
char *MultiLaserName
);
Returns operation mode for the Multi-laser logical device.
Parameters
char *MultiLaserName Name of the multi-laser device.
Note
The actual string used in this parameter is displayed within the Device Manager next to the corresponding Multilaser logical device.
Return Values
0 | Default mode, lines is activated manually |
1 | Alternation mode, lines activation is triggered by external signal (from camera) and is defined by alternation sequence (supported by DG4/5). |
Stg_GetMultiLaserPower Description
Stg_GetMultiLaserPower(
char *MultiLaserName,
int LaserLine
);
Returns the actual power of the desired line for the Multi-laser logical device.
Parameters
char *MultiLaserName Name of the multi-laser device.
Note
The actual string used in this parameter is displayed within the Device Manager next to the corresponding Multilaser logical device.
int LaserLine Index number of the laser line.
Return Values
int - Current power value for desired line or zero.
Stg_GetMultiLaserPowerSteps Description
Stg_GetMultiLaserPowerSteps(
char *MultiLaserName,
int LaserLine
);
Returns the power steps count of the desired line for the Multi-laser logical device.
Parameters
char *MultiLaserName Name of the multi-laser device.
Note
The actual string used in this parameter is displayed within the Device Manager next to the corresponding Multilaser logical device.
int LaserLine Index number of the laser line.
Return Values
int - Power steps count for desired line or zero.
Stg_GetMultiLaserStepPower Description
Stg_GetMultiLaserStepPower(
char *MultiLaserName,
int LaserLine,
dword Step
);
Returns the power value for the specified step index of the desired line for the Multi-laser logical device.
Parameters
char *MultiLaserName Name of the multi-laser device.
Note
The actual string used in this parameter is displayed within the Device Manager next to the corresponding Multilaser logical device.
int LaserLine Index number of the laser line.
dword Step Zero based step index.
Return Values
int - Power value for specified step index count for desired line or zero.
Stg_GetMultiLaserWavelength Description
Stg_GetMultiLaserWavelength(
char *MultiLaserName,
int LaserLine
);
Returns the wavelength of desired line for the Multi-laser logical device.
Parameters
char *MultiLaserName Name of the multi-laser device.
Note
The actual string used in this parameter is displayed within the Device Manager next to the corresponding Multilaser logical device.
int LaserLine Index number of the laser line.
Return Values
int - Wave length value of desired line (in nm) or zero.
Stg_RemoveInterlock Description
Stg_RemoveInterlock();
Laser-equipped microscope systems contain the safety-mechanism which automatically closes shutters upon changing light-path. This prevents users to let the laser(s) shine to the eye-port. The Stg_RemoveInterlock function unblocks the closed shutters (similarly to the Remove Interlock button).
Stg_SetMultiLaserLineAltSeq Description
Stg_SetMultiLaserLineAltSeq(
char *MultiLaserName,
int *pLinesActive,
dword SequenceCount
);
Sets alternation sequence (array of line indexes) for Multi-laser logical device.
Parameters
char *MultiLaserName Name of the multi-laser device.
Note
The actual string used in this parameter is displayed within the Device Manager next to the corresponding Multilaser logical device.
int *pLinesActive Pointer to array that is filled with zero-based line indexes. The array must have appropriate count of elements (maximum number of lines is returned the Stg_GetMultiLaserNumLines function).
dword SequenceCount Count of elements in the array (length of the sequence).
Return Values
int - TRUE if successful otherwise FALSE.
Stg_SetMultiLaserLineNDFilter Description
Stg_SetMultiLaserLineNDFilter(
char MultiLaserName,
int LaserLine,
int LineNDFilter
);
Sets the ND filter position on the specified laser line.
Parameters
char MultiLaserName name of the multilaser line
int LaserLine Index number of the laser line.
int LineNDFilter Position of the ND filter.
Stg_SetMultiLaserLineName Description
Stg_SetMultiLaserLineName(
char MultiLaserName,
int LaserLine,
char LaserLineName
);
This function sets the name of the multi-laser line.
Parameters
char MultiLaserName name of the multilaser line
int LaserLine Index number of the laser line.
char LaserLineName Name of the laser line.
Stg_SetMultiLaserLineUsed Description
Stg_SetMultiLaserLineUsed(
char *MultiLaserName,
int LaserLine,
int LineUsed
);
Sets the usage of the desired line for the Multi-laser logical device.
Parameters
char *MultiLaserName Name of the multi-laser device.
Note
The actual string used in this parameter is displayed within the Device Manager next to the corresponding Multilaser logical device.
int LaserLine Index number of the laser line.
Return Values
int - TRUE if successful otherwise FALSE.
Stg_SetMultiLaserOpMode Description
Stg_SetMultiLaserOpMode(
char *MultiLaserName,
dword OperationMode
);
Sets the operation mode for the Multi-laser logical device.
Parameters
char *MultiLaserName Name of the multi-laser device.
Note
The actual string used in this parameter is displayed within the Device Manager next to the corresponding Multilaser logical device.
dword OperationMode 0 | Default mode, lines are activated manually. |
1 | Alternation mode, lines activation is triggered by external signal (from camera) and is defined by alternation sequence (supported by DG4/5). |
Return Values
int - TRUE if successful otherwise FALSE.
Stg_SetMultiLaserPower Description
Stg_SetMultiLaserPower(
char *MultiLaserName,
int LaserLine,
dword Power
);
Sets the power value of the desired line for the Multi-laser logical device.
Parameters
char *MultiLaserName Name of the multi-laser device.
Note
The actual string used in this parameter is displayed within the Device Manager next to the corresponding Multilaser logical device.
int LaserLine Index number of the laser line.
dword Power Power value for desired line.
Return Values
int - TRUE if successful otherwise FALSE.
Stg_SetMultiLaserWavelength Description
Stg_SetMultiLaserWavelength(
char *MultiLaserName,
int LaserLine,
dword WaveLength
);
Sets the wave length of the desired line for the Multi-laser logical device.
Parameters
char *MultiLaserName Name of the multi-laser device.
Note
The actual string used in this parameter is displayed within the Device Manager next to the corresponding Multilaser logical device.
int LaserLine Index number of the laser line.
dword WaveLength Wave length value of desired line (in nm).
Return Values
int - TRUE if successful otherwise FALSE.
Stg_StartMultiLaserAdvancedAltSeq Description
Stg_StartMultiLaserAdvancedAltSeq(
char *MultiLaserName,
int *pLinesActive,
double *pLinesPower,
int SequenceCount
);
This function starts a sequence of illumination operations.
Parameters
char *MultiLaserName Name of the multi-laser device.
Note
The actual string used in this parameter is displayed within the Device Manager next to the corresponding Multilaser logical device.
int *pLinesActive Pointer to array that is filled with zero-based line indexes. The array must have appropriate count of elements (maximum number of lines is returned the Stg_GetMultiLaserNumLines function).
double *pLinesPower Pointer to array filled with voltage values to be set to the appropriate lines.
int SequenceCount Number of iterations. This parameter at the same time determines the size of the above arrays.
Stg_StartMultiLaserAdvancedAltSeqEx Description
Stg_StartMultiLaserAdvancedAltSeqEx(
char *MultiLaserName,
int *pLinesActive,
int SequenceCount,
int GrabberId
);
This function starts a sequence of illumination operations.
Parameters
char *MultiLaserName Name of the multi-laser device.
Note
The actual string used in this parameter is displayed within the Device Manager next to the corresponding Multilaser logical device.
int *pLinesActive Pointer to array that is filled with zero-based line indexes. The array must have appropriate count of elements (maximum number of lines is returned the Stg_GetMultiLaserNumLines function).
int SequenceCount Number of iterations. This parameter at the same time determines the size of the above arrays.
int GrabberId Set which camera will be used.
0 | The primary camera (grabber) will be used |
1 | The secondary camera (grabber) will be used |
Stg_StopMultiLaserAdvancedAltSeq Description
Stg_StopMultiLaserAdvancedAltSeq(
char *MultiLaserName
);
This function stops the sequence of illumination operations.
Parameters
char *MultiLaserName Name of the multi-laser device.
Note
The actual string used in this parameter is displayed within the Device Manager next to the corresponding Multilaser logical device.
See Also
Stg_StartMultiLaserAdvancedAltSeq
_Stg_CalibrateMultiLaserLine Description
_Stg_CalibrateMultiLaserLine(
char *MultiLaserName,
int LaserLine
);
This function opens a GUI window which enables you to create a calibration curve (map voltage values to laser power values) of the selected laser line.
Parameters
char *MultiLaserName Name of the multi-laser device.
Note
The actual string used in this parameter is displayed within the Device Manager next to the corresponding Multilaser logical device.
int LaserLine Index number of the laser line.