Teledyne Princeton Instruments PICam 5.x, Programmer'S Manual

Page: 108 / 357

108 PICam™ 5.x Programmer’s Manual Issue 11
5.2 Data Structure Definitions
This section provides programming information for the following PICam data structure
definitions:
• Camera-Specific Parameter Data Structures
— PicamRoi
— PicamRois
— PicamPulse
— PicamModulation
— PicamModulations
• Shared Camera/Accessory Parameter Data Structures
— PicamStatusPurview
5.2.1 Camera-Specific Parameter Data Structures
This section provides detailed programming information about camera-specific
parameter data structures.
5.2.1.1 PicamRoi
Description
PicamRoi
defines a single Region of Interest (ROI.)
Structure Definition
The structure definition for
PicamRoi
is:
typedef struct PicamRoi
{
piint x;
piint width;
piint x_binning;
piint y;
piint height;
piint y_binning;
} PicamRoi;
Variable Definitions
The variables required by
PicamRoi
are:
x: The left-most column coordinate (zero-based).
width:
The number of columns.
x_binning: The number of columns to group into a sum.
y:
The top-most row coordinate (zero-based).
height: The number of rows.
y_binning:
The number of rows to group into a sum.