ROI

_LoadCameraROIFromFile, _ROIDefine, _ROIDefineLargeFOV, _ROIDefineOnCaptured, _ROIDefineOptimalFOV, _SaveCameraROIToFile, ROIEnable, ROIEnabled, ROIGet, ROISet, ROISetLargeFOV, ROISetOptimalFOV

ROIEnable

Description 

 ROIEnable(
   int  ROIEnable
);

This function enables/disables a usage of the ROI (when supported).

Parameters

int ROIEnable

Enables ROI.

0

Disable ROI

1

Enable ROI

ROIEnabled

Description 

 ROIEnabled();

This function returns 1 when ROI is enabled or 0 when it is disabled.

ROIGet

Description 

 ROIGet(
   int *pROILeft,
   int *pROITop,
   int *pROIRight,
   int *pROIBottom
);

This function retrieves the coordinates of the top-left and bottom-right corners of the ROI rectangle.

Parameters

int *pROILeft

Receives the x-coordinate of the top-left corner of the rectangle

int *pROITop

Receives the y-coordinate of the top-left corner of the rectangle

int *pROIRight

Receives the x-coordinate of the bottom-right corner of the rectangle

int *pROIBottom

Receives the y-coordinate of the bottom-right corner of the rectangle

ROISet

Description 

 ROISet(
   int  pROILeft,
   int  pROITop,
   int  pROIRight,
   int  pROIBottom
);

This function defines coordinates of the top-left and bottom-right corners of the ROI rectangle.

Parameters

int pROILeft

Specifies the x-coordinate of the top-left corner of the rectangle

int pROITop

Specifies the y-coordinate of the top-left corner of the rectangle

int pROIRight

Specifies the x-coordinate of the bottom-right corner of the rectangle

int pROIBottom

Specifies the y-coordinate of the bottom-right corner of the rectangle

ROISetLargeFOV

Description 

 ROISetLargeFOV();

Sets the large field of view. It is user defined in Service Settings and is used by various scanning jobs.

See Also 
_ROIDefineLargeFOV

ROISetOptimalFOV

Description 

 ROISetOptimalFOV();

Sets the optimal field of view. This field of view is automatically calculated according to the size of the microscope tube, it has a fixed size and only the center can be changed.

See Also 
_ROIDefineOptimalFOV

_LoadCameraROIFromFile

Description 

 _LoadCameraROIFromFile();

Loads a previously saved Camera ROI position and size from an external file.

_ROIDefine

Description 

 _ROIDefine();

This function displays a rectangle ROI (Region Of Interest) on the live image. The specified area of the camera chip will be used whenever the camera ROI is turned on.

See Also 
_ROIDefineOnCaptured, ROIEnable, ROIEnabled, ROIGet, ROISet

_ROIDefineLargeFOV

Description 

 _ROIDefineLargeFOV();

Opens the Rectangle dialog window for defining the large field of view.

See Also 
ROISetLargeFOV

_ROIDefineOnCaptured

Description 

 _ROIDefineOnCaptured();

This function shows a rectangle ROI (Region Of Interest) on the captured camera window (if active) which defines the CCD area to be used.

See Also 
_ROIDefine, ROIEnable, ROIEnabled, ROIGet, ROISet

_ROIDefineOptimalFOV

Description 

 _ROIDefineOptimalFOV();

Opens the Rectangle dialog window for defining the optimal field of view.

See Also 
ROISetOptimalFOV

_SaveCameraROIToFile

Description 

 _SaveCameraROIToFile();

Saves the Camera ROI position and size to an external file. The standard Save As window appears.