_StgSetupPFSFocus, Stg_GetPFSLEDSwitch, Stg_GetPFSLensOffsetPosition, Stg_GetPFSStatus, Stg_IsPFSPresent, Stg_PFSEnableSignalOutput, Stg_PFSFindOffset, Stg_PFSGetDishType, Stg_PFSGetDishTypeChangeable, Stg_PFSInsertExtractDM, Stg_PFSIsDMInserted, Stg_PFSIsDMMotorized, Stg_PFSIsSignalOutputEnabled, Stg_PFSSetDishType, Stg_PFSSetLEDPower, Stg_PFSSignalOutputTest, Stg_SetPFSFocus, Stg_SetPFSLEDSwitch, Stg_SetPFSLensOffsetPosition, Stg_SetPFSStatus, Stg_WaitForPFS, StgFocusPFS
This function runs the Devices > Auto PFS Focus command.
Description
StgFocusPFS();
Finds the best focused image plane and sets the PFS Offset accordingly.
Description
int Stg_GetPFSLEDSwitch();
Returns the state of the near-infrared 870-nanometer LED inside the Perfect focus system.
Description
Stg_GetPFSLensOffsetPosition();
This function returns the current PFS offset value.
Description
Stg_GetPFSStatus();
This function returns the current status of the PFS device.
Return Values
PFS Error, e.g. PFS is not connected. | |
In range, detects the focused signal, PFS is OFF. | |
Focused, focused position was found, keep the position, PFS is ON. | |
Out of range, Cannot detect the focused signal, PFS is OFF. | |
Out of range, PFS Optics is not set correctly (Dichroic Mirror is out), PFS is OFF. | |
Searching, PFS is ON. | |
Searching stopped, Cannot find the focused position, PFS is ON. | |
Disabled, Objective Lens not supported, PFS is OFF. |
Note
An internal transformation of the original (hardware) return values is done in order to keep the return values independent on the microscope model. This is the conversion table used for Nikon TI microscope:
| Stg_GetPFSStatus | Nikon TI |
|---|---|
| -1 | - |
| 0 | 2 - off - in range |
| 1 | 5 - on - focused |
| 3 | 1- off / out of range |
| 4 | 3 - off - out of range (mirror) |
| 5 | 4 - on - focusing |
| 6 | 6 - on - out of range |
| 7 | 7 - error (objective) |
Description
Stg_IsPFSPresent();
Checks if a logical device of the “PFS” type exists and is currently connected.
Description
Stg_PFSEnableSignalOutput(
int PFSSignalEnable
);This function turns on or off the PFS output signal into the connector on the body of the microscope (piezo).
This function runs the Devices > Find PFS Offset command.
Description
Stg_PFSFindOffset();
This function finds the PFS offset for the current Z coordinate.
Description
Stg_PFSGetDishTypeChangeable();
This function returns whether the PFS enables setting a dish type.
See Also
Stg_PFSSetDishType, Stg_PFSGetDishType
Description
Stg_PFSInsertExtractDM(
int PFSDMInserted
);This function puts the mirror into the optical path.
Description
int Stg_PFSIsDMInserted();
This function returns the position of the mirror in the optical path.
Description
Stg_PFSIsDMMotorized();
Returns whether the Dichroic Mirror on the PFS is motorized or not.
Description
int Stg_PFSIsSignalOutputEnabled();
This function returns a status of the output signal.
Description
Stg_PFSSetDishType(
int PFSDishType
);Defines the material placed in the sample holder over which the focusing by PFS is performed.
Description
Stg_PFSSetLEDPower(
int LEDPower
);This function sets the intensity of the LED illumination.
Description
Stg_PFSSignalOutputTest(
int Test
);This function sets the mode of the PFS test signal output.
Description
Stg_SetPFSFocus();
This function starts the PFS focusing cycle, and waits for getting focused. Maximal focusing interval is 8s.
Description
Stg_SetPFSLEDSwitch(
int Switch
);Turns the near-infrared 870-nanometer LED inside the Perfect focus system ON/OFF
Description
Stg_SetPFSLensOffsetPosition(
int PFSLensOffset
);This function can set the PFS offset.
Description
Stg_SetPFSStatus(
int PFSStatus
);This function can turn the PFS ON/OFF.
Description
Stg_WaitForPFS(
double StgTimeout
);This function waits for specified time interval for PFS to focus.
This function runs the Devices > Auto PFS Focus Setup command.
Description
_StgSetupPFSFocus();
This function opens the Auto PFS Focus Setup.