_Stg_ShowZoomConfig, Stg_GetZoomPosition, Stg_GetZoomStepPosition, Stg_GetZoomSteps, Stg_IsZoomManual, Stg_IsZoomPresent, Stg_LoadZoomCorrection, Stg_SetZoomPosition, Stg_ShowZoomConfig

Stg_GetZoomPosition

Description 

 Stg_GetZoomPosition();

Returns the current zoom position of the stage.

Note

The current zoom of the stage is returned. Although the zoom is returned as a real number, not all zoom values might be achieved by the actual hardware. See Stg_GetZoomSteps function for retrieving the amount of zoom steps the actual hardware supports.

See Also 
Stg_SetZoomPosition, Stg_GetZoomSteps

Stg_GetZoomStepPosition

Description 

 Stg_GetZoomStepPosition(
   int  Step
);

This function returns the zoom for a given stage zoom step.

Parameters

int Step

Step to retrieve the zoom for. This parameter must be in range <0,

Return Values

The zoom for the given stage zoom step.

Note

The zoom of the stage cannot be set to an arbitrary value - instead, the stage supports several different zoom steps. This function retrieves the zoom associated with zoom step of a given number. Use it when you want to know precisely which zooms is the stage capable of setting.

See Also 
Stg_GetZoomSteps, Stg_GetZoomPosition

Stg_GetZoomSteps

Description 

 Stg_GetZoomSteps();

Returns the amount of zoom steps supported by the stage.

Note

The stage usually supports only a discrete amount of different zoom values it can be set to. This function retrieves the amount of zoom steps the stage can distinguish.

See Also 
Stg_GetZoomPosition, Stg_GetZoomStepPosition

Stg_IsZoomManual

Description 

 Stg_IsZoomManual();

This function retrieves whether the stage zoom is being controlled manually.

Return Values

0	The stage zoom is controlled by the software.
1	The stage zoom is controlled manually by the user.

Note

When the stage zoom is controlled manually, the software cannot change its value. The users have to do the zooming by themselves.

Stg_IsZoomPresent

Description 

 Stg_IsZoomPresent();

Detects whether the zoom is available or not.

Return Values

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

See Also 
Stg_GetZoomPosition, Stg_SetZoomPosition

Stg_LoadZoomCorrection

Description 

 Stg_LoadZoomCorrection(
   char *Filename
);

Zoom values of the AZ100 microscope can be corrected. This function loads zoom correction from an external .xml file.

Parameters

char *Filename

Full path to the XML file. E.g. “C:\backup\backup1.xml”

Stg_SetZoomPosition

Description 

 Stg_SetZoomPosition(
   double  Zoom
);

This function sets current stage zoom to the given value.

Parameters

double Zoom

Zoom to set the stage to. The stage is set to the closest available zoom it supports.

Note

The stage might not support the precise zoom value, since the zoom of the stage can be set only in discrete steps. In that case, closest zoom available is used. You can retrieve the supported zooms using the Stg_GetZoomStepPosition function.

See Also 
Stg_GetZoomStepPosition, Stg_GetZoomSteps

Stg_ShowZoomConfig

Interactive command to this function: Devices > Zoom Configuration

Description 

 Stg_ShowZoomConfig(
   double  ZoomLow,
   double  ZoomHigh,
   double  ZoomStep,
   int  ShowOnToolBar,
   int  IsInCameraLightPath
);

This function enables you to setup the zoom values. It has meaning to use only if your optical device (for example: microscope or macroscope) has a zoom position changer (for example for zoom 1 and 1.5).

Parameters

double ZoomLow

Lowest zoom factor. This value is usually 1 or less.

double ZoomHigh

Highest zoom factor. This value is usually more then 1.

double ZoomStep

Increment between two zoom factors.

int ShowOnToolBar

Visibility of zoom control on the toolbar.

1	Show combo box on the toolbar enabling you to select the current zoom factor
0	Hide zoom factor combo box

int IsInCameraLightPath

When selected and the zoom is changed, the calibration for the current objective will be automatically recalculated.

1	Enable the calibration recalculation according to the actually selected zoom factor
0	Disable calibration recalculation.

_Stg_ShowZoomConfig

This function runs the Devices > Zoom Configuration command.

Description 

 _Stg_ShowZoomConfig();

Displays a dialog box for the Zoom configuration.