ViDi Results Vision Data Access Functions
This topic lists the Vision Data Access Functions associated with the results that may be output by a ViDi, ViDiCheck, ViDiDetect or ViDiRead function.
Blue Locate Tool Results
These are results that can be accessed when a ViDi function which contains a ViDi Blue Locate tool.
Function | Description |
---|---|
GetViDiLocateResult(ViDi, ToolName) |
Returns a ViDiLocateResult data structure, which contains results from the referenced Blue Locate tool within the specified ViDi data structure. |
GetViDiLocateView(ViDiLocateResult, View_Index) |
Returns a ViDiLocateView data structure, which extracts the results from a single view. |
GetScale(ViDiLocateView, Match_Index) |
Returns the scale of the specified match. |
Blue Read Tool Results
These are results that can be accessed when a ViDiRead function, which contains the ViDi Blue Read tool.
Function | Description |
---|---|
GetViDiReadResult(ViDi or ViDiRead, ToolName) |
Returns a ViDiReadResult data structure, which contains results from the referenced Blue Read tool within the specified ViDi or ViDiRead data structure. |
GetViDiReadView(ViDiReadResult, View_Index) |
Returns a ViDiReadView data structure, which extracts the results from a single view. |
Red Analyze Tool Results
These are results that can be accessed when a ViDi function which contains a Red Analyze tool.
Function | Description |
---|---|
GetViDiAnalyzeResult(ViDi, ToolName) |
Returns a ViDiAnalyzeResult data structure, which contains results from the referenced Red Analyze tool within the specified ViDi data structure. |
GetViDiAnalyzeView(ViDiAnalyzeResult, View_Index) |
Returns a ViDiAnalyzeView data structure, which extracts the results from a single view. |
GetScore(ViDiAnalyzeView,[Region_Index]) |
Returns the result score of the referenced ViDiAnalyzeView data structure. Optionally, a region index can be specified to retrieve the score of individual regions. |
GetLowerThreshold(ViDiAnalyzeView) |
Returns the lower threshold value being used by the Red Analyze tool that output the referenced ViDiAnalyzeView data structure. |
GetUpperTheshold(ViDiAnalyzeView) |
Returns the upper threshold value being used by the Red Analyze tool that output the referenced ViDiAnalyzeView data structure. |
GetPassed(ViDiAnalyzeView) |
Returns the pass/fail value (1 = Pass; 0 = Fail) output by the referenced ViDiAnalyzeView data structure. |
GetRegionCount(ViDiAnalyzeView) |
Returns the number of regions generated by the referenced ViDiAnalyzeView data structure. |
GetArea(ViDiAnalyzeView, Region_Index) |
Returns the area (in pixels) of referenced region contained within the referenced ViDiAnalyzeView data structure. |
GetPerimeter(ViDiAnalyzeView, Region_Index) |
Returns the perimeter (in pixels) of referenced region contained within the referenced ViDiAnalyzeView data structure. |
Green Classify Tool Results
These are results that can be accessed when a ViDi function which contains a Green Classify tool.
Function | Description |
---|---|
GetViDiClassifyResult(ViDi, ToolName) |
Returns a ViDiClassifyResult data structure, which contains results from the referenced Green Classify tool within the specified ViDi data structure. |
GetViDiClassifyView(ViDiClassifyResult, View_Index) |
Returns a ViDiClassifyView data structure, which extracts the results from a single view. |
GetBestTagName(ViDiClassifyView) |
Returns the name of the tag with the highest score within the referenced ViDiClassifyView data structure. |
GetBestTagScore(ViDiClassifyView) |
Returns the score of the tag with the highest score within the referenced ViDiClassifyView data structure. |
GetTagCount(ViDiClassifyView) |
Returns the number of tags generated by the referenced ViDiClassifyView data structure. |
GetTagName(ViDiClassifyView, Tag_Index) |
Returns the name of the indexed tag contained within the referenced ViDiClassifyView data structure. |
GetTagScore(ViDiClassifyView, Tag_Index) |
Returns the score of the indexed tag contained within the referenced ViDiClassifyView data structure. |
GetTagList(ViDiClassifyView) |
Returns a comma separated list of all matched tag names within the referenced ViDiClassifyView data structure. |
Shared ViDi Tool Results
These are results that can be accessed when a ViDi function contains a Blue Locate, Blue Read and/or Red Analyze tool.
Function | Description |
---|---|
GetViDiFeature(ViDiLocateView or ViDiLocateMatch or ViDiReadView, Feature_Index) |
Returns a ViDiFeature data structure, which extracts the feature data from the referenced view. |
GetViDiMatch(ViDiLocateView, ViDiReadView or ViDiCheckView, Match_Index) |
Returns a ViDiMatch data structure, which extracts the matched model from the referenced view. |
GetViewCount(Any ViDi result data structure) |
Returns the number of views generated by the referenced ViDi, ViDiCheck, ViDiDetect or ViDiRead data structure. |
GetMatchCount(ViDiLocateView, ViDiCheckView or ViDiReadView) |
Returns the number of matches generated by the referenced ViDiLocateView, ViDiCheckView or ViDiReadView data structure. |
GetFeatureCount(ViDiLocateView or ViDiReadView) |
Returns the number of features generated by the referenced ViDiLocateView or ViDiReadView data structure. |
GetX(ViDiLocateView, Match_Index ;or ViDiFeature; or ViDiMatch; or ViDiReadView; or ViDiAnalyzeView) |
When specifying ViDiLocateView, ViDiFeature, or ViDiReadView, returns the X location of the match. When specifying ViDiAnalyzeView, returns the center X location of the region. |
GetY(ViDiLocateView, Match_Index ;or ViDiFeature; or ViDiMatch; or ViDiReadView; or ViDiAnalyzeView) |
When specifying ViDiLocateView, ViDiFeature, or ViDiReadView, returns the Y location of the match. When specifying ViDiAnalyzeView, returns the center Y location of the region. |
GetAngle(ViDiLocateView, Match_Index ;or ViDiFeature; or ViDiMatch) |
Returns the angle of the specified match generated by the referenced ViDiLocateView, ViDiFeature or ViDiMatch data structure. |
GetScore(ViDiAnalyzeView, Region_Index; or ViDiFeature; or ViDiMatch) |
Returns the score of the specified region by the referenced ViDiAnalyzeView structure, or the score associated with the ViDiFeature or ViDiMatch data structure output by a Blue Locate or Blue Read tool. |
GetString(ViDiLocateView, Match_Index ;or ViDiFeature; or ViDiMatch; or ViDiReadView) |
Returns a string generated by the referenced ViDiLocateView, ViDiFeature, ViDiMatch or ViDiReadView data structure. |