Devices / Device
Element | Type | Description |
---|---|---|
@index | 32u | Ordered index of devices in device list. |
@role | 32s |
Sensor role: 0 – Main 1 – Buddy |
Layout |
Multiplexing bank settings. |
|
DataSource | 32s |
Data source of device output (read-only): 0 – Top 1 – Bottom 2 – Top Left 3 – Top Right |
XSpacingCount | 32u | Number of resampled points along X (read-only). |
YSpacingCount | 32u | Number of resampled points along Y (read-only). |
ActiveArea | Region3D | Active area. (Contains min and max attributes for each element.) |
TransformedDataRegion | Region3D | Active area after transformation (read-only). |
FrontCamera | Window | Front camera window (read-only). |
BackCamera | Window | Back camera window (read-only). |
BackCamera.used | Bool | Whether or not this field is used. |
PatternSequenceType | 32s |
The projector pattern sequence to display when a projector equipped device is running. The following types are possible: -1 – None 0 – Default 100 – Nine Lines 101 – Focus 102 – Standard Sequence |
PatternSequenceType.options | 32s | List of available pattern sequence types. |
PatternSequenceType.used |
Bool |
Whether or not this field is used. |
PatternSequenceIndex |
32u |
The index of the pattern sequence to display. Choose the pattern that produces the best data. The indices represent Phase Pattern Sequences, followed by Stripe Pattern Sequences in reverse order. The lower indices are the higher frequency phase code patterns, and the higher indices are the lower frequency binary patterns. Index 1 [Phase Pattern Sequence Image 5]: Highest frequency sinusoid. Index 2 [Phase Pattern Sequence Image 4] [...] Index 5 [Phase Pattern Sequence Image 1]: Lowest frequency sinusoid. Index 6 [Stripe Pattern Sequence Image 7]: Highest bar count. Index 7 [Stripe Pattern Sequence Image 6] [...] Index 12 [Stripe Pattern Sequence Image 1]: Lowest bar count) Index 13 [Reference Image 1] |
PatternSequenceIndex.min |
32u |
The minimum index (inclusive) |
PatternSequenceIndex.max |
32u |
The maximum index (inclusive) |
PatternSequenceIndex.used |
Bool |
Whether or not the pattern sequence index should be displayed |
PatternSequenceIndex |
32u |
The index of the pattern sequence to display. |
PatternSequenceIndex.min |
32u |
The minimum index (inclusive). |
PatternSequenceIndex.max |
32u |
The maximum index (inclusive). |
PatternSequenceIndex.used |
Bool |
Whether or not the pattern sequence index should be displayed. |
PatternSequenceCount | 32u | Number of frames in the active sequence (read-only). |
ExposureMode | 32s |
Exposure mode: 0 – Single exposure 1 – Multiple exposures 2 – Dynamic exposure |
ExposureMode.options | 32s (CSV) | List of available exposure modes. |
Exposure | 64f | Single exposure (µs). |
Exposure.min | 64f | Minimum exposure (µs). |
Exposure.max | 64f | Maximum exposure (µs). |
Exposure.used |
Bool |
Whether or not this field is used. |
DynamicExposureMin | 64f | Dynamic exposure range minimum (µs). |
DynamicExposureMax | 64f | Dynamic exposure range maximum (µs). |
ExposureSteps | 64f (CSV) | Mutiple exposure list (µs). |
ExposureSteps.countMin | 32u | Minimum number of exposure steps. |
ExposureSteps.countMax | 32u | Maximum number of exposure steps. |
IntensitySource |
32s |
Intensity source: 0 – Both cameras 1 – Front camera 2 – Back camera |
IntensitySource.options | 32s (CSV) | List of available intensity sources. |
IntensityMode | 32s |
Intensity Mode: 0 – Auto 1 - Preserve |
IntensityMode.used | Bool | Whether intensity mode is used |
ZSubsampling | 32u | Subsampling factor in Z. |
ZSubsampling.options | 32u (CSV) | List of available subsampling factors in Z. |
SpacingInterval | 64f | Uniform spacing interval (mm). |
SpacingInterval.min | 64f | Minimum spacing interval (mm). |
SpacingInterval.max | 64f | Maximum spacing interval (mm). |
SpacingInterval.used | Bool | Whether or not field is used. |
SpacingInterval value | 64f | Actual value used. |
SpacingIntervalType | 32s |
Spacing interval type: 0 – Maximum resolution 1 – Balanced 2 – Maximum speed 3 – Custom |
SpacingIntervalType.used | Bool | Whether or not this field is used. |
Tracking |
Section |
|
Material |
Section |
|
Tracheid |
Section | See Tracheid Child Elements. |
IndependentExposures |
Section | See IndependentExposures Child Elements |
Custom | Custom | Used by specialized sensors. |
Element | Type | Description |
---|---|---|
X | 32u | X start (pixels). |
Y | 32u | Y start (pixels). |
Width | 32u | X extent (pixels). |
Height | 32u | Y extent (pixels). |
Tracking is only available on Gocator 2300 and 2400 series sensors. |
Element | Type | Description |
---|---|---|
Enabled | Bool | Enables tracking. |
Enabled.used | Bool | Whether or not this field is used. |
SearchThreshold | 64f | Percentage of spots that must be found to remain in track. |
Height | 64f | Tracking window height (mm). |
Height.min | 64f | Minimum tracking window height (mm). |
Height.max | 64f | Maximum tracking window height (mm). |
Element | Type | Description |
---|---|---|
Type | 32s |
Type of Material settings to use. 0 – Custom 1 – Diffuse 3 – Reflective |
Type.used | Bool | Determines if the setting’s value is currently used. |
Type.value | 32s | Value in use by the sensor, useful for determining value when used is false. |
Type.options | 32u (CSV) | List of available material types. |
SpotThreshold | 32s | Spot detection threshold. |
SpotThreshold.min |
32s |
The minimum spot detection threshold possible. |
SpotThreshold.max |
32s |
The maximum spot detection threshold possible. |
SpotThreshold.used | Bool | Determines if the setting’s value is currently used. |
SpotThreshold.value | 32s | Value in use by the sensor, useful for determining value when used is false. |
SpotThreshold.readonly |
Bool |
Whether or not property can be modified. If set, the value should be considered read-only by the client. Only has meaning if “used” is also set. |
SpotWidthMax | 32s | Spot detection maximum width. |
SpotWidthMax.used | Bool | Determines if the setting’s value is currently used. |
SpotWidthMax.value | 32s | Value in use by the sensor, useful for determining value when used is false. |
SpotWidthMax.min | 32s | Minimum allowed spot detection maximum value. |
SpotWidthMax.max | 32s | Maximum allowed spot detection maximum value. |
SpotSelectionType | 32s |
Spot selection type 0 – Best. Picks the strongest spot in a given column. 1 – Top. Picks the spot which is most Top/Left on the imager 2 – Bottom. Picks the spot which is most Bottom/Right on the imager 3 – None. All spots are available. This option may not be available in some configurations. 4 – Continuity. Picks the most continuous spot. |
SpotSelectionType.used | Bool | Determines if the setting’s value is currently used. |
SpotSelectionType.value | 32s | Value in use by the sensor, useful for determining value when used is false. |
SpotSelectionType.options |
32s (CSV) |
List of available spot selection types. |
SpotWidthMin |
32s |
Spot detection minimum width. |
SpotWidthMin.used |
32s |
Determines if the setting’s value is currently used and to be displayed. |
SpotWidthMin.value |
Bool |
Value in use by the sensor, useful for determining value when "used" is false. |
SpotWidthMin.min |
32s |
Minimum allowed spot detection minimum value. |
SpotWidthMin.max |
32s |
Maximum allowed spot detection minimum value. |
SpotWidthMin.readonly |
Bool |
Whether or not property can be modified. If set, the value should be considered read-only by the client. Only has meaning if “used” is also set. |
WidthThreshold |
32s |
Spot detection width threshold. |
WidthThreshold.used |
Bool |
Determines if the setting’s value is currently used and to be displayed. |
WidthThreshold.value |
32s |
Value in use by the sensor, useful for determining value when |
WidthThreshold.min |
32s |
Minimum allowed spot detection width threshold value. |
WidthThreshold.max |
32s |
Maximum allowed spot detection width threshold value. |
WidthThreshold.readonly |
Bool |
Whether or not property can be modified. If set, the value should be considered read-only by the client. Only has meaning if “used” is also set. |
SpotSumMin |
32s |
Spot detection minimum sum. |
SpotSumMin.used |
Bool |
Determines if the setting’s value is currently used and to be displayed. |
SpotSumMin.value |
32s |
Value in use by the sensor, useful for determining value when "used" is false. |
SpotSumMin.min |
32s |
Minimum allowed spot detection sum minimum value. |
SpotSumMin.max |
32s |
Maximum allowed spot detection sum minimum value. |
SpotSumMin.readonly |
Bool |
Whether or not property can be modified. If set, the value should be considered read-only by the client. Only has meaning if “used” is also set. |
SobelEdgeWindow |
32s |
Sobel spot detection edge window size. |
SobelEdgeWindow.used |
Bool |
Determines if the setting’s value is currently used and to be displayed. |
SobelEdgeWindow.value |
32s |
Value in use by the sensor, useful for determining value when "used" is false. |
SobelEdgeWindow min |
32s |
Minimum allowed Sobel spot detection edge window value. |
SobelEdgeWindow max |
32s |
Maximum allowed Sobel spot detection edge window value. |
SobelEdgeWindow.readonly |
Bool |
Whether or not property can be modified. If set, the value should be considered read-only by the client. Only has meaning if “used” is also set. |
CameraGainAnalog | 64f | Analog camera gain factor. |
CameraGainAnalog.used | Bool | Determines if the setting’s value is currently used. |
CameraGainAnalog.value | 64f | Value in use by the sensor, useful for determining value when used is false. |
CameraGainAnalog.min | 64f | Minimum value. |
CameraGainAnalog.max | 64f | Maximum value. |
CameraGainDigital | 64f | Digital camera gain factor. |
CameraGainDigital.used | Bool | Determines if the setting’s value is currently used. |
CameraGainDigital.value | 64f | Value in use by the sensor, useful for determining value when used is false. |
CameraGainDigital.min | 64f | Minimum value. |
CameraGainDigital.max | 64f | Maximum value. |
DynamicSensitivity | 64f | Dynamic exposure control sensitivity factor. This can be used to scale the control setpoint. |
DynamicSensitivity.used | Bool | Determines if the setting’s value is currently used. |
DynamicSensitivity.value | 64f | Value in use by the sensor, useful for determining value when used is false. |
DynamicSensitivity.min | 64f | Minimum value. |
DynamicSensitivity.max | 64f | Maximum value. |
DynamicThreshold | 32s | Dynamic exposure control threshold. If the detected number of spots is fewer than this number, the exposure will be increased. |
DynamicThreshold.used | Bool | Determines if the setting’s value is currently used. |
DynamicThreshold.value | 32s | Value in use by the sensor, useful for determining value when used is false. |
DynamicThreshold.min | 32s | Minimum value. |
DynamicThreshold.max | 32s | Maximum value. |
SensitivityCompensationEnabled | Bool | Sensitivity compensation toggle. Used in determining analog and digital gain, along with exposure scale. |
SensitivityCompensationEnabled.used | Bool | Determines if the setting’s value is currently used. |
SensitivityCompensationEnabled.value | Bool | Value in use by the sensor, useful for determining value when used is false. |
GammaType | 32s | Gamma type. |
GammaType used | Bool | Determines if the setting’s value is currently used. |
GammaType value | 32s | Value in use by the sensor. Useful for determining value when used is false. |
SpotContinuitySorting |
Section |
|
SpotTranslucentSorting |
Section |
|
SurfaceEncoding |
32s |
Surface encoding type: 0 – Standard 1 – Interreflection (advanced use only) |
SurfaceEncoding.used | Bool | Determines if the setting’s value is currently used. |
SurfaceEncoding.value | Bool | Value in use by the sensor, useful for determining value when used is false. |
SurfaceEncoding.readonly |
Bool |
Whether or not property can be modified. If set, the value should be considered read-only by the client. Only has meaning if “used” is also set. |
SurfacePhaseFilter | 32s |
Surface phase filter (correction type) 0 – None 1 – Reflective 2 - Translucent |
SurfacePhaseFilter.used | Bool | Determines if the setting’s value is currently used. |
SurfacePhaseFilter.value | Bool | Value in use by the sensor, useful for determining value when used is false. |
ContrastThreshold |
32s |
Contrast detection threshold. |
ContrastThreshold.min |
32s |
The minimum contrast detection threshold possible. |
ContrastThreshold.max |
32s |
The maximum contrast detection threshold possible. |
ContrastThreshold.used |
Bool |
Determines if the setting’s value is currently used. |
ContrastThreshold.value |
32s |
Value in use by the sensor, useful for determining value when used is false. |
ContrastThreshold.readonly |
Bool |
Whether or not property can be modified. If set, the value should be considered read-only by the client. Only has meaning if “used” is also set. |
IndependentExposures settings are only supported by 3x00 series sensors. |
Element | Type | Description |
---|---|---|
@used | Bool | Whether this field is used |
Enabled | Bool | Whether to allow using separate exposure values for each camera |
FrontCameraExposure | 64f | The exposure value to use for the front camera |
FrontCameraExposure.min | 64f | The minimum exposure value possible for front camera |
FrontCameraExposure.max | 64f | The maximum exposure value possible for back camera |
BackCameraExposure | 64f | The exposure value to use for the front camera |
BackCameraExposure.min | 64f | The minimum exposure value possible for front camera |
BackCameraExposure.max | 64f | The maximum exposure value possible for back camera |
Tracheid settings are only supported by Gocator 200 series multi-point sensors. |
Element | Type | Description |
---|---|---|
@used | Bool | Whether this field is used |
TracheidExposureEnabled | Bool | Whether to use a unique exposure for tracheid capture |
TracheidExposure | 64f | The exposure value to use for tracheid measurements |
TracheidExposure.min | 64f | The minimum exposure value possible tracheid measurements |
TracheidExposure.max | 64f | The maximum exposure value possible for tracheid measurements |
Camera0Threshold | 32u | The tracheid threshold for camera 0 |
Camera1Threshold | 32u | The tracheid threshold for camera 1 |