|
FireSync API
|
Represents configuration for the SOBELW_ARCGDW algorithm, which provides row-wise spot detection using a 1D sobel filter.
Algorithm configuration options can be modified to emit results from different stages of the processing pipeline: centroids (aka 'spots'), calibrated 2D ranges, or resampled 1D ranges. Access to earlier processing stages is provided both for diagnostic/testing purposes and to support applications that require access to data from prior processing stages. However, only one type of result can be emitted at a time.
If range output is disabled, the algorithm will emit centroids (spots). One kMsg will be generated for each camera frame and each kMsg will contain one kArrayList<kFpgaWideSpot>. If spot sorting is disabled, the complete list of unsorted spots (up to the configured maximum number of spots) will be delivered. In this case, the size of the delivered spot list is governed by the MaxFound property. If spot sorting is enabled, then the spot list will be reduced to one spot per row using to the configured spot sorting criteria. In this case, the size of the spot list is governed by the width of the source image.
If range output is enabled, the algorithm will convert spots to calibrated range values. (Range calibration tables must be provided via the kCamera WriteRangeLut method). In this case, the algorithm will produce kProfileMsg objects, where each kProfileMsg contains results from one or more camera frames. If range resampling is disabled, the algorithm will emit kProfileMsg<kPoint16s> objects, where each element represents a 2D range value. If range resampling is enabled, the algorithm will emit kProfileMsg<k16s> objects, where each element represents a 1D range value that has been resampled to a uniform spacing along the field of view. Range processing options can be configured via methods inherited from the kAcgInfo base class. The maximum number of frames included in a single kProfileMsg can be limited via the kCameraState MaxBatchSize property.
Public Member Functions | |
| kStatus | kSobelwArcgdwInfo_Construct (kSobelwArcgdwInfo *info, kCameraCapability capabilities, k32u plConfig, kVersion plVersion, kAlloc allocator) |
| Constructs a kSobelwArcgdwInfo object. More... | |
EdgeWindow | |
| kStatus | kSobelwArcgdwInfo_SetEdgeWindow (kSobelwArcgdwInfo info, k32u edgeWindow, kAdjust adjustment=kADJUST_NONE) |
| Sets the sobel edge window size. More... | |
| k32u | kSobelwArcgdwInfo_EdgeWindow (kSobelwArcgdwInfo info) |
| Gets the sobel edge window size. More... | |
| kStatus | kSobelwArcgdwInfo_EdgeWindowInfo (kSobelwArcgdwInfo info, kInfo32u *info32u) |
| Reports constraint and validity information for the EdgeWindow setting. More... | |
EdgeThreshold | |
| kStatus | kSobelwArcgdwInfo_SetEdgeThreshold (kSobelwArcgdwInfo info, k32u threshold, kAdjust adjustment=kADJUST_NONE) |
| Sets the sobel filter threshold used to detect spot edges. More... | |
| k32u | kSobelwArcgdwInfo_EdgeThreshold (kSobelwArcgdwInfo info) |
| Gets the sobel filter threshold used to detect spot edges. More... | |
| kStatus | kSobelwArcgdwInfo_EdgeThresholdInfo (kSobelwArcgdwInfo info, kInfo32u *info32u) |
| Reports constraint and validity information for the EdgeThreshold setting. More... | |
MinWidth | |
| kStatus | kSobelwArcgdwInfo_SetMinWidth (kSobelwArcgdwInfo info, k32u minWidth, kAdjust adjustment=kADJUST_NONE) |
| Sets the minimum spot width threshold. More... | |
| k32u | kSobelwArcgdwInfo_MinWidth (kSobelwArcgdwInfo info) |
| Gets the minimum spot width threshold. More... | |
| kStatus | kSobelwArcgdwInfo_MinWidthInfo (kSobelwArcgdwInfo info, kInfo32u *info32u) |
| Reports constraint and validity information for the MinWidth setting. More... | |
MaxWidth | |
| kStatus | kSobelwArcgdwInfo_SetMaxWidth (kSobelwArcgdwInfo info, k32u maxWidth, kAdjust adjustment=kADJUST_NONE) |
| Sets the maximum spot width threshold. More... | |
| k32u | kSobelwArcgdwInfo_MaxWidth (kSobelwArcgdwInfo info) |
| Gets the maximum spot width threshold. More... | |
| kStatus | kSobelwArcgdwInfo_MaxWidthInfo (kSobelwArcgdwInfo info, kInfo32u *info32u) |
| Reports constraint and validity information for the MaxWidth setting. More... | |
MinSum | |
| kStatus | kSobelwArcgdwInfo_SetMinSum (kSobelwArcgdwInfo info, k32u minSum, kAdjust adjustment=kADJUST_NONE) |
| Sets the minimum spot sum threshold. More... | |
| k32u | kSobelwArcgdwInfo_MinSum (kSobelwArcgdwInfo info) |
| Gets the minimum spot sum threshold. More... | |
| kStatus | kSobelwArcgdwInfo_MinSumInfo (kSobelwArcgdwInfo info, kInfo32u *info32u) |
| Reports constraint and validity information for the MinSum setting. More... | |
MaxFound | |
| kStatus | kSobelwArcgdwInfo_SetMaxFound (kSobelwArcgdwInfo info, k32u maxFound, kAdjust adjustment=kADJUST_NONE) |
| Sets the maximum number of spots that can be detected. More... | |
| k32u | kSobelwArcgdwInfo_MaxFound (kSobelwArcgdwInfo info) |
| Gets the maximum number of spots that can be detected. More... | |
| kStatus | kSobelwArcgdwInfo_MaxFoundInfo (kSobelwArcgdwInfo info, kInfo32u *info32u) |
| Reports constraint and validity information for the MaxFound setting. More... | |
SpotSortEnabled | |
| kStatus | kSobelwArcgdwInfo_EnableSpotSort (kAccgd2kInfo info, kBool enabled) |
| Enables or disables spot sorting. More... | |
| kBool | kSobelwArcgdwInfo_SpotSortEnabled (kAccgd2kInfo info) |
| Reports whether spot sorting is enabled. More... | |
| kStatus | kSobelwArcgdwInfo_SpotSortEnabledInfo (kAccgd2kInfo info, kInfoBool *infoBool) |
| Reports constraint and validity information for the EnableSpotSort setting. More... | |
SpotSortInverted | |
| kStatus | kSobelwArcgdwInfo_InvertSpotSort (kSobelwArcgdwInfo info, kBool invert) |
| Enables or disables reverse spot order. More... | |
| kBool | kSobelwArcgdwInfo_SpotSortInverted (kSobelwArcgdwInfo info) |
| Reports whether spot sorting order is reversed. More... | |
| kStatus | kSobelwArcgdwInfo_InvertSpotSortInfo (kSobelwArcgdwInfo info, kInfoBool *infoBool) |
| Reports constraint and validity information for the SpotSortInverted setting. More... | |
SpotSortType | |
| kStatus | kSobelwArcgdwInfo_SetSpotSortType (kSobelwArcgdwInfo info, kCameraSpotSort type) |
| Sets the spot sorting methodology. More... | |
| kCameraSpotSort | kSobelwArcgdwInfo_SpotSortType (kSobelwArcgdwInfo info) |
| Gets the spot sorting methodology. More... | |
| kStatus | kSobelwArcgdwInfo_SpotSortTypeInfo (kSobelwArcgdwInfo info, kInfo32u *info32u) |
| Reports constraint and validity information for the SpotSortType setting. More... | |
 Public Member Functions inherited from kAcgInfo | |
| kSize | kAcgInfo_CgScale (kAcgInfo info) |
| Reports the spot metadata scale factor. More... | |
| kBool | kAcgInfo_IsRowBased (kAcgInfo info) |
| Reports whether the algorithm is row-based. More... | |
| kStatus | kAcgInfo_EnableRanges (kAcgInfo info, kBool enabled) |
| Specifies whether range lookup is enabled. More... | |
| kBool | kAcgInfo_RangesEnabled (kAcgInfo info) |
| Reports whether range lookup is enabled. More... | |
| kStatus | kAcgInfo_RangesEnabledInfo (kAcgInfo info, kInfoBool *infoBool) |
| Reports constraint and validity information for the EnableRanges setting. More... | |
| kStatus | kAcgInfo_EnableRangeSlices (kAcgInfo info, kBool enabled) |
| Specifies whether range slice (index) information is enabled. More... | |
| kBool | kAcgInfo_RangeSlicesEnabled (kAcgInfo info) |
| Reports whether range slice (index) information is enabled. More... | |
| kStatus | kAcgInfo_RangeSlicesEnabledInfo (kAcgInfo info, kInfoBool *infoBool) |
| Reports constraint and validity information for the EnableRangeSlices setting. More... | |
| kStatus | kAcgInfo_EnableResample (kAcgInfo info, kBool enabled) |
| Specifies whether range resampling is enabled. More... | |
| kBool | kAcgInfo_ResampleEnabled (kAcgInfo info) |
| Reports whether range resampling is enabled. More... | |
| kStatus | kAcgInfo_ResampleEnabledInfo (kAcgInfo info, kInfoBool *infoBool) |
| Reports constraint and validity information for the EnableResample setting. More... | |
| kStatus | kAcgInfo_SetResamplePreferHigh (kAcgInfo info, kBool preferHigh) |
| Specifies whether higher or lower ranges are selected when there are multiple choices. More... | |
| kBool | kAcgInfo_ResamplePreferHigh (kAcgInfo info) |
| Reports whether higher or lower ranges are selected when there are multiple choices. More... | |
| kStatus | kAcgInfo_ResamplePreferHighInfo (kAcgInfo info, kInfoBool *infoBool) |
| Reports constraint and validity information for the ResamplePreferHigh setting. More... | |
| kStatus | kAcgInfo_SetResampleBegin (kAcgInfo info, k32s begin, kAdjust adjustment=kADJUST_NONE) |
| Specifies the initial (left-most) position for x-resampling. More... | |
| k32s | kAcgInfo_ResampleBegin (kAcgInfo info) |
| Reports the initial (left-most) position for x-resampling. More... | |
| kStatus | kAcgInfo_ResampleBeginInfo (kAcgInfo info, kInfo32s *info32s) |
| Reports constraint and validity information for the ResampleBegin setting. More... | |
| kStatus | kAcgInfo_SetResampleCount (kAcgInfo info, k32u count, kAdjust adjustment=kADJUST_NONE) |
| Specifies the total number of x-resampling points. More... | |
| k32u | kAcgInfo_ResampleCount (kAcgInfo info) |
| Reports the total number of x-resampling points. More... | |
| kStatus | kAcgInfo_ResampleCountInfo (kAcgInfo info, kInfo32u *info32u) |
| Reports constraint and validity information for the ResampleCount setting. More... | |
| kStatus | kAcgInfo_SetResampleStep (kAcgInfo info, k32u step, kAdjust adjustment=kADJUST_NONE) |
| Specifies the distance in the x-axis between resampled points. More... | |
| k32u | kAcgInfo_ResampleStep (kAcgInfo info) |
| Reports the distance in the x-axis between resampled points. More... | |
| kStatus | kAcgInfo_ResampleStepInfo (kAcgInfo info, kInfo32u *info32u) |
| Reports constraint and validity information for the ResampleStep setting. More... | |
| kStatus | kAcgInfo_SetResampleStepThreshold (kAcgInfo info, k32u threshold, kAdjust adjustment=kADJUST_NONE) |
| Specifies the maximum distance over which to interpolate between input points when resampling. More... | |
| k32u | kAcgInfo_ResampleStepThreshold (kAcgInfo info) |
| Reports the maximum distance over which to interpolate between input points when resampling. More... | |
| kStatus | kAcgInfo_ResampleStepThresholdInfo (kAcgInfo info, kInfo32u *info32u) |
| Reports constraint and validity information for the ResampleStepThreshold setting. More... | |
| kStatus | kAcgInfo_SetResampleZMin (kAcgInfo info, k32s min, kAdjust adjustment=kADJUST_NONE) |
| Specifies the minimum z threshold for resampled points. More... | |
| k32s | kAcgInfo_ResampleZMin (kAcgInfo info) |
| Reports the minimum z threshold for resampled points. More... | |
| kStatus | kAcgInfo_ResampleZMinInfo (kAcgInfo info, kInfo32s *info32s) |
| Reports constraint and validity information for the ResampleZMin setting. More... | |
| kStatus | kAcgInfo_SetResampleZMax (kAcgInfo info, k32s max, kAdjust adjustment=kADJUST_NONE) |
| Specifies the maximum z threshold for resampled points. More... | |
| k32s | kAcgInfo_ResampleZMax (kAcgInfo info) |
| Reports the maximum z threshold for resampled points. More... | |
| kStatus | kAcgInfo_ResampleZMaxInfo (kAcgInfo info, kInfo32s *info32s) |
| Reports constraint and validity information for the ResampleZMax setting. More... | |
| Public Member Functions inherited from kAlgInfo | |
| kStatus | kAlgInfo_Export (kAlgInfo info, kXml xml, kXml item) |
| Exports settings from an algorithm info object to the given XML object. More... | |
| kStatus | kAlgInfo_Import (kAlgInfo info, kXml xml, kXml item) |
| Imports settings to an existing algorithm info object based on the given XML content. More... | |
