Offset Parameter Details
ReferenceObjectOriginIndex
Defines which point of the reference object will be set as the origin of the coordinate system.
| ReferenceObjectOriginIndex Parameter Details |
|---|
| Type int |
| Value Range [0,3] |
| Default Value 0 |
ReferenceObjectType
Defines which coordinate system to use when configuring offset parameters basd on the reference objects.
| ReferenceObjectType Parameter Details |
|---|
| Type String |
| Value Range “ROT_ATOMIC_OBJECT” or “ROT_WHOLE_IMAGE” |
| Default Value “ROT_ATOMIC_OBJECT” |
MeasuredByPercentage
Sets whether or not to use percentage to measure the points’ coordinates.
| MeasuredByPercentage Parameter Details |
|---|
| Type int |
| Range 0 or 1 |
| Default Value 1 |
| Remarks 0: not by percentage 1: by percentage |
FirstPoint
Specifies the top-left vertex of the ROI with two possible expression forms:
[X, Y]: Represents the coordinates on the x and y axes. The expression in percentage for x and y is determined by parameterMeasuredByPercentage.[X, Y, MeasuredXByPercentage, MeasuredYByPercentage]: Includes independent control over whether the values for x and y are expressed in percentage.MeasuredXByPercentagedetermines if the x-value is in percentage, andMeasuredYByPercentagecontrols the y-value.
| FirstPoint Parameter Details |
|---|
| Type int[2] or int[4] |
| Default Value null |
SecondPoint
Specifies the top-right vertex of the ROI with two possible expression forms:
[X, Y]: Represents the coordinates on the x and y axes. The expression in percentage for x and y is determined by parameterMeasuredByPercentage.[X, Y, MeasuredXByPercentage, MeasuredYByPercentage]: Includes independent control over whether the values for x and y are expressed in percentage.MeasuredXByPercentagedetermines if the x-value is in percentage, andMeasuredYByPercentagecontrols the y-value.
| FirstPoint Parameter Details |
|---|
| Type int[2] or int[4] |
| Default Value null |
ThirdPoint
Specifies the bottom-right vertex of the ROI with two possible expression forms:
[X, Y]: Represents the coordinates on the x and y axes. The expression in percentage for x and y is determined by parameterMeasuredByPercentage.[X, Y, MeasuredXByPercentage, MeasuredYByPercentage]: Includes independent control over whether the values for x and y are expressed in percentage.MeasuredXByPercentagedetermines if the x-value is in percentage, andMeasuredYByPercentagecontrols the y-value.
| FirstPoint Parameter Details |
|---|
| Type int[2] or int[4] |
| Default Value null |
FourthPoint
Specifies the bottom-left vertex of the ROI with two possible expression forms:
[X, Y]: Represents the coordinates on the x and y axes. The expression in percentage for x and y is determined by parameterMeasuredByPercentage.[X, Y, MeasuredXByPercentage, MeasuredYByPercentage]: Includes independent control over whether the values for x and y are expressed in percentage.MeasuredXByPercentagedetermines if the x-value is in percentage, andMeasuredYByPercentagecontrols the y-value.
| FirstPoint Parameter Details |
|---|
| Type int[2] or int[4] |
| Default Value null |
Yes
No