_BackupObjectives, _CalibrateObjective, _CalibrateObjective2, _CalibrateObjective3, _ExploreObjectives, _ObjectiveClearance, _ObjectivesXYOffset, _QuickCalibration, _RestoreObjectives, AddObjective, AddObjectiveEx, ApplyObjectivesXYOffset, BackupObjectives, ChangeObjective, DeleteObjective, DeleteObjectives, GetCurrentObjMagnification, GetCurrentObjName, GetObjMagnification, GetObjType, RestoreObjectives, RestoreObjectivesEx

_ObjectiveClearance

This function runs the Devices > Objective Clearance menu command.

Description 

 _ObjectiveClearance();

This function displays the Objective Clearance dialog. It allows a user to enable/disable objective clearance before stage initialization or exchanging the objective.

_ObjectivesXYOffset

This function runs the Devices > Objectives XY Offset Setup menu command.

Description 

 _ObjectivesXYOffset();

This function opens the Objective XY Offset dialog where it is possible to define XY offsets between objectives.

AddObjective

Description 

 AddObjective(
   char  Objective,
   double  Cal,
   double  Aspect,
   int  Unit
);

This function creates and adds objective and calibration to the system.

Parameters

char Objective

Name of the objective (calibration) to be added to the application system objectives (calibrations).

double Cal

Calibration = size of a pixel = number of Units per pixel.

double Aspect

Aspect ratio of the camera.

int Unit

Calibration units.

0	Pixels
1	Nanometers
2	Micrometers
3	Millimeters
4	Centimeters
5	Decimeters
6	Meters
7	Kilometers
8	Mils
9	Inches

See Also 
_CalibrateObjective, ChangeObjective, DeleteObjective

ApplyObjectivesXYOffset

Interactive menu command to this function: Devices > Apply Objectives XY Offset

Description 

 ApplyObjectivesXYOffset(
   int  NosepiecePos1,
   int  NosepiecePos2
);

Applies the XY Offset between two selected objectives.

Parameters

int NosepiecePos1

Zero-based index of the nosepiece position of the first objective used for defining the XY offset.

int NosepiecePos2

Zero-based index of the nosepiece position of the second objective used for defining the XY offset.

AddObjectiveEx

Description 

 AddObjectiveEx(
   char  Objective,
   double  Cal,
   double  Aspect,
   int  Unit,
   int  LiveObj,
   double  GraticuleDensity
);

This function creates and adds objective and calibration to the system.

Parameters

char Objective

Name of the objective (calibration) to be added to the application system objectives (calibrations).

double Cal

Calibration = size of a pixel = number of Units per pixel.

double Aspect

Aspect ratio of the camera.

int Unit

Calibration units.

0	Pixels
1	Nanometers
2	Micrometers
3	Millimeters
4	Centimeters
5	Decimeters
6	Meters
7	Kilometers
8	Mils
9	Inches

int LiveObj

Parameter being ignored.

double GraticuleDensity

Parameter being ignored.

See Also 
_CalibrateObjective, ChangeObjective, DeleteObjective

BackupObjectives

Description 

 BackupObjectives(
   char *Filename
);

This function saves settings of all currently defined objectives to an XML file.

Parameters

char *Filename

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

ChangeObjective

Description 

 ChangeObjective(
   char *Objective
);

This function changes the current objective and calibration.

Parameters

char *Objective

Name of the objective.

See Also 
_CalibrateObjective, AddObjective, DeleteObjectives

DeleteObjective

Description 

 DeleteObjective(
   char *Objective
);

This function deletes the objective (calibration) and removes the objective name from the set of calibrations.

Parameters

char *Objective

Name of the objective.

See Also 
AddObjective

DeleteObjectives

Description 

 DeleteObjectives();

This function erases all calibrations.

See Also 
AddObjective, ChangeObjective

GetCurrentObjMagnification

Description 

double GetCurrentObjMagnification();

This function returns the magnification of the selected objective.

Return Values

double

Returns magnification of the selected objective.

GetCurrentObjName

Description 

 GetCurrentObjName(
   char *Objective
);

Returns the pointer to the name of the selected objective.

Parameters

char *Objective

Name of the objective.

char OName[255];
GetCurrentObjName(&OName);

GetObjMagnification

Description 

 GetObjMagnification(
   char *Objective
);

Returns magnification of the selected objective.

Parameters

char *Objective

Name of the objective.

GetObjType

Description 

 GetObjType(
   char *Objective
);

Returns type of the selected objective.

Parameters

char *Objective

Name of the objective.

RestoreObjectives

Description 

 RestoreObjectives(
   char *Filename
);

This function loads settings of objectives from an XML file.

Parameters

char *Filename

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

RestoreObjectivesEx

Description 

 RestoreObjectivesEx(
   char *Filename,
   int  Options
);

This function loads settings of objectives from an XML file.

Parameters

char *Filename

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

int Options

This parameter specifies how to deal with items which already exist in the software.

0	Opens a dialog window and asks the user what to do.
1	Imports all items from the file. If an item already exists in the software it will be overwritten.
2	Imports only items which do not already exist in the application.
3	Imports all items from the file. If an item already exists in the software, an index number will be appended to its name.
4	Deletes all items in the software and imports all items from the file.

_BackupObjectives

Description 

 _BackupObjectives();

This function displays a dialog window for exporting objectives. Settings of all currently defined objectives can be saved to an XML file.

See Also 
_BackupOptConf, _BackupLayouts

_CalibrateObjective

This function runs the Calibration > Recalibrate Objective menu command.

Description 

 _CalibrateObjective();

Calibrates the current objective. The function displays the Manual Calibration dialog box.

See Also 
_CalibrateEx

_CalibrateObjective2

Description 

 _CalibrateObjective2(
   int  GrabberId
);

In the Multi-Camera mode where two cameras are connected, this function starts objective calibration using the specified camera (grabber) regardless of which camera is currently set as active. The function displays the Manual Calibration dialog box.

Parameters

int GrabberId

Set which camera will be used.

0	The primary camera (grabber) will be used
1	The secondary camera (grabber) will be used

See Also 
_CalibrateObjective

_CalibrateObjective3

Description 

 _CalibrateObjective3(
   int  GrabberId,
   int  AutocalibMode
);

Runs calibration of the current objective. The calibration method can be pre-selected by the AutocalibMode parameter.

Parameters

int GrabberId

Set which camera will be used.

0	The primary camera (grabber) will be used
1	The secondary camera (grabber) will be used

int AutocalibMode

Select calibration mode

0	Manual calibration - the calibration dialog appears.
1	Automatic calibration using XY stage - the calibration starts right away.

_ExploreObjectives

This function runs the Calibration > Objectives menu command.

Description 

 _ExploreObjectives();

This function displays the Objectives dialog window.

_QuickCalibration

Description 

 _QuickCalibration();

This function creates fast calibration. The function creates a new optical configuration and objective with the same name. The function displays the Quick calibration dialog box.

See Also 
_CalibrateObjective, _CalibrateEx, _ExploreOptConf

_RestoreObjectives

Description 

 _RestoreObjectives();

This function displays a dialog window which enables you to select an XML file containing the objectives settings. Such *.XML file could have been created using the Backup option of the optical configurations dialog window.