GoWebScanSettings Class Reference
Description
Represents a container for user-configurable settings of the system. The class reads and writes the settings from/to an XML. These settings describe the configuration and orientation of the system, processing parameters, and desired outputs. The format of the XML is similar to the chroma+scan 3x00 station settings but is not directly equivalent as additional parameters have been added. However, for any fields that exist in both formats, the chroma+scan 3x00 values can be reused. The settings are divided into system-level settings (GoWebScanSettings), group settings (GoWebScanSettingsGroup), and sensor settings (GoWebScanSettingsSensor).
Inheritance diagram for GoWebScanSettings:
Public Member Functions | |
| k32s | GoWebScanSettings_ActiveAreaHeight (GoWebScanSettings settings) |
| Gets the active area z boundary height (mils). More... | |
| k32s | GoWebScanSettings_ActiveAreaZ (GoWebScanSettings settings) |
| Gets the active area z lower boundary (mils) More... | |
| kBool | GoWebScanSettings_CalDetectLocators (GoWebScanSettings settings) |
| Gets a flag for whether the detection of calibration locators is enabled. More... | |
| k32s | GoWebScanSettings_CalLeadYMargin (GoWebScanSettings settings) |
| Gets the lead Y margin in mils. More... | |
| k32s | GoWebScanSettings_CalTrailYMargin (GoWebScanSettings settings) |
| Gets the trail Y margin in mils. More... | |
| kBool | GoWebScanSettings_CalUseObstructions (GoWebScanSettings settings) |
| Gets a flag for whether to manually remove regions from the calibration input data via user-defined obstructions (1) or to automatically detect conveyor hardware regions (0). More... | |
| kBool | GoWebScanSettings_CalUseVisionIntensity (GoWebScanSettings settings) |
| Gets a flag for whether the use of target intensities for each color channel during vision system calibration is enabled. More... | |
| k8u | GoWebScanSettings_CalVisionIntensityB (GoWebScanSettings settings) |
| Gets the target blue intensity level for vision system calibration. More... | |
| k8u | GoWebScanSettings_CalVisionIntensityG (GoWebScanSettings settings) |
| Gets the target green intensity level for vision system calibration. More... | |
| k8u | GoWebScanSettings_CalVisionIntensityR (GoWebScanSettings settings) |
| Gets the target red intensity level for vision system calibration. More... | |
| k32s | GoWebScanSettings_CalXAdjustment (GoWebScanSettings settings) |
| Gets the X adjustment offset in mils. More... | |
| k32s | GoWebScanSettings_CalYAdjustment (GoWebScanSettings settings) |
| Gets the Y adjustment offset in mils. More... | |
| k64f | GoWebScanSettings_CalYIntervalDivisor (GoWebScanSettings settings) |
| Gets the Y interval divisor which is used when calculating minimum Y-interval for retained data during calibration data collection. More... | |
| k32s | GoWebScanSettings_Concurrency (GoWebScanSettings settings) |
| Gets the thread count for processing tasks concurrently. More... | |
| kStatus | GoWebScanSettings_Construct (GoWebScanSettings *settings, kAlloc allocator) |
| Constructs a GoWebScanSettings object. More... | |
| kBool | GoWebScanSettings_DetectBackgroundFilter (GoWebScanSettings settings) |
| Gets flag for whether the background filter is enabled. More... | |
| kBool | GoWebScanSettings_DetectEdgeFilter (GoWebScanSettings settings) |
| Gets a flag for whether the detection edge filter is enabled. More... | |
| k32s | GoWebScanSettings_DetectEdgeMargin (GoWebScanSettings settings) |
| Gets the detection edge margin in mils. More... | |
| k32s | GoWebScanSettings_DetectMaxWidth (GoWebScanSettings settings) |
| Gets the detection maximum width in mils. More... | |
| kBool | GoWebScanSettings_DetectSideExtension (GoWebScanSettings settings) |
| Gets flag for whether extending the board side edge to correct for distortions is enabled. More... | |
| k32s | GoWebScanSettings_DetectTriggerLength (GoWebScanSettings settings) |
| Gets the detection trigger length in mils. More... | |
| GoWebScanDetectionStyle | GoWebScanSettings_DetectTriggerStyle (GoWebScanSettings settings) |
| Gets the detection trigger style. More... | |
| kStatus | GoWebScanSettings_EnableTracheid (GoWebScanSettings settings, kBool enable) |
| Enables tracheid data in the system. More... | |
| kStatus | GoWebScanSettings_EnableVision (GoWebScanSettings settings, kBool enable) |
| Enables vision data in the system. More... | |
| k64f | GoWebScanSettings_EncoderResolution (GoWebScanSettings settings) |
| Gets the encoder resolution in mils/tick. More... | |
| kBool | GoWebScanSettings_EncoderSimulated (GoWebScanSettings settings) |
| Gets the flag for whether the encoder simulator is enabled. More... | |
| k32s | GoWebScanSettings_GapFill (GoWebScanSettings settings) |
| Gets the maximum distance to fill gaps in data along the X-axis (mils). More... | |
| GoWebScanSettingsGroup | GoWebScanSettings_GroupAt (GoWebScanSettings settings, kSize index) |
| Gets the GoWebScanSettingsGroup object representing a group at a specified index. More... | |
| kSize | GoWebScanSettings_GroupCount (GoWebScanSettings settings) |
| Gets the number of groups (representing planes) in the system. More... | |
| kStatus | GoWebScanSettings_Load (GoWebScanSettings *settings, const kChar *fileName, kAlloc alloc) |
| Loads the settings XML from a specified path and constructs and initializes a GoWebScanSettings object with the values read from the XML. More... | |
| kBool | GoWebScanSettings_ObstructionFilter (GoWebScanSettings settings) |
| Gets flag for whether the obstruction filter is enabled. More... | |
| k32s | GoWebScanSettings_OverlapBlend (GoWebScanSettings settings) |
| Gets the overlap blend distance in mils. More... | |
| k32u | GoWebScanSettings_ProfileExposure (GoWebScanSettings settings) |
| Gets the profile exposure in microseconds. More... | |
| k32u | GoWebScanSettings_ProfileFrameRate (GoWebScanSettings settings) |
| Gets the profile frame rate in Hz. More... | |
| GoWebScanInterpolation | GoWebScanSettings_ProfileInterpolation (GoWebScanSettings settings) |
| Gets the profile interpolation method: Nearest Neighbor (0), or Linear Interpolation (1). More... | |
| k32s | GoWebScanSettings_ProfileXResolution (GoWebScanSettings settings) |
| Gets the profile X resolution (mils per profile pixel, along board length). More... | |
| k32s | GoWebScanSettings_ProfileYResolution (GoWebScanSettings settings) |
| Gets the profile Y resolution (mils per profile pixel, across board width). More... | |
| k32u | GoWebScanSettings_SchemaVersion (GoWebScanSettings settings) |
| Gets the GoWebScanSettings file schema version. More... | |
| GoWebScanSettingsSensor | GoWebScanSettings_SensorAt (GoWebScanSettings settings, kSSize index) |
| Gets the GoWebScanSettingsSensor object representing a sensor at a specified index in the system. More... | |
| kSize | GoWebScanSettings_SensorCount (GoWebScanSettings settings) |
| Gets the number of sensors in the system. More... | |
| k32s | GoWebScanSettings_SensorYOrientation (GoWebScanSettings settings, k32s plane) |
| Gets the sensor Y orientation for a given plane: Facing Toward (1) or Facing Away (0). More... | |
| kStatus | GoWebScanSettings_SetActiveAreaHeight (GoWebScanSettings settings, k32s value) |
| Sets the active area z boundary height (mils). More... | |
| kStatus | GoWebScanSettings_SetActiveAreaZ (GoWebScanSettings settings, k32s value) |
| Sets the active area z lower boundary (mils). More... | |
| kStatus | GoWebScanSettings_SetCalDetectLocators (GoWebScanSettings settings, kBool value) |
| Sets whether GoWebScan should attempt to detect calibration reference holes (1), or assume that sensors are mounted at their nominal locations along the X-axis (0). More... | |
| kStatus | GoWebScanSettings_SetCalLeadYMargin (GoWebScanSettings settings, k32s value) |
| Sets the lead Y margin in mils. More... | |
| kStatus | GoWebScanSettings_SetCalTrailYMargin (GoWebScanSettings settings, k32s value) |
| Sets the trail Y margin in mils. More... | |
| kStatus | GoWebScanSettings_SetCalUseVisionIntensity (GoWebScanSettings settings, kBool value) |
| Sets whether GoWebScan enables (1) or disables (0) the use of target intensities for each color channel during vision system calibration. More... | |
| kStatus | GoWebScanSettings_SetCalVisionIntensityB (GoWebScanSettings settings, k8u value) |
| Sets the desired blue intensity level for the calibration target (1 - 255). More... | |
| kStatus | GoWebScanSettings_SetCalVisionIntensityG (GoWebScanSettings settings, k8u value) |
| Sets the desired green intensity level for the calibration target (1 - 255). More... | |
| kStatus | GoWebScanSettings_SetCalVisionIntensityR (GoWebScanSettings settings, k8u value) |
| Sets the desired red intensity level for the calibration target (1 - 255). More... | |
| kStatus | GoWebScanSettings_SetCalXAdjustment (GoWebScanSettings settings, k32s value) |
| Sets the offset applied to the X-coordinates of all data (profile, vision, tracheid) in Web or Detection mode (mils). More... | |
| kStatus | GoWebScanSettings_SetCalYAdjustment (GoWebScanSettings settings, k32s value) |
| Sets the offset applied to the Y-coordinates of all data (profile, vision, tracheid) in Web or Detection mode (mils). More... | |
| kStatus | GoWebScanSettings_SetCalYIntervalDivisor (GoWebScanSettings settings, k64f value) |
| Sets the divisor to use when calculating minimum Y-interval for retained data during calibration data collection. More... | |
| kStatus | GoWebScanSettings_SetConcurrency (GoWebScanSettings settings, k32s value) |
| Sets the thread count for processing tasks concurrently. More... | |
| kStatus | GoWebScanSettings_SetDetectBackgroundFilter (GoWebScanSettings settings, kBool value) |
| Sets whether GoWebScan should remove tracheid and vision data where there is no corresponding profile data (1) or include all data in detection output (0). More... | |
| kStatus | GoWebScanSettings_SetDetectEdgeFilter (GoWebScanSettings settings, kBool value) |
| Sets whether GoWebScan should attempt to remove or correct edge measurement anomalies (1) or leave them unaltered (0). More... | |
| kStatus | GoWebScanSettings_SetDetectEdgeMargin (GoWebScanSettings settings, k32s value) |
| Sets the size of the margins (mils) that will be added to the leading and trailing edge of each detected object. More... | |
| kStatus | GoWebScanSettings_SetDetectMaxWidth (GoWebScanSettings settings, k32s value) |
| Sets the maximum width of a detection output (mils), including edge margins. More... | |
| kStatus | GoWebScanSettings_SetDetectSideExtension (GoWebScanSettings settings, kBool value) |
| Sets whether profile points which are along the board side edge and report an offset range from neighbouring spots should be corrected. More... | |
| kStatus | GoWebScanSettings_SetDetectTriggerLength (GoWebScanSettings settings, k32s value) |
| Sets the length (mils) of material used to trigger object on/off events, not including material inside obstruction regions. More... | |
| kStatus | GoWebScanSettings_SetDetectTriggerStyle (GoWebScanSettings settings, GoWebScanDetectionStyle value) |
| Sets the type of object detection trigger: Global (0) or Local (1). More... | |
| kStatus | GoWebScanSettings_SetEncoderResolution (GoWebScanSettings settings, k64f value) |
| Sets the encoder resolution in mils/tick. More... | |
| kStatus | GoWebScanSettings_SetEncoderSimulated (GoWebScanSettings settings, kBool value) |
| Enables simulating forward motion by overriding encoder values in data messages with simulated values. More... | |
| kStatus | GoWebScanSettings_SetGapFill (GoWebScanSettings settings, k32s value) |
| Sets the maximum distance to fill gaps in data along the X-axis (mils). More... | |
| kStatus | GoWebScanSettings_SetObstructionFilter (GoWebScanSettings settings, kBool value) |
| Sets whether GoWebScan should remove profile points contained within obstruction regions from output data (1) or include all profile points output data (0). More... | |
| kStatus | GoWebScanSettings_SetOverlapBlend (GoWebScanSettings settings, k32s value) |
| Sets the maximum amount of redundant camera information that can be blended together at the x- boundary between two cameras (mils). More... | |
| kStatus | GoWebScanSettings_SetProfileExposure (GoWebScanSettings settings, k32u value) |
| Sets the profile exposure in microseconds. More... | |
| kStatus | GoWebScanSettings_SetProfileFrameRate (GoWebScanSettings settings, k32u value) |
| Sets the frame rate to configure profile sensors to, in Hz. More... | |
| kStatus | GoWebScanSettings_SetProfileInterpolation (GoWebScanSettings settings, GoWebScanInterpolation value) |
| Sets the method used to resample profile points along the X-axis: Nearest Neighbor (0), or Linear Interpolation (1). More... | |
| kStatus | GoWebScanSettings_SetProfileXResolution (GoWebScanSettings settings, k32s value) |
| Sets the profile X resolution (mils per profile pixel, along board length). More... | |
| kStatus | GoWebScanSettings_SetProfileYResolution (GoWebScanSettings settings, k32s value) |
| Sets the profile Y resolution (mils per profile pixel, across board width). More... | |
| kStatus | GoWebScanSettings_SetSensorYOrientation (GoWebScanSettings settings, GoWebScanSystemPlane plane, k32s value) |
| Sets the sensor Y orientation for a given plane: Facing Toward (1) or Facing Away (0). More... | |
| kStatus | GoWebScanSettings_SetSimulatedSpeed (GoWebScanSettings settings, k64f value) |
| Sets the simulated encoder speed. More... | |
| kStatus | GoWebScanSettings_SetSystemAngle (GoWebScanSettings settings, k64f value) |
| Sets the system angle in degrees. More... | |
| kStatus | GoWebScanSettings_SetTileWidth (GoWebScanSettings settings, k32s value) |
| Sets the width of the data (mils) included in each profile, vision, or tracheid output tile. More... | |
| kStatus | GoWebScanSettings_SetTracheidExposure (GoWebScanSettings settings, k32u value) |
| Sets the tracheid exposure in microseconds. More... | |
| kStatus | GoWebScanSettings_SetTracheidXResolution (GoWebScanSettings settings, k32s value) |
| Sets the tracheid X resolution (mils per tracheid pixel, along board length). More... | |
| kStatus | GoWebScanSettings_SetTracheidYResolution (GoWebScanSettings settings, k32s value) |
| Sets the tracheid Y resolution (mils per tracheid value, across board width). More... | |
| kStatus | GoWebScanSettings_SetTravelOrientation (GoWebScanSettings settings, k32s value) |
| Sets the travel orientation which specifies the direction of conveyor movement: Moving Toward (1) or Moving Away (0). More... | |
| kStatus | GoWebScanSettings_SetUseObstructions (GoWebScanSettings settings, kBool value) |
| Sets whether to manually remove regions from the calibration input data via user-defined obstructions (1) or to automatically detect conveyor hardware regions (0).These regions are specified via sensor obstructions (GoWebScanSettingsSensor_AddObstruction()) and typically represent conveyor hardware regions. More... | |
| kStatus | GoWebScanSettings_SetUseXCenters (GoWebScanSettings settings, kBool value) |
| Sets whether GoWebScan should use the per-sensor X-center values provided in the settings file, or calculate them from sensor indices (e.g. More... | |
| kStatus | GoWebScanSettings_SetVisionExposureBottom (GoWebScanSettings settings, k32u value) |
| Sets the bottom vision exposure in microseconds. More... | |
| kStatus | GoWebScanSettings_SetVisionExposureTop (GoWebScanSettings settings, k32u value) |
| Sets the top vision exposure in microseconds. More... | |
| kStatus | GoWebScanSettings_SetVisionXResolution (GoWebScanSettings settings, k32s value) |
| Sets the vision X resolution (mils per vision pixel, along board length). More... | |
| kStatus | GoWebScanSettings_SetVisionXSubsampling (GoWebScanSettings settings, k32u value) |
| Sets the vision X subsampling. More... | |
| kStatus | GoWebScanSettings_SetVisionYResolution (GoWebScanSettings settings, k32s value) |
| Sets the vision Y resolution (mils per vision pixel, across board width). More... | |
| kStatus | GoWebScanSettings_SetXOrientation (GoWebScanSettings settings, k32s value) |
| Sets the sensor X orientation which represents whether the X-axis (length) increasing from left-to-right (1) or right-to-left (0). More... | |
| k64f | GoWebScanSettings_SimulatedSpeed (GoWebScanSettings settings) |
| Gets the simulated encoder speed. More... | |
| kStatus | GoWebScanSettings_Store (GoWebScanSettings settings, const kChar *fileName) |
| Stores the settings XML to a specified path. More... | |
| k64f | GoWebScanSettings_SystemAngle (GoWebScanSettings settings) |
| Gets the system angle in degrees. More... | |
| k32s | GoWebScanSettings_TileWidth (GoWebScanSettings settings) |
| Gets the width of the data (mils) included in each profile, vision, or tracheid output tile. More... | |
| kBool | GoWebScanSettings_TracheidEnabled (GoWebScanSettings settings) |
| Gets the flag for whether tracheid data is enabled. More... | |
| k32u | GoWebScanSettings_TracheidExposure (GoWebScanSettings settings) |
| Gets the tracheid exposure in microseconds. More... | |
| k32s | GoWebScanSettings_TracheidXResolution (GoWebScanSettings settings) |
| Gets the tracheid X resolution (mils per tracheid pixel, along board length). More... | |
| k32s | GoWebScanSettings_TracheidYResolution (GoWebScanSettings settings) |
| Gets the tracheid Y resolution (mils per tracheid value, across board width). More... | |
| k32s | GoWebScanSettings_TravelOrientation (GoWebScanSettings settings) |
| Gets the travel orientation which specifies the direction of conveyor movement: Moving Toward (1) or Moving Away (0). More... | |
| kBool | GoWebScanSettings_UseXCenters (GoWebScanSettings settings) |
| Gets the flag for whether GoWebScan uses user-defined X-centers. More... | |
| kBool | GoWebScanSettings_VisionEnabled (GoWebScanSettings settings) |
| Gets the flag for whether vision data is enabled. More... | |
| k32u | GoWebScanSettings_VisionExposureBottom (GoWebScanSettings settings) |
| Gets the bottom vision exposure in microseconds. More... | |
| k32u | GoWebScanSettings_VisionExposureTop (GoWebScanSettings settings) |
| Gets the top vision exposure in microseconds. More... | |
| k32s | GoWebScanSettings_VisionXResolution (GoWebScanSettings settings) |
| Gets the vision X resolution (mils per vision pixel, along board length). More... | |
| k32u | GoWebScanSettings_VisionXSubsampling (GoWebScanSettings settings) |
| Gets the vision X subsampling. More... | |
| k32s | GoWebScanSettings_VisionYResolution (GoWebScanSettings settings) |
| Gets the vision Y resolution (mils per vision pixel, across board width). More... | |
| k32s | GoWebScanSettings_XOrientation (GoWebScanSettings settings) |
| Gets the sensor X orientation. More... | |
The documentation for this class was generated from the following file: