_CalibrateEx, _CalibrateExObjLine, _Uncalibrate, CalibrateDocument, Get_CalibrationAngleMatrix, Get_CurrentCalibration, Get_ImageCalibration, GetCalibrationViewUnit, SaveImageCalibration, SetCalibrationViewPrecision, SetCalibrationViewUnit, Uncalibrate

CalibrateDocument

This function runs the Calibrate Using Objective command.

Description 

 CalibrateDocument(
   double  Cal
);

This function sets calibration to the current document in micrometers/pixel. Micrometers are expected as Units.

Parameters

double Cal

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

See Also 
_CalibrateEx, Uncalibrate

GetCalibrationViewUnit

Description 

 GetCalibrationViewUnit(
   char *CalibrationViewUnit
);

This function gets name of currently selected unit used for calibration.

Parameters

char *CalibrationViewUnit

Name of the calibration unit.

px	Pixels
km	Kilometers
m	Meters
dm	Decimeters
cm	Centimeters
mm	Millimeters
um	Micrometers
nm	Nanometers
inch	Inches
mil	Mils

Get_CalibrationAngleMatrix

Description 

 Get_CalibrationAngleMatrix(
   int  ActiveCamera,
   double *A11,
   double *A12,
   double *A21,
   double *A22
);

This function gets camera to stage transformation matrix (rotation and flip) obtained by automatic calibration with stage. New coordinates of the stage are calculated from the original coordinates using these formulas: x' = x * A11 + y * A12 and y' = x * A21 + y * A22.

Parameters

int ActiveCamera

In case of a dual camera system, select the camera for which to retrieve the calibration.

0	The primary camera.
1	The secondary camera.

double *A11

entry of the transformation rotation matrix

double *A12

entry of the transformation rotation matrix

double *A21

entry of the transformation rotation matrix

double *A22

entry of the transformation rotation matrix

Get_CurrentCalibration

Description 

double Get_CurrentCalibration(
   int  FQMode,
   int  ActiveCamera,
   char *LpObjectiveName,
   double *lpcal,
   double *LpAspect,
   int *lpunit
);

This function retrieves information about the current calibration (objectivename, calibration, aspect and unit).

Parameters

int FQMode

Calibration of what camera mode shall be retrieved?

0	The currently active mode.
1	Fast camera mode
2	Quality camera mode

int ActiveCamera

In case of a dual camera system, select the camera for which to retrieve the calibration.

0	The primary camera.
1	The secondary camera.

char *LpObjectiveName

Objective name to be filled.

double *lpcal

Size of one pixel in the specified units.

double *LpAspect

Aspect ratio of the image.

int *lpunit

Points to calibration unit. Filled on output.

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

Return Values

double

This function returns calibration of the selected camera mode - the LpCal parameter value.

Get_ImageCalibration

Description 

int Get_ImageCalibration(
   char *Filename,
   char *Objective,
   double *lpcal,
   double *LpAspect,
   int *lpunit
);

This function retrieves the calibration information from the selected image file.

Parameters

char *Filename

The path and the name of the file.

char *Objective

Name of the objective.

double *lpcal

Size of one pixel in the specified units.

double *LpAspect

Aspect ratio of the image.

int *lpunit

Points to calibration unit. Filled on output.

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

Return Values

int

This function returns TRUE (1), if the filename contains valid image. Otherwise it returns FALSE (0).

See Also 
SaveImageCalibration, LoadImageDescription, SaveImageDescription, Get_Calibration

SaveImageCalibration

Description 

int SaveImageCalibration(
   char *Filename,
   char *Objective,
   double  Cal,
   double  Aspect,
   int  unit
);

This function changes the calibration information of the specified image file.

Parameters

char *Filename

The path and the name of the file.

char *Objective

Name of the objective.

double Cal

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

double Aspect

Numerical value (double) that expresses the anisotropy of the camera and the grabbing card. Filled on input.

int unit

Calibration Unit. Filled on input.

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

Return Values

int

This function returns TRUE (1), if the filename contains valid image. Otherwise it returns FALSE (0).

See Also 
Get_ImageCalibration, SaveImageDescription, LoadImageDescription, Get_Calibration

SetCalibrationViewPrecision

Description 

 SetCalibrationViewPrecision(
   int  CalibrationViewPrecision
);

This function sets the current precision for display calibrations.

Parameters

int CalibrationViewPrecision

Number of digits after the decimal point.

See Also 
SetCalibrationViewUnit

SetCalibrationViewUnit

Description 

 SetCalibrationViewUnit(
   char *CalibrationViewUnit
);

This function sets the current unit for displaying calibrations.

Parameters

char *CalibrationViewUnit

Name of the calibration unit.

px	Pixels
km	Kilometers
m	Meters
dm	Decimeters
cm	Centimeters
mm	Millimeters
um	Micrometers
nm	Nanometers
inch	Inches
mil	Mils

See Also 
SetCalibrationViewPrecision

Uncalibrate

Interactive command to this function: Set Document as Uncalibrated...

Description 

 Uncalibrate();

This function sets the current document as uncalibrated.

_CalibrateEx

This function runs the Calibration > Recalibrate Document command.

Description 

 _CalibrateEx();

This function calibrates the current document. The function displays the Manual Calibration dialog box.

See Also 
_CalibrateObjective

_CalibrateExObjLine

Description 

 _CalibrateExObjLine();

Opens the Manual Calibration dialog window used for objective calibration. The user has to specify a real distance in the image.

_Uncalibrate

This function runs the Set Document as Uncalibrated... command.

Description 

 _Uncalibrate();

This function removes the current image calibration. The image becomes Uncalibrated.