Confocal_GetScanArea Description
Confocal_GetScanArea(
double *Confocal_pZoom,
double *Confocal_pAngle,
double *Confocal_pXOffset,
double *Confocal_pYOffset,
double *Confocal_pScanAreaAspect
);
This function gets current scan area zoom, angle, X offset, Y offset and aspect. Works only when current scan area mode is square, band, ROI or crop.
Parameters
double *Confocal_pZoom Scan area zoom.
double *Confocal_pAngle Scan area angle.
double *Confocal_pXOffset Scan area X offset.
double *Confocal_pYOffset Scan area Y offset.
double *Confocal_pScanAreaAspect Scan area aspect.
Confocal_GetScanAreaCropped Description
Confocal_GetScanAreaCropped(
double *Confocal_pZoom,
double *Confocal_pAngle,
double *Confocal_pXOffset,
double *Confocal_pYOffset,
double *Confocal_pCropXOffset,
double *Confocal_pCropYOffset,
double *Confocal_pCropZoom,
double *Confocal_pCropAspect
);
This function gets current scan area with crop option.
Parameters
double *Confocal_pZoom Scan area zoom.
double *Confocal_pAngle Scan area angle.
double *Confocal_pXOffset Scan area X offset.
double *Confocal_pYOffset Scan area Y offset.
double *Confocal_pCropXOffset Scan area crop X offset.
double *Confocal_pCropYOffset Scan area crop Y offset.
double *Confocal_pCropZoom Scan area crop zoom.
double *Confocal_pCropAspect Scan area crop aspect.
Confocal_GetScanAreaLine Description
Confocal_GetScanAreaLine(
double *Confocal_pLineStartX,
double *Confocal_pLineStartY,
double *Confocal_pLineEndX,
double *Confocal_pLineEndY
);
This function gets the begin/end position of the scan line when the scan mode is set to line. When other scan mode is used then error code is returned.
Parameters
double *Confocal_pLineStartX X coordinate of the scan line start.
double *Confocal_pLineStartY Y coordinate of the scan line start.
double *Confocal_pLineEndX X coordinate of the scan line stop.
double *Confocal_pLineEndY Y coordinate of the scan line stop.
Confocal_GetScanAreaMode Description
int Confocal_GetScanAreaMode();
Returns the current confocal scan area mode.
Return Values
int Current confocal scan area mode.
0 | Square scan area mode. |
1 | Band scan area mode. |
2 | Straight line scan area mode. |
3 | Free line scan area mode. |
4 | Closed line scan area mode. |
5 | Ellipse scan area mode. |
6 | ROI scan area mode. |
7 | Crop scan area mode. |
8 | Point scan area mode. |
9 | AUX point scan area mode. |
Confocal_ResetScanArea Description
Confocal_ResetScanArea();
This function resets the current scan area. It is equivalent to the reset button in the scan area GUI.
Confocal_ReuseScanAreaSettings Description
Confocal_ReuseScanAreaSettings(
char *Confocal_FileName
);
This function reuses the confocal scan area settings from the file.
Parameters
char *Confocal_FileName Filename of the image acquired with confocal.
Confocal_SetScanArea Description
Confocal_SetScanArea(
double Confocal_Zoom,
double Confocal_Angle,
double Confocal_XOffset,
double Confocal_YOffset,
double Confocal_ScanAreaAspect
);
This function sets the current scan area zoom, angle, X offset, Y offset and aspect.
Parameters
double Confocal_Zoom Scan area zoom.
double Confocal_Angle Scan area angle.
double Confocal_XOffset Scan area X offset.
double Confocal_YOffset Scan area Y offset.
double Confocal_ScanAreaAspect Scan area aspect.
Confocal_SetScanAreaCropped Description
Confocal_SetScanAreaCropped(
double Confocal_Zoom,
double Confocal_Angle,
double Confocal_XOffset,
double Confocal_YOffset,
double Confocal_CropXOffset,
double Confocal_CropYOffset,
double Confocal_CropZoom,
double Confocal_CropAspect
);
This function sets current scan area with crop option.
Parameters
double Confocal_Zoom Scan area zoom.
double Confocal_Angle Scan area angle.
double Confocal_XOffset Scan area X offset.
double Confocal_YOffset Scan area Y offset.
double Confocal_CropXOffset Scan area crop X offset.
double Confocal_CropYOffset Scan area crop Y offset.
double Confocal_CropZoom Scan area crop zoom.
double Confocal_CropAspect Scan area crop aspect.
Confocal_SetScanAreaLine Description
Confocal_SetScanAreaLine(
double Confocal_LineStartX,
double Confocal_LineStartY,
double Confocal_LineEndX,
double Confocal_LineEndY
);
This function sets the scan area mode to line and sets the begin/end position of the scan line.
Parameters
double Confocal_LineStartX X coordinate of the scan line start.
double Confocal_LineStartY Y coordinate of the scan line start.
double Confocal_LineEndX X coordinate of the scan line stop.
double Confocal_LineEndY Y coordinate of the scan line stop.