Stg_Filter_GetCount Description
Stg_Filter_GetCount();
This function returns the number of filter changer devices available within the system.
Stg_Filter_GetName Description
Stg_Filter_GetName(
int FilterChangerIndex,
char *FilterChangerName
);
This function retrieves the name of the specified filter changer.
Parameters
int FilterChangerIndex Index number of the filter changer.
char *FilterChangerName Name of the filter changer - the same name which is displayed in the Device Manager.
Stg_Filter_GetPosition Description
Stg_Filter_GetPosition(
char *FilterChangerName
);
This function returns the current position of the specified filter changer.
Parameters
char *FilterChangerName Name of the filter changer - the same name which is displayed in the Device Manager.
Stg_Filter_GetPositionCount Description
Stg_Filter_GetPositionCount(
char *FilterChangerName
);
Returns number of available filter position in the specified filter changer.
Parameters
char *FilterChangerName Name of the filter changer - the same name which is displayed in the Device Manager.
Stg_Filter_GetPositionName Description
Stg_Filter_GetPositionName(
char *FilterChangerName,
int FilterPosition,
char *LpFilterName,
int FilterNameMaxLength
);
Returns a filter position name.
Parameters
char *FilterChangerName Name of the filter changer - the same name which is displayed in the Device Manager.
int FilterPosition Index number of the filter changer position.
char *LpFilterName Name of the filter changer position.
int FilterNameMaxLength Specify the maximum number of characters of the name.
Return Values
DR_OK (1) | Filter name was stored to name buffer |
DR_BADPARAMETER (-2) | Some parameter has invalid value |
DR_NOTAVAILABLE (-4) | Device Filter Changer is not present |
DR_CANCELED (0) | Filter name is longer than length of name buffer |
DR_UNKNOWNERROR (-1) | Retrieving the filter name failed |
See Also
Stg_IsFilterPresent, Stg_GetFilterPositions
Stg_Filter_GetSpeed Description
Stg_Filter_GetSpeed(
char *FilterChangerName
);
This function returns the speed of the specified filter changer.
Parameters
char *FilterChangerName Name of the filter changer - the same name which is displayed in the Device Manager.
Stg_Filter_GetSpeedSteps Description
Stg_Filter_GetSpeedSteps(
char *FilterChangerName
);
This function returns number of available speed steps of a filter changer.
Parameters
char *FilterChangerName Name of the filter changer - the same name which is displayed in the Device Manager.
Stg_Filter_GetStepSpeed Description
Stg_Filter_GetStepSpeed(
char *FilterChangerName,
int FilterSpeedStep
);
This function retrieves the current speed of the specified filter changer. The speed is measured in steps.
Parameters
char *FilterChangerName Name of the filter changer - the same name which is displayed in the Device Manager.
int FilterSpeedStep The current speed step.
Stg_Filter_SetPosition Description
Stg_Filter_SetPosition(
char *FilterChangerName,
int FilterPosition
);
This function moves the specified filter changer to certain position.
Parameters
char *FilterChangerName Name of the filter changer - the same name which is displayed in the Device Manager.
int FilterPosition Filter changer position.
Stg_Filter_SetPositionName Description
Stg_Filter_SetPositionName(
char *FilterChangerName,
int FilterPosition,
char *LpFilterName
);
This function assigns a name to a filter changer position.
Parameters
char *FilterChangerName Name of the filter changer - the same name which is displayed in the Device Manager.
int FilterPosition Index number of the filter changer position.
char *LpFilterName Name of the filter changer position.
Stg_Filter_SetSpeed Description
Stg_Filter_SetSpeed(
char *FilterChangerName,
double Speed
);
This function specifies the speed of a filter changer. The filter changer speed is measured in steps.
Parameters
char *FilterChangerName Name of the filter changer - the same name which is displayed in the Device Manager.
double Speed The speed step index (the higher the faster)
Stg_GetFilterName Description
Stg_GetFilterName(
int type,
int FilterPosition,
char *LpFilterName,
int maxLength
);
Returns the name of the given filter.
Parameters
int type Type of filter changer
FILTER_EPI | EPI filter changer |
FILTER_EMISSION | Emission filter changer |
FILTER_TURRET | Fluorescence blocks filter changer |
FILTER_AUX1 | Auxiliary filter changer |
FILTER_AUX2 | Auxiliary filter changer |
int FilterPosition Index number of the filter changer position.
char *LpFilterName Name of the filter changer position.
int maxLength Name buffer length is the maximal number of characters which can be stored to filter name buffer.
Return Values
DR_OK (1) | Filter name was stored to name buffer |
DR_BADPARAMETER (-2) | Some parameter has invalid value |
DR_NOTAVAILABLE (-4) | Device Filter Changer is not present |
DR_CANCELED (0) | Filter name is longer than length of name buffer |
DR_UNKNOWNERROR (-1) | Retrieving the filter name failed |
See Also
Stg_IsFilterPresent, Stg_GetFilterPositions
Stg_GetFilterPosition Description
Stg_GetFilterPosition(
int type
);
Returns current filter changer position.
Parameters
int type Type of filter changer
FILTER_EPI | EPI filter changer |
FILTER_EMISSION | Emission filter changer |
FILTER_TURRET | Fluorescence blocks filter changer |
FILTER_AUX1 | Auxiliary filter changer |
FILTER_AUX2 | Auxiliary filter changer |
Return Values
Value >= 0 | Current filter changer position |
DR_BADPARAMETER (-2) | Some parameter has invalid value |
DR_NOTAVAILABLE (-4) | Device Filter Changer is not present |
DR_UNKNOWNERROR (-1) | Retrieving the current filter changer position failed |
See Also
Stg_IsFilterPresent
Stg_GetFilterPositions Description
Stg_GetFilterPositions(
int type
);
Returns the number of available filter changer positions.
Parameters
int type Type of filter changer
FILTER_EPI | EPI filter changer |
FILTER_EMISSION | Emission filter changer |
FILTER_TURRET | Fluorescence blocks filter changer |
FILTER_AUX1 | Auxiliary filter changer |
FILTER_AUX2 | Auxiliary filter changer |
Return Values
Value > 0 | Number of filter changer positions |
DR_BADPARAMETER (-2) | Some parameter has invalid value |
DR_NOTAVAILABLE (-4) | Device Filter Changer is not present |
DR_UNKNOWNERROR (-1) | Retrieving the number of available filter changer positions failed |
See Also
Stg_IsFilterPresent
Stg_GetFilterSpeed Description
Stg_GetFilterSpeed(
int type
);
Returns current filter changer speed [positions/s]. This command should only be called if Stg_GetFilterSpeedSteps returns value > 0.
Parameters
int type Type of filter changer
FILTER_EPI | EPI filter changer |
FILTER_EMISSION | Emission filter changer |
FILTER_TURRET | Fluorescence blocks filter changer |
FILTER_AUX1 | Auxiliary filter changer |
FILTER_AUX2 | Auxiliary filter changer |
Return Values
Value > 0.0 | Filter changer speed [positions/s] |
DR_BADPARAMETER (-2) | Some parameter has invalid value |
DR_NOTAVAILABLE (-4) | Device Filter Changer is not present |
DR_NOTSUPPORTED (-3) | Filter changer speed is not controllable |
DR_UNKNOWNERROR (-1) | Retrieving the filter changer speed failed |
See Also
Stg_IsFilterPresent, Stg_GetFilterSpeedSteps
Stg_GetFilterSpeedSteps Description
Stg_GetFilterSpeedSteps(
int type
);
Returns the number of available filter changer speed steps.
Parameters
int type Type of filter changer
FILTER_EPI | EPI filter changer |
FILTER_EMISSION | Emission filter changer |
FILTER_TURRET | Fluorescence blocks filter changer |
FILTER_AUX1 | Auxiliary filter changer |
FILTER_AUX2 | Auxiliary filter changer |
Return Values
Value > 0 | Number of filter changer speed steps |
DR_BADPARAMETER (-2) | Some parameter has invalid value |
DR_NOTAVAILABLE (-4) | Device Filter Changer is not present |
DR_NOTSUPPORTED (-3) | Filter changer speed is not controllable |
DR_UNKNOWNERROR (-1) | Retrieving the number of filter changer speed steps failed |
See Also
Stg_IsFilterPresent, Stg_GetFilterStepSpeed, Stg_SetFilterSpeed, Stg_GetFilterSpeed
Stg_GetFilterStepSpeed Description
Stg_GetFilterStepSpeed(
int type,
int step
);
Returns filter changer speed [positions/s] for a given filter changer speed step. This command should only be called if Stg_GetFilterSpeedSteps returns value > 0.
Parameters
int type Type of filter changer
FILTER_EPI | EPI filter changer |
FILTER_EMISSION | Emission filter changer |
FILTER_TURRET | Fluorescence blocks filter changer |
FILTER_AUX1 | Auxiliary filter changer |
FILTER_AUX2 | Auxiliary filter changer |
int step The filter changer speed step is number between 0 and steps-1, where steps is the number of filter changer speed steps returned by
Return Values
Value > 0.0 | Filter changer step speed [positions/s] |
DR_BADPARAMETER (-2) | Some parameter has invalid value |
DR_NOTAVAILABLE (-4) | Device Filter Changer is not present |
DR_NOTSUPPORTED (-3) | Filter changer speed is not controllable |
DR_UNKNOWNERROR (-1) | Retrieving the filter changer step speed failed |
See Also
Stg_IsFilterPresent, Stg_GetFilterSpeedSteps
Stg_IsFilterPresent Description
Stg_IsFilterPresent(
int type
);
Detects if the filter changer of the specified type is available.
Parameters
int type Type of filter changer
FILTER_EPI | EPI filter changer |
FILTER_EMISSION | Emission filter changer |
FILTER_TURRET | Fluorescence blocks filter changer |
FILTER_AUX1 | Auxiliary filter changer |
FILTER_AUX2 | Auxiliary filter changer |
Return Values
TRUE (1) | Filter changer is present |
FALSE (0) | Filter changer is not present |
DR_BADPARAMETER (-2) | Some parameter has invalid value |
See Also
Stg_GetFilterPositions, Stg_SetFilterPosition, Stg_GetFilterPosition, Stg_GetFilterSpeedSteps, Stg_SetFilterName, Stg_GetFilterName
Stg_SetFilterName Description
Stg_SetFilterName(
int type,
int FilterPosition,
char *Name
);
Sets the name of the given filter.
Parameters
int type Type of filter changer
FILTER_EPI | EPI filter changer |
FILTER_EMISSION | Emission filter changer |
FILTER_TURRET | Fluorescence blocks filter changer |
FILTER_AUX1 | Auxiliary filter changer |
FILTER_AUX2 | Auxiliary filter changer |
int FilterPosition Index number of the filter changer position.
Return Values
DR_OK (1) | Filter name was set |
DR_BADPARAMETER (-2) | Some parameter has invalid value |
DR_NOTAVAILABLE (-4) | Device Filter Changer is not present |
DR_UNKNOWNERROR (-1) | Setting the filter name failed |
See Also
Stg_IsFilterPresent, Stg_GetFilterPositions
Stg_SetFilterPosition Description
Stg_SetFilterPosition(
int type,
int FilterPosition
);
Sets the current filter changer position.
Parameters
int type Type of filter changer
FILTER_EPI | EPI filter changer |
FILTER_EMISSION | Emission filter changer |
FILTER_TURRET | Fluorescence blocks filter changer |
FILTER_AUX1 | Auxiliary filter changer |
FILTER_AUX2 | Auxiliary filter changer |
int FilterPosition Index number of the filter changer position.
Return Values
DR_OK (1) | Filter position was set |
DR_BADPARAMETER (-2) | Some parameter has invalid value |
DR_NOTAVAILABLE (-4) | Device Filter Changer is not present |
DR_UNKNOWNERROR (-1) | Setting filter position failed |
See Also
Stg_IsFilterPresent, Stg_GetFilterPositions
Stg_SetFilterSpeed Description
Stg_SetFilterSpeed(
int type,
double speed
);
Sets the filter changer speed [positions/s]. If the speed is not valid, the closest valid speed will be chosen. This command should only be called if Stg_GetFilterSpeedSteps returns value > 0.
Parameters
int type Type of filter changer
FILTER_EPI | EPI filter changer |
FILTER_EMISSION | Emission filter changer |
FILTER_TURRET | Fluorescence blocks filter changer |
FILTER_AUX1 | Auxiliary filter changer |
FILTER_AUX2 | Auxiliary filter changer |
double speed The filter changer speed [positions/s] should be number returned by
Return Values
DR_OK (1) | Filter changer speed was successfully set |
DR_BADPARAMETER (-2) | Some parameter has invalid value |
DR_NOTAVAILABLE (-4) | Device Filter Changer is not present |
DR_NOTSUPPORTED (-3) | Filter changer speed is not controllable |
DR_UNKNOWNERROR (-1) | Setting filter changer speed failed |
See Also
Stg_IsFilterPresent, Stg_GetFilterSpeedSteps, Stg_GetFilterStepSpeed