Microscope

Stg_Bioluminescence_Mode, Stg_CaptureSlidePreview, Stg_CloseMicroscopeDoor, Stg_DisplayLED, Stg_EnableMicControlPad, Stg_GetMicroscopeSleep, Stg_GetPinConfiguredForTTLOutput, Stg_GetPinConfiguredForTTLOutputPulse, Stg_GetPinTTLOutputState, Stg_IsMicroscopePresent, Stg_MicroscopeMuteSound, Stg_MicroscopeOperationSound, Stg_MicroscopeSleep, Stg_OpenMicroscopeDoor, Stg_SetBlockMicroscopeAccessories, Stg_SetPinTTLOutputPulse, Stg_SetPinTTLOutputState, Stg_ShutdownMicroscope, Stg_ToggleMicControlPad, Stg_TriggerInternalCamera

Stg_Bioluminescence_Mode

Description

 Stg_Bioluminescence_Mode(
   int  ModeEnable
);

Turns the bioluminescence mode on/off.

Parameters

int ModeEnable

0	Disabled
1	Enabled

Stg_CaptureSlidePreview

Description

 Stg_CaptureSlidePreview(
   int  MicSlidePreviewFlag
);

This function captures a macro image of the whole slide inserted in the Coolscope microscope and opens the result as a new document. The image can be either high or low-resolution.

Parameters

int MicSlidePreviewFlag

1	Captures a low resolution image.
2	Captures a high resolution image.

Stg_CloseMicroscopeDoor

Description

 Stg_CloseMicroscopeDoor();

This function closes the Coolscope tray.

Stg_DisplayLED

Description

 Stg_DisplayLED(
   int  Switch
);

Turns the Display LED function of the Ti2 microscope main body on/off.

Parameters

int Switch

0	Turn it OFF
1	Turn it ON

Stg_EnableMicControlPad

Description

int Stg_EnableMicControlPad(
   int  EnableMicControlPad
);

This function displays/hides the microscope control pad window.

Parameters

int EnableMicControlPad

Microscope control pad.

0	hides microscope control pad window
1	displays microscope control pad window

Return Values

int

This function returns DR_OK (1)

See Also
Stg_IsMicroscopePresent

Stg_GetMicroscopeSleep

Description

 Stg_GetMicroscopeSleep();

This function returns the state of the microscope in the sleep mode which reduces energy consumption of the device.

Stg_GetPinConfiguredForTTLOutput

Description

 Stg_GetPinConfiguredForTTLOutput(
   int  TTLPin
);

This is a Nikon Ti2 function which returns whether the specified TTL is configured for State.

Parameters

int TTLPin

Zero based index of the pin.

Stg_GetPinConfiguredForTTLOutputPulse

Description

 Stg_GetPinConfiguredForTTLOutputPulse(
   int  TTLPin
);

This is a Nikon Ti2 function which returns whether the TTL is configured for the Pulse.

Parameters

int TTLPin

Zero based index of the pin.

Stg_GetPinTTLOutputState

Description

 Stg_GetPinTTLOutputState(
   int  TTLPin
);

This is a Nikon Ti2 function returning the current State value.

Parameters

int TTLPin

Zero based index of the pin.

Stg_IsMicroscopePresent

Description

 Stg_IsMicroscopePresent();

Detects if the microscope is available.

Return Values

TRUE (1)	Microscope is present
FALSE (0)	Microscope is not present

Stg_MicroscopeMuteSound

Description

 Stg_MicroscopeMuteSound(
   int  Mute
);

This is a Nikon Ti2 function used for turning off the microscope speaker sound.

Parameters

int Mute

Mute sound on/off.

0	Mute off.
1	Mute on.

Stg_MicroscopeOperationSound

Description

 Stg_MicroscopeOperationSound(
   int  OperationSound
);

Sets the Microscope Operation Sounds mode of the Ti2 microscope main body.

Parameters

int OperationSound

Sets the Microscope Operation Sounds mode of the Ti2 microscope main body.

0	Disable All.
1	Enable All.
2	Disable PFS Sounds.

Stg_MicroscopeSleep

Description

 Stg_MicroscopeSleep(
   int  Sleep
);

This function switches the microscope to the sleep mode which reduces energy consumption of the device.

Parameters

int Sleep

Activate sleep mode

Stg_OpenMicroscopeDoor

Description

 Stg_OpenMicroscopeDoor();

This function extracts the Coolscope tray.

Stg_SetBlockMicroscopeAccessories

Description

 Stg_SetBlockMicroscopeAccessories(
   int  Block
);

This function manages how the Nikon Ti2 microscope can be controlled (via a software or hardware accessories).

Parameters

int Block

0	Enable hardware accessories (joystick, z-drive knob) and other software (Ti2 Control).
1	Control from NIS-Elements only, disable hardware accessories and other software.
2	Control via NIS-Elements and hardware accessories, disable other software.

Stg_SetPinTTLOutputPulse

Description

 Stg_SetPinTTLOutputPulse(
   int  TTLPin
);

This is a Nikon Ti2 function setting the Pulse (10 ms/5V).

Parameters

int TTLPin

Zero based index of the pin.

Stg_SetPinTTLOutputState

Description

 Stg_SetPinTTLOutputState(
   int  TTLPin,
   int  TTLState
);

This is a Nikon Ti2 function setting High or Low value to the TTL.

Parameters

int TTLPin

Zero based index of the pin.

int TTLState

TTL state.

0	Low
1	High

Stg_ShutdownMicroscope

Description

int Stg_ShutdownMicroscope();

This function remotely turns the Coolscope microscope OFF.

Return Values

int

The value informs, that the microscope was correctly turned off or not.

0	The microscope was correctly turned off.
-1	The microscope was not correctly turned off.

Stg_ToggleMicControlPad

This function runs the Devices > Microscope Control Pad command.

Description

 Stg_ToggleMicControlPad();

This function displays or hides the microscope control pad window.

Stg_TriggerInternalCamera

Description

 Stg_TriggerInternalCamera();

This function sends trigger to the internal camera of the Nikon Ji microscope. If the camera is in the strobe mode, this function sends a trigger to capture.

Microscope🔗

Microscope