10 #ifndef GO_SDK_SETUP_H
11 #define GO_SDK_SETUP_H
44 #ifndef EXPERIMENTAL_FEATURES_ENABLED
46 #endif // !EXPERIMENTAL_FEATURES_ENABLED
59 #ifndef EXPERIMENTAL_FEATURES_ENABLED
75 #ifndef EXPERIMENTAL_FEATURES_ENABLED
90 #ifndef EXPERIMENTAL_FEATURES_ENABLED
106 #ifndef EXPERIMENTAL_FEATURES_ENABLED
120 #ifndef EXPERIMENTAL_FEATURES_ENABLED
134 #ifndef EXPERIMENTAL_FEATURES_ENABLED
148 #ifndef EXPERIMENTAL_FEATURES_ENABLED
163 #ifndef EXPERIMENTAL_FEATURES_ENABLED
177 #ifndef EXPERIMENTAL_FEATURES_ENABLED
191 #ifndef EXPERIMENTAL_FEATURES_ENABLED
206 #ifndef EXPERIMENTAL_FEATURES_ENABLED
220 #ifndef EXPERIMENTAL_FEATURES_ENABLED
235 #ifndef EXPERIMENTAL_FEATURES_ENABLED
249 #ifndef EXPERIMENTAL_FEATURES_ENABLED
264 #ifndef EXPERIMENTAL_FEATURES_ENABLED
278 #ifndef EXPERIMENTAL_FEATURES_ENABLED
292 #ifndef EXPERIMENTAL_FEATURES_ENABLED
306 #ifndef EXPERIMENTAL_FEATURES_ENABLED
321 #ifndef EXPERIMENTAL_FEATURES_ENABLED
335 #ifndef EXPERIMENTAL_FEATURES_ENABLED
350 #ifndef EXPERIMENTAL_FEATURES_ENABLED
364 #ifndef EXPERIMENTAL_FEATURES_ENABLED
378 #ifndef EXPERIMENTAL_FEATURES_ENABLED
3965 #include <GoSdk/GoSetup.x.h>
kBool GoSetup_InputTriggerEnabledSystemValue(GoSetup setup)
Gets the input trigger system value.
kSize GoSetup_BarHoleCountValue(GoSetup setup)
Gets the bar hole count system value.
kStatus GoSetup_EnableAlignmentEncoderCalibrate(GoSetup setup, kBool enabled)
Enables encoder calibration after alignment.
kBool GoSetup_OcclusionReductionEnabledUsed(GoSetup setup)
Returns a boolean representing whether the user occlusion reduction configuration is used...
k64f GoSetup_ActiveAreaHeightLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaHeight setting.
k32u GoSetup_ExternalInputZPulseIndex(GoSetup setup)
Gets the external input index for triggering encoder Z-pulse.
k64u GoSetup_BackgroundSuppressionRatio(GoSetup setup)
Gets the background suppression ratio value.
kStatus GoSetup_SetXDecimationWindow(GoSetup setup, k64f window)
Sets the x-direction decimation window.
k64f GoSetup_ActiveAreaZLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaZ setting.
kBool GoSetup_UniformSpacingEnabledSystemValue(GoSetup setup)
Gets the Uniform Spacing enabled system value.
k64f GoSetup_ActiveAreaWidth(GoSetup setup, GoRole role)
Gets the active area width.
kBool GoSetup_XGapFillingUsed(GoSetup setup)
Indicates whether X gap filling can be used for the current scan mode and device family.
kBool GoSetup_TriggerGateEnabled(GoSetup setup)
Reports whether the trigger gate feature is currently enabled.
k64f GoSetup_XGapFillingWindowLimitMax(GoSetup setup)
Gets the x-direction gap-filling window maximum.
GoAlignmentTarget GoSetup_AlignmentMovingTargetOptionAt(GoSetup setup, kSize index)
Gets the moving alignment target option at the given index.
k64f GoSetup_ActiveAreaXLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaX setting.
k32s GoSetup_LayoutGridColumnSystemValue(GoSetup setup, GoRole role)
Gets column index system value being used on device in n-buddy system.
k64f GoSetup_ActiveAreaHeightLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaHeight setting.
kStatus GoSetup_SetActiveAreaLength(GoSetup setup, GoRole role, k64f value)
Sets the active area Length.
GoTriggerUnits GoSetup_TriggerUnit(GoSetup setup)
Gets the system trigger units.
kStatus GoSetup_SetPlateHoleCount(GoSetup setup, kSize count)
Sets the number of holes that are defined on the calibration plate.
kStatus GoSetup_SetAlignmentType(GoSetup setup, GoAlignmentType type)
Sets the type used for alignment.
k64f GoSetup_YMedianWindowLimitMin(GoSetup setup)
Gets the y-direction median window minimum.
k32s GoSetup_LayoutGridRow(GoSetup setup, GoRole role)
Gets row index being configured (may not be applicable or used) on device in n-buddy system...
kBool GoSetup_XSlopeUsed(GoSetup setup)
Indicates whether X slope can be used for the current scan mode and device family.
k64f GoSetup_ActiveAreaWidthLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaWidth setting.
Represents all possible sources of intensity data.
kBool GoSetup_UniformSpacingAvailable(GoSetup setup)
Gets a boolean representing whether or not the user specified Uniform Spacing setting is being used a...
k32s GoSetup_LayoutGridRowSystemValue(GoSetup setup, GoRole role)
Gets row index system value being used on device in n-buddy system.
k64f GoSetup_Exposure(GoSetup setup, GoRole role)
Gets the exposure value.
k64f GoSetup_XMedianWindow(GoSetup setup)
Gets the x-direction median window.
k64f GoSetup_XGapFillingWindow(GoSetup setup)
Gets the x-direction gap-filling window.
kBool GoSetup_YGapFillingEnabled(GoSetup setup)
Gets the status of y-direction gap-filling.
Represents configurable advanced acquisition settings.
kBool GoSetup_XGapFillingEnabled(GoSetup setup)
Gets the status of x-direction gap-filling.
kStatus GoSetup_EnableYMedian(GoSetup setup, kBool enable)
Sets the status of y-direction median.
k64f GoSetup_ActiveAreaY(GoSetup setup, GoRole role)
Gets the active area Y.
kStatus GoSetup_SetReversalDistanceAutoEnabled(GoSetup setup, kBool enabled)
This API is experimental and may change in a future release Enables or disables auto encoder reversal...
k32u GoSetup_ZSubsamplingOptionAt(GoSetup setup, GoRole role, kSize index)
Gets the z-resolution option at the specified index.
Declares the GoPartDetection class.
kStatus GoSetup_EnableMaxFrameRate(GoSetup setup, kBool enable)
Enables or disables operation at full frame rate (ignoring frame rate setting).
k64f GoSetup_TrackingAreaHeight(GoSetup setup, GoRole role)
Gets the tracking window height.
k64f GoSetup_ActiveAreaYLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaY setting.
kBool GoSetup_ReversalDistanceAutoEnabled(GoSetup setup)
This API is experimental and may change in a future release Returns whether or not auto encoder rever...
kSize GoSetup_PatternSequenceTypeOptionCount(GoSetup setup, GoRole role)
Gets the pattern sequence type option count.
kStatus GoSetup_AddExposureStep(GoSetup setup, GoRole role, k64f exposure)
Adds an exposure step.
k64f GoSetup_TriggerDelay(GoSetup setup)
Gets the trigger delay.
kStatus GoSetup_EnablePreferMasterTimeEncoderEnabled(GoSetup setup, kBool enable)
Sets whether the time and encoder values are preferred to come from the Master rather than from the s...
kStatus GoSetup_SetActiveAreaWidth(GoSetup setup, GoRole role, k64f value)
Sets the active area width.
kBool GoSetup_TriggerExternalInputIndexUsed(GoSetup setup)
Gets the flag indicating whether the external input trigger is being used.
kBool GoSetup_BarDegreesOfFreedomUsed(GoSetup setup)
Indicates if the degrees of freedom for bar alignment can be modified by the user.
Declares the GoSections class.
k32u GoSetup_BackCameraX(GoSetup setup, GoRole role)
Gets the camera region-of-interest x origin.
kSize GoSetup_XSubsamplingOptionCount(GoSetup setup, GoRole role)
Gets the count of valid x-resolution options.
k64f GoSetup_BackCameraExposure(GoSetup setup, GoRole role)
Gets the back camera exposure value.
k64f GoSetup_TransformedDataRegionX(GoSetup setup, GoRole role)
Gets the transformed data region X value.
Represents tracheid data.
kStatus GoSetup_SetAlignmentMovingTarget(GoSetup setup, GoAlignmentTarget target)
Sets the target type used for moving alignment calibration.
kBool GoSetup_YMedianUsed(GoSetup setup)
Indicates whether Y median can be used for the current scan mode and device family.
kSize GoSetup_TriggerExternalInputIndexOptionCount(GoSetup setup)
Gets the count of available external input trigger index options.
kSize GoSetup_TriggerSourceOptionCount(GoSetup setup)
Gets the count of available trigger source options.
kBool GoSetup_YSmoothingUsed(GoSetup setup)
Indicates whether Y smoothing can be used for the current scan mode and device family.
k64f GoSetup_TransformedDataRegionLength(GoSetup setup, GoRole role)
Gets the transformed data region length value.
kBool GoSetup_UniformSpacingEnabled(GoSetup setup)
Gets the user specified Uniform Spacing enabled state.
kBool GoSetup_IntensityEnabled(GoSetup setup)
Reports whether the profile intensity collection is enabled.
kStatus GoSetup_SetZSubsampling(GoSetup setup, GoRole role, k32u zSubsampling)
Sets the current z-resolution divider.
kBool GoSetup_XDecimationEnabled(GoSetup setup)
Gets the status of x-direction decimation.
kSize GoSetup_AlignmentTypeOptionCount(GoSetup setup)
Gets the alignment type option count.
kStatus GoSetup_EnableTriggerGate(GoSetup setup, kBool enable)
Sets the trigger gate feature.
k64f GoSetup_YSmoothingWindow(GoSetup setup)
Gets the y-direction smoothing window.
kStatus GoSetup_SetBackgroundSuppressionRatio(GoSetup setup, k64u ratio)
Sets the background suppression ratio value.
kSize GoSetup_BarHoleCount(GoSetup setup)
Gets the number of holes that are defined on the calibration bar.
kStatus GoSetup_SetBarHoleDistance(GoSetup setup, k64f distance)
Sets the distance between holes that are defined on the calibration bar.
kStatus GoSetup_SetLayoutGridRow(GoSetup setup, GoRole role, k32s value)
Sets row index being configured (may not be applicable or used) on device in n-buddy system...
kBool GoSetup_TrackingUsed(GoSetup setup, GoRole role)
Returns a boolean value representing whether the Tracking Enabled field is used.
GoEncoderTriggerMode GoSetup_EncoderTriggerMode(GoSetup setup)
Gets the encoder trigger mode.
Represents a profile generation configuration.
kBool GoSetup_TriggerBurstEnabled(GoSetup setup)
This API is experimental and may change in a future release Gets the trigger burst enabled state...
kSize GoSetup_IntensitySourceOptionCount(GoSetup setup, GoRole role)
Gets the intensity source option count.
k64f GoSetup_EncoderSpacingLimitMin(GoSetup setup)
Constraint for the minimum valid value of the Encoder Period setting.
kStatus GoSetup_SetDynamicExposureMax(GoSetup setup, GoRole role, k64f exposure)
Sets the maximum value for the Dynamic Exposure setting.
kBool GoSetup_FlickerFreeModeEnabled(GoSetup setup)
Reports whether flicker free mode is enabled.
kStatus GoSetup_SetExposureMode(GoSetup setup, GoRole role, GoExposureMode mode)
Sets the exposure mode.
k64f GoSetup_XSmoothingWindowLimitMin(GoSetup setup)
Gets the x-direction smoothing window minimum.
k32u GoSetup_PatternSequenceIndexMin(GoSetup setup, GoRole role)
Gets the current phase pattern index min value (inclusive).
kStatus GoSetup_SetFrameRate(GoSetup setup, k64f frameRate)
Sets the current frame rate for time-based triggering.
k64f GoSetup_TrackingSearchThreshold(GoSetup setup, GoRole role)
Gets the tracking window search threshold.
k32u GoSetup_ZSubsampling(GoSetup setup, GoRole role)
Gets the current z-resolution divider.
kStatus GoSetup_SetActiveAreaX(GoSetup setup, GoRole role, k64f value)
Sets the active area x origin.
kBool GoSetup_IndependentExposuresUsed(GoSetup setup, GoRole role)
Returns a boolean value representing the state of the independent exposures used field.
kSize GoSetup_ZSubsamplingOptionCount(GoSetup setup, GoRole role)
Gets the count of valid z-resolution options.
Represents a user role. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx)
kBool GoSetup_AlignmentUsed(GoSetup setup)
Indicates whether alignment can be used.
kStatus GoSetup_SetLayoutGridColumn(GoSetup setup, GoRole role, k32s value)
Sets column index being configured (may not be applicable or used) on device in n-buddy system...
kStatus GoSetup_SetSpacingIntervalType(GoSetup setup, GoRole role, GoSpacingIntervalType type)
Sets the spacing interval type.
kBool GoSetup_YSlopeEnabled(GoSetup setup)
Gets the status of y-direction slope.
GoOcclusionReductionAlg GoSetup_OcclusionReductionAlg(GoSetup setup)
Gets the occlusion reduction algorithm.
k64f GoSetup_FrameRateLimitMax(GoSetup setup)
Constraint for the maximum valid value of the Frame Rate setting.
kStatus GoSetup_SetTriggerExternalInputIndex(GoSetup setup, k32s index)
Sets the external input index to trigger profile/surface capturing.
GoMode GoSetup_ScanModeOptionAt(GoSetup setup, kSize index)
Gets the scan mode option at the specified index.
kSize GoSetup_PatternSequenceCount(GoSetup setup, GoRole role)
Gets the current pattern sequence count.
[Deprecated] Use GoAdvanced class instead.
Represents an alignment degree of freedom setting.
kStatus GoSetup_SetYGapFillingWindow(GoSetup setup, k64f window)
Sets the y-direction gap-filling window.
kStatus GoSetup_SetPlateRefHoleDiameter(GoSetup setup, k64f diameter)
Sets the diameter of the reference hole defined on the calibration plate.
k32u GoSetup_BackCameraHeight(GoSetup setup, GoRole role)
Gets the camera region-of-interest height.
k64f GoSetup_FrameRate(GoSetup setup)
Reports the currently configured frame rate.
k32u GoSetup_BackCameraUsed(GoSetup setup, GoRole role)
Returns a boolean representing whether the back camera element is used.
k64u GoSetup_LaserIdleTime(GoSetup setup)
This API is experimental and may change in a future release Gets the idle time before laser deactivat...
kStatus GoSetup_EnableUniformSpacing(GoSetup setup, kBool enable)
Sets the user specified Uniform Spacing enabled state.
kStatus GoSetup_SetLaserWakeupEncoderTravel(GoSetup setup, k64u distance)
This API is experimental and may change in a future release Sets the encoder wakeup travel distance...
k32u GoSetup_XSpacingCount(GoSetup setup, GoRole role)
Gets the X spacing count.
k64f GoSetup_ActiveAreaZ(GoSetup setup, GoRole role)
Gets the active area z origin.
kBool GoSetup_BackgroundSuppressionEnabled(GoSetup setup)
Gets the background suppression enabled value.
k64f GoSetup_ReversalDistanceSystemValue(GoSetup setup)
This API is experimental and may change in a future release Gets the encoder reversal distance thresh...
GoIntensityMode GoSetup_IntensityMode(GoSetup setup, GoRole role)
Gets the intensity data generation mode.
kStatus GoSetup_EnableBackgroundSuppression(GoSetup setup, kBool enabled)
Sets the background suppression enabled value.
k32u GoSetup_YSpacingCount(GoSetup setup, GoRole role)
Gets the Y spacing count.
k32u GoSetup_FrontCameraWidth(GoSetup setup, GoRole role)
Gets the camera region-of-interest width.
kBool GoSetup_XSmoothingUsed(GoSetup setup)
Indicates whether X smoothing can be used for the current scan mode and device family.
GoSpacingIntervalType GoSetup_SpacingIntervalType(GoSetup setup, GoRole role)
Gets the spacing interval type.
GoIntensitySource GoSetup_IntensitySourceOptionAt(GoSetup setup, GoRole role, kSize index)
Gets the intensity source option at the given index.
k64f GoSetup_PlateSecHoleDiameter(GoSetup setup)
Gets the diameter of the secondary hole defined on the calibration plate.
k32u GoSetup_FrontCameraX(GoSetup setup, GoRole role)
Gets the camera region-of-interest x origin.
k64f GoSetup_DiskHeight(GoSetup setup)
Gets the height of the disk used for travel calibration.
kBool GoSetup_PatternSequenceIndexUsed(GoSetup setup, GoRole role)
Gets the current phase pattern index used flag value.
kStatus GoSetup_SetTrackingSearchThreshold(GoSetup setup, GoRole role, k64f threshold)
Sets the tracking window search threshold.
k64f GoSetup_FrameDataRate(GoSetup setup)
Reports the current frame rate of normal (range, profile, or surface) data.
kSize GoSetup_PlateHoleCount(GoSetup setup)
Gets the number of holes that are defined on the calibration plate.
GoAlignmentType GoSetup_AlignmentType(GoSetup setup)
Gets the type used for alignment calibration.
k32u GoSetup_LayoutMultiplexingBank(GoSetup setup, GoRole role)
Gets Multiplex bank value being configured (may not be applicable or used) on device in n-buddy syste...
k32u GoSetup_TriggerBurstCount(GoSetup setup)
This API is experimental and may change in a future release Gets the trigger burst count...
GoAlignmentTarget GoSetup_AlignmentStationaryTargetOptionAt(GoSetup setup, kSize index)
Gets the stationary alignment target option at the given index.
kStatus GoSetup_EnableTracking(GoSetup setup, GoRole role, kBool enable)
Enables tracking.
kBool GoSetup_XSlopeEnabled(GoSetup setup)
Gets the status of x-direction slope.
kBool GoSetup_OcclusionReductionAlgUsed(GoSetup setup)
Returns a boolean representing whether the user occlusion reduction algorithm is used.
k64f GoSetup_ActiveAreaLengthLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaLength setting.
kBool GoSetup_OcclusionReductionEnabled(GoSetup setup)
Gets the occlusion reduction enabled state.
GoSections GoSetup_Sections(GoSetup setup)
Gets the Section configuration module, used for surface sections.
GoMaterial GoSetup_Material(GoSetup setup, GoRole role)
[Deprecated] Use GoSetup_Advanced() instead.
GoIntensitySource GoSetup_IntensitySource(GoSetup setup, GoRole role)
Gets the source used for generating intensity data.
kStatus GoSetup_EnableTemperatureSafety(GoSetup setup, kBool enable)
Enables the temperature saftey of the sensor system.
Represents a layout related sensor configuration.
kStatus GoSetup_EnableXSmoothing(GoSetup setup, kBool enabled)
Sets the status of x-direction smoothing.
Declares the GoTransform class.
GoTracheid GoSetup_Tracheid(GoSetup setup, GoRole role)
Gets the tracheid configuration module.
kStatus GoSetup_SetBarHeight(GoSetup setup, k64f height)
Sets the height of the bar used for travel calibration.
k64f GoSetup_YMedianWindowLimitMax(GoSetup setup)
Gets the y-direction median window maximum.
kStatus GoSetup_SetActiveAreaY(GoSetup setup, GoRole role, k64f value)
Sets the active area Y.
kStatus GoSetup_ClearPolygonCorners(GoSetup setup)
Clears all corner parameter objects from the collection of polygon corners for alignment.
kStatus GoSetup_SetLaserIdleTime(GoSetup setup, k64u time)
This API is experimental and may change in a future release Sets the time before the laser deactivate...
GoAlignmentTarget GoSetup_AlignmentMovingTarget(GoSetup setup)
Gets the target type used for moving alignment calibration.
k64f GoSetup_YGapFillingWindow(GoSetup setup)
Gets the y-direction gap-filling window.
k64f GoSetup_TracheidRate(GoSetup setup)
Reports the current frame rate of Tracheid data.
k64f GoSetup_XSmoothingWindow(GoSetup setup)
Gets the x-direction smoothing window.
kSize GoSetup_PolygonCornerCount(GoSetup setup)
Gets the number of corner parameters defined in the collection of polygon corners.
kStatus GoSetup_SetBackCameraExposure(GoSetup setup, GoRole role, k64f exposure)
Sets the back camera exposure value.
k64f GoSetup_SpacingInterval(GoSetup setup, GoRole role)
Gets the spacing interval.
k64f GoSetup_DiskDiameter(GoSetup setup)
Gets the diameter of the disk used for travel calibration.
k64f GoSetup_TransformedDataRegionZ(GoSetup setup, GoRole role)
Gets the transformed data region Z value.
k32s GoSetup_LayoutGridColumn(GoSetup setup, GoRole role)
Gets column index being configured (may not be applicable or used) on device in n-buddy system...
k64f GoSetup_ActiveAreaXLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaX setting.
kStatus GoSetup_SetTriggerBurstEnabled(GoSetup setup, kBool enable)
Enables the trigger burst.
kSize GoSetup_ScanModeOptionCount(GoSetup setup)
Gets the scan mode option count.
kBool GoSetup_TriggerGateEnabledSystemValue(GoSetup setup)
Reports the trigger gate enabled system value.
Represents a surface generation configuration.
k64f GoSetup_FrontCameraExposureLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the front camera exposure setting.
GoAlignmentTarget GoSetup_TriggerExternalInputIndexOptionAt(GoSetup setup, kSize index)
Gets the external input trigger option at the given index.
kBool GoSetup_YSmoothingEnabled(GoSetup setup)
Gets the status of y-direction smoothing.
kStatus GoSetup_SetBarHoleCount(GoSetup setup, kSize count)
Sets the number of holes that are defined on the calibration bar.
kStatus GoSetup_SetYSlopeWindow(GoSetup setup, k64f window)
Sets the status of y-direction slope.
Essential SDK declarations.
kStatus GoSetup_EnableExternalInputZPulse(GoSetup setup, kBool enable)
Sets the state of the external input triggered encoder Z-pulse feature.
k32u GoSetup_FrontCameraY(GoSetup setup, GoRole role)
Gets the camera region-of-interest y origin.
kStatus GoSetup_SetEncoderSpacing(GoSetup setup, k64f period)
Sets the current encoder period for encoder-based triggering.
kStatus GoSetup_SetBarDegreesOfFreedom(GoSetup setup, GoAlignmentDegreesOfFreedom dof)
Sets the degrees of freedom used for bar alignment calibration.
GoAdvanced GoSetup_Advanced(GoSetup setup, GoRole role)
Gets the advanced acquisition module, used for advanced acquisition configuration.
k64f GoSetup_YMedianWindow(GoSetup setup)
Gets the y-direction median window.
k64f GoSetup_YDecimationWindow(GoSetup setup)
Gets the y-direction decimation window.
k64f GoSetup_BarHoleDistance(GoSetup setup)
Gets the distance between holes that are defined on the calibration bar.
k64f GoSetup_YGapFillingWindowLimitMax(GoSetup setup)
Gets the y-direction gap-filling window maximum.
kBool GoSetup_InputTriggerEnabledUsed(GoSetup setup)
Returns a boolean representing whether the user input trigger configuration is used.
kBool GoSetup_XDecimationUsed(GoSetup setup)
Indicates whether X decimation can be used for the current scan mode and device family.
k64f GoSetup_BarWidth(GoSetup setup)
Gets the width of the bar used for travel calibration.
kBool GoSetup_InputTriggerEnabled(GoSetup setup)
Gets the input trigger enabled state.
kBool GoSetup_IndependentExposuresEnabled(GoSetup setup, GoRole role)
Determines if independent exposures feature is enabled.
k64f GoSetup_ReversalDistance(GoSetup setup)
This API is experimental and may change in a future release Gets the encoder reversal distance thresh...
kBool GoSetup_IntensityModeUsed(GoSetup setup, GoRole role)
Gets the availability of the intensity mode property.
k64f GoSetup_XMedianWindowLimitMax(GoSetup setup)
Gets the x-direction median window maximum.
k64f GoSetup_SpacingIntervalLimitMin(GoSetup setup, GoRole role)
Gets the spacing interval value limit minimum.
kStatus GoSetup_EnableIntensity(GoSetup setup, kBool enable)
Enables profile intensity collection.
Represents the part detection parameters of the surface mode configuration.
kStatus GoSetup_SetTriggerSource(GoSetup setup, GoTrigger source)
Sets the trigger source for profile triggering.
Represents all possible intensity generation modes for multiple exposures.
kSize GoSetup_AlignmentMovingTargetOptionCount(GoSetup setup)
Gets the moving alignment target option count.
kStatus GoSetup_SetScanMode(GoSetup setup, GoMode mode)
Sets the scan mode.
kBool GoSetup_YSlopeUsed(GoSetup setup)
Indicates whether Y slope can be used for the current scan mode and device family.
GoSurfaceGeneration GoSetup_SurfaceGeneration(GoSetup setup)
Gets the surface generation module, used for surface generation configuration.
GoPartMatching GoSetup_PartMatching(GoSetup setup)
Gets the part matching module, used for part matching configuration.
k64f GoSetup_XSmoothingWindowLimitMax(GoSetup setup)
Gets the x-direction smoothing window maximum.
kStatus GoSetup_SetAlignmentStationaryTarget(GoSetup setup, GoAlignmentTarget target)
Sets the target type used for stationary alignment calibration.
kStatus GoSetup_SetTrackingAreaHeight(GoSetup setup, GoRole role, k64f height)
Sets the tracking window height.
kSize GoSetup_AlignmentStationaryTargetOptionCount(GoSetup setup)
Gets the stationary alignment target option count.
kBool GoSetup_YMedianEnabled(GoSetup setup)
Gets the status of y-direction median.
k64f GoSetup_XSlopeWindowLimitMax(GoSetup setup)
Gets the x-direction slope window maximum.
k64f GoSetup_BarHeight(GoSetup setup)
Gets the height of the bar used for travel calibration.
k32u GoSetup_BackCameraY(GoSetup setup, GoRole role)
Gets the camera region-of-interest y origin.
kBool GoSetup_TriggerGateEnabledUsed(GoSetup setup)
Gets the system value representing whether or not the user specified trigger gate enabled setting is ...
kStatus GoSetup_EnableYSmoothing(GoSetup setup, kBool enable)
Sets the status of y-direction smoothing.
k64f GoSetup_ActiveAreaLengthLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaLength setting.
kBool GoSetup_LaserSleepModeEnabled(GoSetup setup)
This API is experimental and may change in a future release Gets the laser sleep mode enabled state...
k64f GoSetup_SpacingIntervalSystemValue(GoSetup setup, GoRole role)
Gets the spacing interval system value.
kStatus GoSetup_SetPatternSequenceIndex(GoSetup setup, GoRole role, k32u index)
Sets the current phase pattern index.
GoAlignmentTarget GoSetup_AlignmentStationaryTarget(GoSetup setup)
Gets the target type used for stationary alignment calibration.
GoPatternSequenceType GoSetup_PatternSequenceTypeOptionAt(GoSetup setup, GoRole role, kSize index)
Gets the pattern sequence type option at the given index.
k64f GoSetup_FrameRateLimitMin(GoSetup setup)
Constraint for the minimum valid value of the Frame Rate setting.
kStatus GoSetup_EnableXDecimation(GoSetup setup, kBool enabled)
Sets the status of x-direction decimation.
kBool GoSetup_ReversalDistanceAutoEnabledUsed(GoSetup setup)
This API is experimental and may change in a future release Returns whether or not auto encoder rever...
kBool GoSetup_LaserSleepUsed(GoSetup setup)
This API is experimental and may change in a future release Gets the laser sleep mode used value...
k64f GoSetup_TransformedDataRegionWidth(GoSetup setup, GoRole role)
Gets the transformed data region width value.
kStatus GoSetup_SetExposure(GoSetup setup, GoRole role, k64f exposure)
Sets the exposure value.
kBool GoSetup_BarHoleCountUsed(GoSetup setup)
Indicates if the hole count can be modified by the user.
k32s GoSetup_TriggerExternalInputIndex(GoSetup setup)
Gets the external input index to trigger profile/surface capturing.
kBool GoSetup_TriggerBurstCountUsed(GoSetup setup)
This API is experimental and may change in a future release Gets the trigger burst used value...
kBool GoSetup_YDecimationEnabled(GoSetup setup)
Gets the status of y-direction decimation.
kStatus GoSetup_EnableFlickerFreeMode(GoSetup setup, kBool enable)
Enables flicker reduction mode.
k64f GoSetup_YSlopeWindowLimitMin(GoSetup setup)
Gets the y-direction slope window minimum.
k64f GoSetup_TrackingAreaHeightLimitMin(GoSetup setup, GoRole role)
Gets the tracking window height minimum limit.
kBool GoSetup_ExternalInputZPulseEnabled(GoSetup setup)
Gets the state of the external input triggered encoder Z-pulse feature.
kBool GoSetup_BarHoleDiameterUsed(GoSetup setup)
Indicates if the hole diameter can be modified by the user.
GoLayout GoSetup_Layout(GoSetup setup)
Gets the layout configuration module.
kSize GoSetup_IntensityStepIndex(GoSetup setup, GoRole role)
Gets the intensity step index.
k64f GoSetup_YDecimationWindowLimitMax(GoSetup setup)
Gets the y-direction decimation window maximum.
Represents the system's primary synchronization domain.
kBool GoSetup_SpacingIntervalTypeUsed(GoSetup setup, GoRole role)
Gets the system value representing whether or not the user specified spacing interval type setting is...
k64f GoSetup_ExposureStepAt(GoSetup setup, GoRole role, kSize index)
Get the exposure step value specified by index.
Represents an encoder's triggering behavior.
k64f GoSetup_TriggerDelayLimitMin(GoSetup setup)
Reports the minimum trigger delay, based on current settings.
Corner parameters for polygon corner alignment.
Definition: GoSdkDef.h:590
k64f GoSetup_BackCameraExposureLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the back camera exposure setting.
kStatus GoSetup_SetReversalDistance(GoSetup setup, k64f threshold)
This API is experimental and may change in a future release Sets the encoder reversal distance thresh...
kStatus GoSetup_SetActiveAreaZ(GoSetup setup, GoRole role, k64f value)
Sets the active area z origin.
kStatus GoSetup_SetTriggerBurstCount(GoSetup setup, k32u count)
This API is experimental and may change in a future release Sets the trigger burst count...
Represents an alignment target type.
k64f GoSetup_FrontCameraExposure(GoSetup setup, GoRole role)
Gets the front camera exposure value.
GoAlignmentDegreesOfFreedom GoSetup_BarDegreesOfFreedom(GoSetup setup)
Gets the degrees of freedom used for bar alignment calibration.
kBool GoSetup_LayoutMultiplexingBankUsed(GoSetup setup, GoRole role)
Gets Multiplexing bank used state in n-buddy system.
Represents all possible exposure modes.
GoTrigger GoSetup_TriggerSource(GoSetup setup)
Gets the trigger source for profile triggering.
k64f GoSetup_YSmoothingWindowLimitMax(GoSetup setup)
Gets the y-direction smoothing window maximum.
kStatus GoSetup_SetPatternSequenceType(GoSetup setup, GoRole role, GoPatternSequenceType type)
Sets the pattern sequence type.
kStatus GoSetup_ClearExposureSteps(GoSetup setup, GoRole role)
Removes all exposure steps.
kStatus GoSetup_SetTriggerDelay(GoSetup setup, k64f delay)
Sets the trigger delay.
Declares the GoSurfaceGeneration class.
Declares the GoProfileGeneration class.
Represents a pattern sequence type.
k64f GoSetup_XMedianWindowLimitMin(GoSetup setup)
Gets the x-direction median window minimum.
k64f GoSetup_PlateHeight(GoSetup setup)
Gets the height of the plate used for travel calibration.
k64f GoSetup_XGapFillingWindowLimitMin(GoSetup setup)
Gets the x-direction gap-filling window minimum.
k64f GoSetup_ExposureLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the Exposure setting.
kStatus GoSetup_SetLayoutMultiplexingBank(GoSetup setup, GoRole role, k32u value)
Sets multiplexing bank value being configured (may not be applicable or used) on device in n-buddy sy...
kStatus GoSetup_SetSpacingInterval(GoSetup setup, GoRole role, k64f value)
Sets the spacing interval.
kStatus GoSetup_SetXMedianWindow(GoSetup setup, k64f window)
Sets the x-direction median window.
k64f GoSetup_YSlopeWindowLimitMax(GoSetup setup)
Gets the y-direction slope window maximum.
kStatus GoSetup_SetPlateHeight(GoSetup setup, k64f height)
Sets the height of the plate used for travel calibration.
kStatus GoSetup_SetLaserSleepModeEnabled(GoSetup setup, kBool enable)
This API is experimental and may change in a future release Enables laser sleep mode.
k64f GoSetup_TriggerDelayLimitMax(GoSetup setup)
Reports the maximum trigger delay, based on current settings.
kBool GoSetup_XSmoothingEnabled(GoSetup setup)
Gets the status of x-direction smoothing.
kBool GoSetup_PatternSequenceTypeUsed(GoSetup setup, GoRole role)
Returns a boolean value representing whether the pattern sequence type is used.
GoExposureMode GoSetup_ExposureModeOptionAt(GoSetup setup, GoRole role, kSize index)
Gets the exposure mode option at the given index.
kStatus GoSetup_SetBarWidth(GoSetup setup, k64f width)
Sets the width of the bar used for travel calibration.
kStatus GoSetup_SetOcclusionReductionAlg(GoSetup setup, GoOcclusionReductionAlg alg)
Sets the occlusion reduction algorithm.
k32u GoSetup_BackCameraWidth(GoSetup setup, GoRole role)
Gets the camera region-of-interest width.
k64f GoSetup_PlateRefHoleDiameter(GoSetup setup)
Gets the diameter of the reference hole defined on the calibration plate.
k64f GoSetup_DynamicExposureMax(GoSetup setup, GoRole role)
Gets the maximum value for the Dynamic Exposure setting.
Represents spacing interval types.
kSize GoSetup_ExposureStepCount(GoSetup setup, GoRole role)
Get the number of exposure steps defined.
kStatus GoSetup_EnableInputTrigger(GoSetup setup, kBool enable)
Sets the input trigger enabled state.
k32u GoSetup_LayoutMultiplexingBankSystemValue(GoSetup setup, GoRole role)
Gets Multiplex bank system value being used on device in n-buddy system.
kBool GoSetup_ReversalDistanceUsed(GoSetup setup)
This API is experimental and may change in a future release Gets the encoder reversal distance thresh...
k64f GoSetup_DynamicExposureMin(GoSetup setup, GoRole role)
Gets the minimum value for the Dynamic Exposure setting.
Represents an alignment type.
kBool GoSetup_MaxFrameRateEnabled(GoSetup setup)
Reports whether or not system is configured to operate at full frame rate.
GoPatternSequenceType GoSetup_PatternSequenceType(GoSetup setup, GoRole role)
Gets the pattern sequence type.
#define kDeprecate(SYMBOL)
kStatus GoSetup_EnableYGapFilling(GoSetup setup, kBool enable)
Sets the status of y-direction gap-filling.
GoAlignmentDegreesOfFreedom GoSetup_BarDegreesOfFreedomOptionAt(GoSetup setup, kSize index)
Gets the bar alignment degrees of freedom option at the given index.
kBool GoSetup_LayoutGridDirection(GoSetup setup, GoRole role)
Gets layout grid direction being configured (may not be applicable or used) on device in n-buddy syst...
k64f GoSetup_EncoderSpacing(GoSetup setup)
Gets the current encoder period for encoder-based triggering.
kBool GoSetup_YDecimationUsed(GoSetup setup)
Indicates whether y decimation can be used for the current scan mode and device family.
k64f GoSetup_YSlopeWindow(GoSetup setup)
Gets the y-direction slope window.
kStatus GoSetup_SetExternalInputZPulseIndex(GoSetup setup, k32u index)
Sets the external input index for triggering encoder Z-pulse.
kStatus GoSetup_SetIntensitySource(GoSetup setup, GoRole role, GoIntensitySource source)
Sets the source to be used for generating intensity data.
kSize GoSetup_ExposureModeOptionCount(GoSetup setup, GoRole role)
Gets the exposure mode option count.
k64f GoSetup_ActiveAreaHeight(GoSetup setup, GoRole role)
Gets the active area height.
kStatus GoSetup_EnableOcclusionReduction(GoSetup setup, kBool enable)
Sets the occlusion reduction enabled state.
k64f GoSetup_TransformedDataRegionY(GoSetup setup, GoRole role)
Gets the transformed data region Y value.
Represents an occlusion reduction algorithm.
GoExposureMode GoSetup_ExposureMode(GoSetup setup, GoRole role)
Gets the exposure mode.
kStatus GoSetup_SetYSmoothingWindow(GoSetup setup, k64f window)
Sets the y-direction smoothing window.
Represents the part matching parameters of the surface mode configuration.
kStatus GoSetup_SetLayoutGridDirection(GoSetup setup, GoRole role, kBool value)
Sets grid direction being configured (may not be applicable or used) on device in n-buddy system...
k64f GoSetup_TransformedDataRegionHeight(GoSetup setup, GoRole role)
Gets the transformed data region height value.
kBool GoSetup_TriggerBurstEnabledUsed(GoSetup setup)
This API is experimental and may change in a future release Gets the trigger burst enabled state...
kBool GoSetup_LayoutGridDirectionSystemValue(GoSetup setup, GoRole role)
Gets layout grid direction system value being used on device in n-buddy system.
kStatus GoSetup_EnableXMedian(GoSetup setup, kBool enabled)
Sets the status of x-direction median.
k64f GoSetup_XSlopeWindowLimitMin(GoSetup setup)
Gets the x-direction slope window minimum.
k64u GoSetup_LaserWakeupEncoderTravel(GoSetup setup)
This API is experimental and may change in a future release Gets the encoder wakeup travel distance...
k64f GoSetup_FrontCameraExposureLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the front camara exposure setting.
k32u GoSetup_XSubsamplingOptionAt(GoSetup setup, GoRole role, kSize index)
Gets the x-resolution option at the specified index.
kStatus GoSetup_SetIntensityStepIndex(GoSetup setup, GoRole role, kSize index)
Sets the intensity step index.
k64f GoSetup_ActiveAreaZLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaZ setting.
k64f GoSetup_SpacingIntervalLimitMax(GoSetup setup, GoRole role)
Gets the spacing interval value limit maximum.
k64f GoSetup_ActiveAreaWidthLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaWidth setting.
kStatus GoSetup_AddPolygonCorner(GoSetup setup, GoPolygonCornerParameters *corner)
Adds a corner parameters object to the collection of polygon corners for alignment.
k64f GoSetup_ActiveAreaYLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaY setting.
kStatus GoSetup_EnableXGapFilling(GoSetup setup, kBool enable)
Sets the status of x-direction gap-filling.
kBool GoSetup_YGapFillingUsed(GoSetup setup)
Indicates whether Y gap filling can be used for the current scan mode and device family.
kStatus GoSetup_SetDynamicExposureMin(GoSetup setup, GoRole role, k64f exposure)
Sets the minimum value for the Dynamic Exposure setting.
kStatus GoSetup_SetActiveAreaHeight(GoSetup setup, GoRole role, k64f value)
Sets the active area height.
kStatus GoSetup_EnableYSlope(GoSetup setup, kBool enable)
Sets the status of y-direction slope.
GoProfileGeneration GoSetup_ProfileGeneration(GoSetup setup)
Gets the profile generation module, used for profile generation configuration.
GoAlignmentTarget GoSetup_TriggerSourceOptionAt(GoSetup setup, kSize index)
Gets the trigger source option at the given index.
k64f GoSetup_XSlopeWindow(GoSetup setup)
Gets the x-direction slope window.
kStatus GoSetup_SetFrontCameraExposure(GoSetup setup, GoRole role, k64f exposure)
Sets the front camera exposure value.
kStatus GoSetup_SetEncoderTriggerMode(GoSetup setup, GoEncoderTriggerMode mode)
Sets the encoder trigger mode.
kBool GoSetup_SpacingIntervalUsed(GoSetup setup, GoRole role)
Returns the state of whether the user specified spacing interval is used.
kBool GoSetup_OcclusionReductionEnabledSystemValue(GoSetup setup)
Gets the occlusion reduction system value.
kStatus GoSetup_EnableXSlope(GoSetup setup, kBool enable)
Sets the status of x-direction slope.
kBool GoSetup_ExternalInputZPulseIndexAvailable(GoSetup setup)
Reports whether or not the external input index for encoder z-pulse triggering is used...
k64f GoSetup_XDecimationWindow(GoSetup setup)
Gets the x-direction decimation window.
k32u GoSetup_PatternSequenceIndexMax(GoSetup setup, GoRole role)
Gets the current phase pattern index maximum value (inclusive).
kStatus GoSetup_SetXGapFillingWindow(GoSetup setup, k64f window)
Sets the status of x-direction gap-filling.
GoMode GoSetup_ScanMode(GoSetup setup)
Gets the scan mode.
kBool GoSetup_LayoutGridUsed(GoSetup setup, GoRole role)
Gets layout grid used state.
k64f GoSetup_XDecimationWindowLimitMax(GoSetup setup)
Gets the x-direction decimation window maximum.
kBool GoSetup_FlickerFreeModeAvailable(GoSetup setup)
Reports whether flicker free mode is available for use on this sensor.
k64f GoSetup_ExposureLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the Exposure setting.
kBool GoSetup_XMedianEnabled(GoSetup setup)
Gets the status of x-direction median.
kStatus GoSetup_SetBarHoleDiameter(GoSetup setup, k64f diameter)
Sets the diameter of holes that are defined on the calibration bar.
k64f GoSetup_TrackingAreaHeightLimitMax(GoSetup setup, GoRole role)
Gets the tracking window height maximum limit.
k32u GoSetup_FrontCameraHeight(GoSetup setup, GoRole role)
Gets the camera region-of-interest height.
kStatus GoSetup_SetDiskHeight(GoSetup setup, k64f height)
Sets the height of the disk used for travel calibration.
kStatus GoSetup_SetXSmoothingWindow(GoSetup setup, k64f window)
Sets the x-direction smoothing window.
k32u GoSetup_XSubsampling(GoSetup setup, GoRole role)
Gets the current x-resolution divider.
kStatus GoSetup_EnableIndependentExposures(GoSetup setup, GoRole role, kBool enable)
Enables independent exposures feature, i.e.
kStatus GoSetup_SetTriggerUnit(GoSetup setup, GoTriggerUnits unit)
Sets the system trigger units.
k64f GoSetup_YGapFillingWindowLimitMin(GoSetup setup)
Gets the y-direction gap-filling window minimum.
kBool GoSetup_PreferMasterTimeEncoderEnabled(GoSetup setup)
Gets whether the time and encoder values are preferred to come from the Master rather than from the s...
k64f GoSetup_YDecimationWindowLimitMin(GoSetup setup)
Gets the y-direction decimation window minimum.
k64f GoSetup_BarHoleDiameter(GoSetup setup)
Gets the diameter of holes that are defined on the calibration bar.
Represents a device configuration.
GoPolygonCornerParameters * GoSetup_PolygonCornerAt(GoSetup setup, kSize index)
Retrieves the reference to the corner parameters object from the collection of polygon corners...
Declares the GoPartMatching class.
k64f GoSetup_BackCameraExposureLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the back camara exposure setting.
kStatus GoSetup_SetDiskDiameter(GoSetup setup, k64f diameter)
Sets the diameter of the disk used for travel calibration.
kStatus GoSetup_SetYMedianWindow(GoSetup setup, k64f window)
Sets the y-direction median window.
kBool GoSetup_XMedianUsed(GoSetup setup)
Indicates whether X median can be used for the current scan mode and device family.
kStatus GoSetup_EnableYDecimation(GoSetup setup, kBool enable)
Sets the status of y-direction decimation.
Declares the GoMaterial class.
GoAlignmentType GoSetup_AlignmentTypeOptionAt(GoSetup setup, kSize index)
Gets the alignment type option at the given index.
kStatus GoSetup_SetIntensityMode(GoSetup setup, GoRole role, GoIntensityMode mode)
Sets the intensity data generation mode.
kBool GoSetup_BarHoleDistanceUsed(GoSetup setup)
Indicates if the hole distance can be modified by the user.
kBool GoSetup_TrackingEnabled(GoSetup setup, GoRole role)
Determines if tracking is enabled.
kBool GoSetup_AlignmentEncoderCalibrateEnabled(GoSetup setup)
Gets the value of the post alignment encoder calibration setting.
k64f GoSetup_YSmoothingWindowLimitMin(GoSetup setup)
Gets the y-direction smoothing window minimum.
Represents the collection of sections and limits for defining them.
kStatus GoSetup_SetXSubsampling(GoSetup setup, GoRole role, k32u xSubsampling)
Sets the current x-resolution divider.
Declares the GoLayout class.
kStatus GoSetup_SetYDecimationWindow(GoSetup setup, k64f window)
Sets the y-direction decimation window.
Declares the GoAdvanced class.
k64f GoSetup_ActiveAreaLength(GoSetup setup, GoRole role)
Gets the active area Length.
k64f GoSetup_XDecimationWindowLimitMin(GoSetup setup)
Gets the x-direction decimation window minimum.
kStatus GoSetup_SetXSlopeWindow(GoSetup setup, k64f window)
Sets the status of x-direction slope.
k32u GoSetup_PatternSequenceIndex(GoSetup setup, GoRole role)
Gets the current phase pattern index.
kStatus GoSetup_SetPlateSecHoleDiameter(GoSetup setup, k64f diameter)
Sets the diameter of the secondary hole defined on the calibration plate.
k64f GoSetup_EncoderSpacingLimitMax(GoSetup setup)
Constraint for the maximum valid value of the Encoder Period setting.
kSize GoSetup_BarDegreesOfFreedomOptionCount(GoSetup setup)
Gets the degrees of freedom bar alignment target option count.
GoPartDetection GoSetup_PartDetection(GoSetup setup)
Gets the part detection module, used for part detection configuration.
k64f GoSetup_ActiveAreaX(GoSetup setup, GoRole role)
Gets the active area x origin.