Vision service API

import (
  "go.viam.com/rdk/services/vision"
)

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• cameraName (string): The name of the camera from which to get an image to run detections on.
• extra (map[string]interface{}): Extra options to pass to the underlying RPC call.

Returns:

• ([]objectdetection.Detection): A list of bounding boxes around the detected objects, and confidence scores of those detections.
• (error): An error, if one occurred.

Example:

myDetectorService, err := vision.FromRobot(machine, "my_detector")
if err != nil {
  logger.Error(err)
  return
}

// Get detections from the camera output
detections, err := myDetectorService.DetectionsFromCamera(context.Background(), "my_camera", nil)
if err != nil {
  logger.Fatalf("Could not get detections: %v", err)
}
if len(detections) > 0 {
  logger.Info(detections[0])
}

For more information, see the Go SDK Docs.

Parameters:

• cameraName String (required)
• extra Map<String, dynamic>? (optional)

Returns:

• Future<List<Detection>>

Example:

// Example:
var detections = await myVisionService.detectionsFromCamera('myWebcam');

For more information, see the Flutter SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• img (image.Image): The image in which to look for detections.
• extra (map[string]interface{}): Extra options to pass to the underlying RPC call.

Returns:

• ([]objectdetection.Detection): A list of 2D bounding boxes around the detected objects, and confidence scores of those detections.
• (error): An error, if one occurred.

Example:

myCam, err := camera.FromRobot(machine, "my_camera")
if err != nil {
  logger.Error(err)
  return
}
// Get the stream from a camera
camStream, err := myCam.Stream(context.Background())
// Get an image from the camera stream
img, release, err := camStream.Next(context.Background())
defer release()

myDetectorService, err := vision.FromRobot(machine, "my_detector")
if err != nil {
  logger.Error(err)
  return
}
// Get the detections from the image
detections, err := myDetectorService.Detections(context.Background(), img, nil)
if err != nil {
  logger.Fatalf("Could not get detections: %v", err)
}
if len(detections) > 0 {
  logger.Info(detections[0])
}

For more information, see the Go SDK Docs.

Parameters:

• image ViamImage (required)
• extra Map<String, dynamic>? (optional)

Returns:

• Future<List<Detection>>

Example:

// Example:
var latestImage = await myWebcam.image();
var detections = await myVisionService.detections(latestImage);

For more information, see the Flutter SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• cameraName (string): The name of the camera from which to get an image to run the classifier on.
• n (int): The number of classifications to return. For example, if you specify 3 you will get the top three classifications with the greatest confidence scores.
• extra (map[string]interface{}): Extra options to pass to the underlying RPC call.

Returns:

• (classification.Classifications): A list of classification labels, and the confidence scores of those classifications.
• (error): An error, if one occurred.

Example:

myClassifierService, err := vision.FromRobot(machine, "my_classifier")
if err != nil {
  logger.Error(err)
  return
}
// Get the 2 classifications with the highest confidence scores from the camera output
classifications, err := myClassifierService.ClassificationsFromCamera(context.Background(), "my_camera", 2, nil)
if err != nil {
  logger.Fatalf("Could not get classifications: %v", err)
}
if len(classifications) > 0 {
  logger.Info(classifications[0])
}

For more information, see the Go SDK Docs.

Parameters:

• cameraName String (required)
• count int (required)
• extra Map<String, dynamic>? (optional)

Returns:

• Future<List<Classification>>

Example:

// Example:
var classifications = await myVisionService.classificationsFromCamera('myWebcam', 2);

For more information, see the Flutter SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• img (image.Image): The image in which to look for classifications.
• n (int): The number of classifications to return. For example, if you specify 3 you will get the top three classifications with the greatest confidence scores.
• extra (map[string]interface{}): Extra options to pass to the underlying RPC call.

Returns:

• (classification.Classifications): A list of classification labels, and the confidence scores of those classifications.
• (error): An error, if one occurred.

Example:

myCam, err := camera.FromRobot(machine, "my_camera")
if err != nil {
  logger.Error(err)
  return
}
// Get the stream from a camera
camStream, err := myCam.Stream(context.Background())
if err!=nil {
    logger.Error(err)
    return
}
// Get an image from the camera stream
img, release, err := camStream.Next(context.Background())
defer release()

myClassifierService, err := vision.FromRobot(machine, "my_classifier")
if err != nil {
  logger.Error(err)
  return
}
// Get the 2 classifications with the highest confidence scores from the image
classifications, err := myClassifierService.Classifications(context.Background(), img, 2, nil)
if err != nil {
  logger.Fatalf("Could not get classifications: %v", err)
}
if len(classifications) > 0 {
  logger.Info(classifications[0])
}

For more information, see the Go SDK Docs.

Parameters:

• image ViamImage (required)
• count int (required)
• extra Map<String, dynamic>? (optional)

Returns:

• Future<List<Classification>>

Example:

// Example:
var latestImage = await myWebcam.image();
var classifications = await myVisionService.classifications(latestImage, 2);

For more information, see the Flutter SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• cameraName (string): The name of the 3D camera from which to get point cloud data.
• extra (map[string]interface{}): Extra options to pass to the underlying RPC call.

Returns:

• ([]*viz.Object): A list of point clouds and associated metadata like the center coordinates of each point cloud.
• (error): An error, if one occurred.

Example:

mySegmenterService, err := vision.FromRobot(machine, "my_segmenter")
if err != nil {
  logger.Error(err)
  return
}
// Get the objects from the camera output
objects, err := mySegmenterService.GetObjectPointClouds(context.Background(), "my_camera", nil)
if err != nil {
  logger.Fatalf("Could not get point clouds: %v", err)
}
if len(objects) > 0 {
  logger.Info(objects[0])
}

For more information, see the Go SDK Docs.

Parameters:

• cameraName String (required)
• extra Map<String, dynamic>? (optional)

Returns:

• Future<List<PointCloudObject>>

Example:

// Example:
var ptCloud = await myVisionService.objectPointClouds('myCamera');

For more information, see the Flutter SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• cameraName (string): The name of the camera to use for detection.
• opts (viscapture.CaptureOptions): Additional options to provide if desired.
• extra (map[string]interface{}): Extra options to pass to the underlying RPC call.

Returns:

• (viscapture.VisCapture): A class that stores all potential returns from the vision service. It can return the image from the camera along with its associated detections, classifications, and objects, as well as any extra info the model may provide.
• (error): An error, if one occurred.

Example:

// The data to capture and return from the camera
captOpts := viscapture.CaptureOptions{
  ReturnImage: true,
  ReturnDetections: true,
}
// Get the captured data for a camera
capture, err := visService.CaptureAllFromCamera(context.Background(), "my_camera", captOpts, nil)
if err != nil {
  logger.Fatalf("Could not get capture data from vision service: %v", err)
}
image := capture.Image
detections := capture.Detections
classifications := capture.Classifications
objects := capture.Objects

For more information, see the Go SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• cmd (map[string]interface{}): The command to execute.

Returns:

• (map[string]interface{}): The command response.
• (error): An error, if one occurred.

Example:

myVisionSvc, err := vision.FromRobot(machine, "my_vision_svc")

command := map[string]interface{}{"cmd": "test", "data1": 500}
result, err := myVisionSvc.DoCommand(context.Background(), command)

For more information, see the Go SDK Docs.

Parameters:

• command Map<String, dynamic> (required)

Returns:

• Future<Map<String, dynamic>>

Example:

// Example using doCommand with an arm component
const command = {'cmd': 'test', 'data1': 500};
var result = myArm.doCommand(command);

For more information, see the Flutter SDK Docs.

Parameters:

• name String (required)

Returns:

• ResourceName

For more information, see the Flutter SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.
• extra (map[string]interface{}): Extra options to pass to the underlying RPC call.

Returns:

• (*Properties)
• (error): An error, if one occurred.

For more information, see the Go SDK Docs.

Parameters:

• ctx (Context): A Context carries a deadline, a cancellation signal, and other values across API boundaries.

Returns:

• (error): An error, if one occurred.

Example:

myVisionSvc, err := vision.FromRobot(machine, "my_vision_svc")

err = myVisionSvc.Close(context.Background())

For more information, see the Go SDK Docs.