<< Click to Display Table of Contents > 

Scanner Card Interface > SCI Functions > Field & Working Area

Field & Working Area
Previous pageReturn to chapter overviewNext page

Return value

Function / Property name

Parameter

long

ScGetField()

int index, double *val

long

ScSCIGetField()

double *XMin, double *YMin, double *XMax, double *Ymax

long

ScSCIGetZField()

double *ZMin, double *ZMax

Table 71: GetField

The return value of this function is one of the current field size values. Index specifies the returned value. The dll-call versions return the values directly.

Index

Comment

0

X min

1

Y min

2

X max

3

Y max

4

Z min

5

Z max

Table 72: GetField indices

Return value

Function / Property name

Parameter

long

ScSetField()

double XMin,double YMin,double XMax,double YMax

long

ScSCISetField()

double XMin,double YMin,double XMax,double YMax

long

ScSetZField()

double ZMin,double ZMax

long

ScSCISetZField()

double ZMin,double ZMax

Table 73: SetField

This function sets the field size of the scan head which is always a square (in 2D) or cube (in 3D) in mm. The resulting field will have the length XMax - XMin for each axis - independent from YMax, YMin, ZMax and ZMin.

Right now the ScSetZField function is not defining the size of the field in z direction. However, in the future it might be implemented that ScSCISetField sets the related Z-values to 0, so ScSCISetZField() should be called afterwards anyway to be compatible in coming releases.

The size and the center of the resulting field will be:

Axis

Size of field

Center of field

X

XMax - XMin

(XMax - XMin)/2

Y

XMax - XMin

(YMax - YMin)/2

Z

XMax - XMin

0

Table 74: Size and center of resulting field


Return value

Function / Property name

Parameter

long

ScGetWorkingArea()

int Index, double *val

long

ScSCIGetWorkingArea()

double *XMin, double *YMin, double *XMax,double *YMax

long

ScSCIGetZWorkingArea

double *ZMin, double *ZMax

Table 75: GetWorkingArea

The return value of this function is one of the current field size values. The index parameter determines the returned value. The dll-call versions return the values directly.

Index

Comment

0

X min

1

Y min

2

X max

3

Y max

Table 76: GetWorkingArea indices

Return value

Function / Property name

Parameter

long

ScSetWorkingArea()

double XMin, double YMin, double XMax, double YMax

long

ScSCISetWorkingArea()

double XMin, double YMin, double XMax, double YMax

long

ScSetZWorkingArea()

double ZMin, double ZMax

long

ScSCISetZWorkingArea()

double ZMin, double ZMax

Table 77: SetWorkingArea

This function defines the actual working area. The parameters define the size using minimum and maximum values in both planar directions. ScSCISetWorkingArea sets the related Z-values to 0, so ScSCISetZWorkingArea() should be called afterwards.

When using low level marking commands in the scanner card interface the working area has no significance. Simply set it to the same values as the field size.