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

Page: 113 / 357

Chapter 5 Configuration APIs 113
continued from previous page
Variable Definitions
The variables required by
PicamRoisConstraint
are:
scope:
The scope of the constraint.
severity: The severity of the constraint.
empty_set:
Indicates when there are no valid Regions of Interest
defined.
Valid values are:
• TRUE
There are no valid ROIs defined.
When TRUE, only
scope and severity are relevant.
• FALSE
There is at least one valid ROI defined.
rules:
Complex set of rules to which a parameter of this type must
adhere.
maximum_roi_count:
The maximum number of ROIs permitted.
x_constraint: The constraint governing the value of PicamRoi.x .
width_constraint:
The constraint governing the value of
PicamRoi.width
.
x_binning_limits_array: The list of valid values for PicamRoi.x_binning .
NOTE: An additional requirement is that
PicamRoi.x_binning must always divide evenly
into
PicamRoi.width
.
This is null when no additional limits are required.
x_binning_limits_count:
The number of items in
x_binning_limits_array
.
This is 0 when no additional limits are required.
y_constraint: The constraint governing the value of PicamRoi.y .
height_constraint:
The constraint governing the value of
PicamRoi.height
.
y_binning_limits_array: The list of valid values for PicamRoi.y_binning .
NOTE: An additional requirement is that
PicamRoi.y_binning must always divide evenly
into
PicamRoi.height
.
This is null when no additional limits are required.
y_binning_limits_count:
The number of items in
y_binning_limits_array
.
This is 0 when no additional limits are required.