Stg_GetLightIrisIntensity, Stg_GetLightIrisIntensitySteps, Stg_GetLightIrisSteps, Stg_GetLightState, Stg_GetLightStepVoltage, Stg_GetLightVoltage, Stg_GetLightVoltageSteps, Stg_IsLightPresent, Stg_Light_GetCount, Stg_Light_GetIrisIntensity, Stg_Light_GetIrisSteps, Stg_Light_GetName, Stg_Light_GetNDFilterControllable, Stg_Light_GetNDFilterPosition, Stg_Light_GetNDFilterStepPosition, Stg_Light_GetNDFilterSteps, Stg_Light_GetRemoteSwitch, Stg_Light_GetState, Stg_Light_GetStepIrisIntensity, Stg_Light_GetStepVoltage, Stg_Light_GetVoltage, Stg_Light_GetVoltageSteps, Stg_Light_IsIrisControllable, Stg_Light_IsVoltageControllable, Stg_Light_SetIrisIntensity, Stg_Light_SetNDFilterPosition, Stg_Light_SetRemoteSwitch, Stg_Light_SetState, Stg_Light_SetVoltage, Stg_SetLightIrisIntensity, Stg_SetLightState, Stg_SetLightVoltage

Stg_GetLightIrisIntensity

Description 

 Stg_GetLightIrisIntensity(
   int  type
);

Returns current light Iris intensity.

Parameters

int type

Type of light

LIGHT_UNKNOWN	Light of undefined type
LIGHT_EPI	EPI light
LIGHT_EPIF	EPI Fluorescence light
LIGHT_DIA	DIA light

Return Values

Value > 0.0	Current light Iris intensity
0.0	Retrieving the current light Iris intensity failed

See Also 
Stg_IsLightPresent

Stg_GetLightIrisIntensitySteps

Description 

 Stg_GetLightIrisIntensitySteps(
   int  type,
   int  step
);

Returns light Iris intensity for a given step. This command should only be called if Stg_GetLightIrisSteps returns value > 0.

Parameters

int type

Type of light

LIGHT_UNKNOWN	Light of undefined type
LIGHT_EPI	EPI light
LIGHT_EPIF	EPI Fluorescence light
LIGHT_DIA	DIA light

int step

The light Iris step is number between 0 and steps-1, where steps is the number of light Iris steps returned by

Return Values

Value > 0.0	Current light Iris intensity
0.0	Retrieving the current light Iris intensity failed

See Also 
Stg_IsLightPresent

Stg_GetLightIrisSteps

Description 

 Stg_GetLightIrisSteps(
   int  type
);

Returns the number of available positions (steps) for light Iris.

Parameters

int type

Type of light

LIGHT_UNKNOWN	Light of undefined type
LIGHT_EPI	EPI light
LIGHT_EPIF	EPI Fluorescence light
LIGHT_DIA	DIA light

Return Values

Value > 0	Light Iris steps
0	Retrieving the light Iris steps failed

See Also 
Stg_IsLightPresent

Stg_GetLightState

Description 

int Stg_GetLightState(
   int  type
);

Returns current light state (on/off).

Parameters

int type

Type of light.

0, LIGHT_UNKNOWN	Light of an undefined type
1, LIGHT_EPI	EPI light
1, LIGHT_EPI	EPI Fluorescence light
3, LIGHT_DIA	DIA light

Return Values

int

1, TRUE	Light is On
0, FALSE	Light is Off
-2, DR_BADPARAMETER	Some parameter has an invalid value
-4, DR_NOTAVAILABLE	Device Light is not present
-3, DR_NOTSUPPORTED	Light state control is not supported
-1, DR_UNKNOWNERROR	Switching light to specified state failed

See Also 
Stg_IsLightPresent

Stg_GetLightStepVoltage

Description 

 Stg_GetLightStepVoltage(
   int  type,
   int  step
);

Returns voltage setting for a given step.

Parameters

int type

Type of light

LIGHT_UNKNOWN	Light of undefined type
LIGHT_EPI	EPI light
LIGHT_EPIF	EPI Fluorescence light
LIGHT_DIA	DIA light

int step

The light voltage step is number between 0 and steps-1, where steps is the number of light voltage steps returned by

Return Values

Value > 0.0	Light step voltage [V]
DR_BADPARAMETER (-2)	Some parameter has invalid value
DR_NOTAVAILABLE (-4)	Device Light is not present
DR_UNKNOWNERROR (-1)	Retrieving the light step voltage failed

See Also 
Stg_IsLightPresent, Stg_GetLightVoltageSteps

Stg_GetLightVoltage

Description 

 Stg_GetLightVoltage(
   int  type
);

Returns current light voltage [V].

Parameters

int type

Type of light

LIGHT_UNKNOWN	Light of undefined type
LIGHT_EPI	EPI light
LIGHT_EPIF	EPI Fluorescence light
LIGHT_DIA	DIA light

Return Values

Value > 0.0	Current light voltage [V]
DR_BADPARAMETER (-2)	Some parameter has invalid value
DR_NOTAVAILABLE (-4)	Device Light is not present
DR_UNKNOWNERROR (-1)	Retrieving the current light voltage failed

See Also 
Stg_IsLightPresent

Stg_GetLightVoltageSteps

Description 

 Stg_GetLightVoltageSteps(
   int  type
);

Returns the number of available voltage steps.

Parameters

int type

Type of light

LIGHT_UNKNOWN	Light of undefined type
LIGHT_EPI	EPI light
LIGHT_EPIF	EPI Fluorescence light
LIGHT_DIA	DIA light

Return Values

Value > 0	Number of voltage steps
DR_BADPARAMETER (-2)	Some parameter has invalid value
DR_NOTAVAILABLE (-4)	Device Light is not present
DR_UNKNOWNERROR (-1)	Retrieving the number of voltage steps failed

See Also 
Stg_IsLightPresent

Stg_IsLightPresent

Description 

 Stg_IsLightPresent(
   int  type
);

Detects if the light of specified type is available.

Parameters

int type

Type of light

LIGHT_UNKNOWN	Light of undefined type
LIGHT_EPI	EPI light
LIGHT_EPIF	EPI Fluorescence light
LIGHT_DIA	DIA light

Return Values

TRUE (1)	Light is present
FALSE (0)	Light is not present
DR_BADPARAMETER (-2)	Some parameter has invalid value

See Also 
Stg_GetLightVoltageSteps, Stg_GetLightStepVoltage, Stg_SetLightVoltage, Stg_GetLightVoltage, Stg_SetLightState, Stg_GetLightState

Stg_Light_GetCount

Description 

 Stg_Light_GetCount();

Returns the number of lightings.

Stg_Light_GetIrisIntensity

Description 

 Stg_Light_GetIrisIntensity(
   char *name
);

Returns current light Iris intensity.

Parameters

char *name

Name of the light. Get the name by the Stg_Light_GetName function.

Return Values

Value > 0.0	Current light Iris intensity
0.0	Retrieving the current light Iris intensity failed

See Also 
Stg_IsLightPresent

Stg_Light_GetIrisSteps

Description 

 Stg_Light_GetIrisSteps(
   char *name
);

Returns the number of available positions (steps) for light Iris.

Parameters

char *name

Name of the light. Get the name by the Stg_Light_GetName function.

Return Values

Value > 0	Light Iris steps
0	Retrieving the light Iris steps failed

See Also 
Stg_IsLightPresent

Stg_Light_GetNDFilterControllable

Description 

 Stg_Light_GetNDFilterControllable(
   char *name
);

This function returns state of ND filter controllability.

Parameters

char *name

Name of the light. Get the name by the Stg_Light_GetName function.

Stg_Light_GetNDFilterPosition

Description 

 Stg_Light_GetNDFilterPosition(
   char *name
);

This function returns the current ND filter intensity

Parameters

char *name

Name of the light. Get the name by the Stg_Light_GetName function.

Stg_Light_GetNDFilterStepPosition

Description 

 Stg_Light_GetNDFilterStepPosition(
   char *name,
   int  step
);

This function returns the actual ND filter intensity of the actual step.

Parameters

char *name

Name of the light. Get the name by the Stg_Light_GetName function.

int step

The number of the step for which the filter intensity will be traced.

Stg_Light_GetNDFilterSteps

Description 

 Stg_Light_GetNDFilterSteps(
   char *name
);

Returns a number of available ND filter steps.

Parameters

char *name

Name of the light. Get the name by the Stg_Light_GetName function.

Stg_Light_GetName

Description 

 Stg_Light_GetName(
   int  LightIndex,
   char *name
);

Returns the name of the given light.

Parameters

int LightIndex

Index of the light.

char *name

Name of the light. Get the name by the Stg_Light_GetName function.

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_Light_GetRemoteSwitch

Description 

int Stg_Light_GetRemoteSwitch(
   char *LightName
);

This function returns the state of the specified light remote controller.

Parameters

char *LightName

The name of the light which can be found within the Device Manager.

Return Values

int

Can be the light controlled via PC?

0	Hardware remote controller.
1	PC

Stg_Light_GetState

Description 

int Stg_Light_GetState(
   char *name
);

Returns current light state (on/off).

Parameters

char *name

Name of the light. Get the name by the Stg_Light_GetName function.

Return Values

int

1, TRUE	Light is On
0, FALSE	Light is Off
-2, DR_BADPARAMETER	Some parameter has an invalid value
-4, DR_NOTAVAILABLE	Device Light is not present
-3, DR_NOTSUPPORTED	Light state control is not supported
-1, DR_UNKNOWNERROR	Switching light to specified state failed

See Also 
Stg_IsLightPresent

Stg_Light_GetStepIrisIntensity

Description 

 Stg_Light_GetStepIrisIntensity(
   char *name,
   int  step
);

Returns light Iris intensity for a given step. This command should only be called if Stg_GetLightIrisSteps returns value > 0.

Parameters

char *name

Name of the light. Get the name by the Stg_Light_GetName function.

int step

The light Iris step is number between 0 and steps-1, where steps is the number of light Iris steps returned by

Return Values

Value > 0.0	Current light Iris intensity
0.0	Retrieving the current light Iris intensity failed

See Also 
Stg_IsLightPresent

Stg_Light_GetStepVoltage

Description 

 Stg_Light_GetStepVoltage(
   char *name,
   int  step
);

Returns voltage setting for a given step.

Parameters

char *name

Name of the light. Get the name by the Stg_Light_GetName function.

int step

The light voltage step is number between 0 and steps-1, where steps is the number of light voltage steps returned by

Return Values

Value > 0.0	Light step voltage [V]
DR_BADPARAMETER (-2)	Some parameter has invalid value
DR_NOTAVAILABLE (-4)	Device Light is not present
DR_UNKNOWNERROR (-1)	Retrieving the light step voltage failed

See Also 
Stg_Light_GetVoltageSteps

Stg_Light_GetVoltage

Description 

 Stg_Light_GetVoltage(
   char *name
);

Returns the current light voltage [V].

Parameters

char *name

Name of the light. Get the name by the Stg_Light_GetName function.

Return Values

Value > 0.0	Current light voltage [V]
DR_BADPARAMETER (-2)	Some parameter has invalid value
DR_NOTAVAILABLE (-4)	Device Light is not present
DR_UNKNOWNERROR (-1)	Retrieving the current light voltage failed

Stg_Light_GetVoltageSteps

Description 

 Stg_Light_GetVoltageSteps(
   char *name
);

Returns the number of available voltage steps.

Parameters

char *name

Name of the light. Get the name by the Stg_Light_GetName function.

Return Values

Value > 0	Number of voltage steps
DR_BADPARAMETER (-2)	Some parameter has invalid value
DR_NOTAVAILABLE (-4)	Device Light is not present
DR_UNKNOWNERROR (-1)	Retrieving the number of voltage steps failed

Stg_Light_IsIrisControllable

Description 

 Stg_Light_IsIrisControllable(
   char *name
);

Detects if the iris can be controlled.

Parameters

char *name

Name of the light. Get the name by the Stg_Light_GetName function.

Return Values

TRUE (1)	Iris is controllable
FALSE (0)	Iris is not controllable
DR_NOTAVAILABLE (-4)	Iris is not connected

Stg_Light_IsVoltageControllable

Description 

 Stg_Light_IsVoltageControllable(
   char *name
);

Detects if the voltage of lighting can be controlled.

Parameters

char *name

Name of the light. Get the name by the Stg_Light_GetName function.

Return Values

TRUE (1)	Voltage is controllable
FALSE (0)	Voltage is not controllable
DR_NOTAVAILABLE (-4)	Voltage controller is not connected

Stg_Light_SetIrisIntensity

Description 

 Stg_Light_SetIrisIntensity(
   char *name,
   double  density
);

Sets the light Iris intensity.

Parameters

char *name

Name of the light. Get the name by the Stg_Light_GetName function.

double density

The value of light Iris density to be set. The value must be available within the range of ND filter values.

Return Values

TRUE (1)	Density was successfully set.
FALSE (0)	Density was not set.

See Also 
Stg_Light_GetIrisIntensity

Stg_Light_SetNDFilterPosition

Description 

 Stg_Light_SetNDFilterPosition(
   char *name,
   double  density
);

This function changes the density of the current ND filter.

Parameters

char *name

Name of the light. Get the name by the Stg_Light_GetName function.

double density

The value of light Iris density to be set. The value must be available within the range of ND filter values.

Stg_Light_SetRemoteSwitch

Description 

 Stg_Light_SetRemoteSwitch(
   char *LightName,
   int  LightRemoteSwitch
);

If supported (e.g. on Ti or LV microscopes), this function switches a light control between a remote controller (Remote Controller / PC) and the microscope body.

Parameters

char *LightName

The name of the light which can be found within the Device Manager.

int LightRemoteSwitch

Delegate control to:

0	Microscope body
1	Remote controller and PC

Stg_Light_SetState

Description 

 Stg_Light_SetState(
   char *name,
   int  state
);

Sets the current light state (on/off).

Parameters

char *name

Name of the light. Get the name by the Stg_Light_GetName function.

int state

State of light (on/off)

LIGHT_ON	Light On
LIGHT_OFF	Light Off

Return Values

DR_OK (1)	Light was switched to specified state
DR_BADPARAMETER (-2)	Some parameter has invalid value
DR_NOTAVAILABLE (-4)	Device Light is not present
DR_NOTSUPPORTED (-3)	Light state control is not supported
DR_UNKNOWNERROR (-1)	Switching light to specified state failed

See Also 
Stg_IsLightPresent

Stg_Light_SetVoltage

Description 

 Stg_Light_SetVoltage(
   char *name,
   double  Voltage
);

Sets the current light voltage [V]. If the voltage is not valid, the closest valid voltage will be chosen.

Parameters

char *name

Name of the light. Get the name by the Stg_Light_GetName function.

double Voltage

Voltage value.

Return Values

DR_OK (1)	Light voltage was set
DR_BADPARAMETER (-2)	Some parameter has invalid value
DR_NOTAVAILABLE (-4)	Device Light is not present
DR_UNKNOWNERROR (-1)	Setting light voltage failed

See Also 
Stg_Light_GetVoltage

Stg_SetLightIrisIntensity

Description 

 Stg_SetLightIrisIntensity(
   int  type,
   double  intensity
);

Sets the light Iris intensity.

Parameters

int type

Type of light

LIGHT_UNKNOWN	Light of undefined type
LIGHT_EPI	EPI light
LIGHT_EPIF	EPI Fluorescence light
LIGHT_DIA	DIA light

double intensity

The value of light Iris intensity to be set.

Return Values

TRUE (1)	Intensity was successfully set.
FALSE (0)	Intensity was not set.

See Also 
Stg_IsLightPresent, Stg_GetLightIrisIntensity

Stg_SetLightState

Description 

 Stg_SetLightState(
   int  type,
   int  state
);

Sets the current light state (on/off).

Parameters

int type

Type of light

LIGHT_UNKNOWN	Light of undefined type
LIGHT_EPI	EPI light
LIGHT_EPIF	EPI Fluorescence light
LIGHT_DIA	DIA light

int state

State of light (on/off)

LIGHT_ON	Light On
LIGHT_OFF	Light Off

Return Values

DR_OK (1)	Light was switched to specified state
DR_BADPARAMETER (-2)	Some parameter has invalid value
DR_NOTAVAILABLE (-4)	Device Light is not present
DR_NOTSUPPORTED (-3)	Light state control is not supported
DR_UNKNOWNERROR (-1)	Switching light to specified state failed

See Also 
Stg_IsLightPresent

Stg_SetLightVoltage

Description 

 Stg_SetLightVoltage(
   int  type,
   double  Voltage
);

Sets the current light voltage [V]. If the voltage is not valid, the closest valid voltage will be chosen.

Parameters

int type

Type of light

LIGHT_UNKNOWN	Light of undefined type
LIGHT_EPI	EPI light
LIGHT_EPIF	EPI Fluorescence light
LIGHT_DIA	DIA light

double Voltage

Voltage value.

Return Values

DR_OK (1)	Light voltage was set
DR_BADPARAMETER (-2)	Some parameter has invalid value
DR_NOTAVAILABLE (-4)	Device Light is not present
DR_UNKNOWNERROR (-1)	Setting light voltage failed

See Also 
Stg_IsLightPresent, Stg_GetLightStepVoltage