viam.gen.service.vision.v1.vision_pb2

@generated by mypy-protobuf. Do not edit manually! isort:skip_file

Attributes

`DESCRIPTOR`
`global___GetDetectionsRequest`
`global___GetDetectionsResponse`
`global___GetDetectionsFromCameraRequest`
`global___GetDetectionsFromCameraResponse`
`global___Detection`
`global___GetClassificationsRequest`
`global___GetClassificationsResponse`
`global___GetClassificationsFromCameraRequest`
`global___GetClassificationsFromCameraResponse`
`global___Classification`
`global___GetObjectPointCloudsRequest`
`global___GetObjectPointCloudsResponse`
`global___GetPropertiesRequest`
`global___CaptureAllFromCameraRequest`
`global___CaptureAllFromCameraResponse`
`global___GetPropertiesResponse`

Classes

`GetDetectionsRequest`	Abstract base class for protocol messages.
`GetDetectionsResponse`	Abstract base class for protocol messages.
`GetDetectionsFromCameraRequest`	Abstract base class for protocol messages.
`GetDetectionsFromCameraResponse`	Abstract base class for protocol messages.
`Detection`	Abstract base class for protocol messages.
`GetClassificationsRequest`	Abstract base class for protocol messages.
`GetClassificationsResponse`	Abstract base class for protocol messages.
`GetClassificationsFromCameraRequest`	Abstract base class for protocol messages.
`GetClassificationsFromCameraResponse`	Abstract base class for protocol messages.
`Classification`	the general form of the output from a classifier
`GetObjectPointCloudsRequest`	Abstract base class for protocol messages.
`GetObjectPointCloudsResponse`	Abstract base class for protocol messages.
`GetPropertiesRequest`	Abstract base class for protocol messages.
`CaptureAllFromCameraRequest`	Abstract base class for protocol messages.
`CaptureAllFromCameraResponse`	Abstract base class for protocol messages.
`GetPropertiesResponse`	Abstract base class for protocol messages.

Module Contents

viam.gen.service.vision.v1.vision_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class viam.gen.service.vision.v1.vision_pb2.GetDetectionsRequest(*, name: str = ..., image: bytes = ..., width: int = ..., height: int = ..., mime_type: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str: name of the vision service

image: bytes: the image, encoded as bytes

width: int: the width of the image

height: int: the height of the image

mime_type: str: the actual MIME type of image

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: Literal['extra', b'extra']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.service.vision.v1.vision_pb2.global___GetDetectionsRequest

class viam.gen.service.vision.v1.vision_pb2.GetDetectionsResponse(*, detections: collections.abc.Iterable[global___Detection] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property detections: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Detection]: the bounding boxes and labels

viam.gen.service.vision.v1.vision_pb2.global___GetDetectionsResponse

class viam.gen.service.vision.v1.vision_pb2.GetDetectionsFromCameraRequest(*, name: str = ..., camera_name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str: name of the vision service

camera_name: str: name of camera source to use as input

property extra: google.protobuf.struct_pb2.Struct

HasField(field_name: Literal['extra', b'extra']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.service.vision.v1.vision_pb2.global___GetDetectionsFromCameraRequest

class viam.gen.service.vision.v1.vision_pb2.GetDetectionsFromCameraResponse(*, detections: collections.abc.Iterable[global___Detection] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property detections: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Detection]: the bounding boxes and labels

viam.gen.service.vision.v1.vision_pb2.global___GetDetectionsFromCameraResponse

class viam.gen.service.vision.v1.vision_pb2.Detection(*, x_min: int | None = ..., y_min: int | None = ..., x_max: int | None = ..., y_max: int | None = ..., confidence: float = ..., class_name: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

x_min: int: the four corners of the box

y_min: int

x_max: int

y_max: int

confidence: float: the confidence of the detection

class_name: str: label associated with the detected object

HasField(field_name: Literal['_x_max', b'_x_max', '_x_min', b'_x_min', '_y_max', b'_y_max', '_y_min', b'_y_min', 'x_max', b'x_max', 'x_min', b'x_min', 'y_max', b'y_max', 'y_min', b'y_min']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal['_x_max', b'_x_max']) → Literal['x_max'] | None

WhichOneof(oneof_group: Literal['_x_min', b'_x_min']) → Literal['x_min'] | None

WhichOneof(oneof_group: Literal['_y_max', b'_y_max']) → Literal['y_max'] | None

WhichOneof(oneof_group: Literal['_y_min', b'_y_min']) → Literal['y_min'] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

viam.gen.service.vision.v1.vision_pb2.global___Detection

class viam.gen.service.vision.v1.vision_pb2.GetClassificationsRequest(*, name: str = ..., image: bytes = ..., width: int = ..., height: int = ..., mime_type: str = ..., n: int = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str: name of the vision service

image: bytes: the image encoded as bytes

width: int: the width of the image

height: int: the height of the image

mime_type: str: the actual MIME type of image

n: int: the number of classifications desired

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: Literal['extra', b'extra']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.service.vision.v1.vision_pb2.global___GetClassificationsRequest

class viam.gen.service.vision.v1.vision_pb2.GetClassificationsResponse(*, classifications: collections.abc.Iterable[global___Classification] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property classifications: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Classification]

viam.gen.service.vision.v1.vision_pb2.global___GetClassificationsResponse

class viam.gen.service.vision.v1.vision_pb2.GetClassificationsFromCameraRequest(*, name: str = ..., camera_name: str = ..., n: int = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str: name of the vision service

camera_name: str: the image encoded as bytes

n: int: the number of classifications desired

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: Literal['extra', b'extra']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.service.vision.v1.vision_pb2.global___GetClassificationsFromCameraRequest

class viam.gen.service.vision.v1.vision_pb2.GetClassificationsFromCameraResponse(*, classifications: collections.abc.Iterable[global___Classification] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property classifications: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Classification]

viam.gen.service.vision.v1.vision_pb2.global___GetClassificationsFromCameraResponse

class viam.gen.service.vision.v1.vision_pb2.Classification(*, class_name: str = ..., confidence: float = ...)

Bases: google.protobuf.message.Message

the general form of the output from a classifier

class_name: str: the class name

confidence: float: the confidence score of the classification

viam.gen.service.vision.v1.vision_pb2.global___Classification

class viam.gen.service.vision.v1.vision_pb2.GetObjectPointCloudsRequest(*, name: str = ..., camera_name: str = ..., mime_type: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

camera_name: str: Name of a camera

mime_type: str: Requested MIME type of response

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: Literal['extra', b'extra']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.service.vision.v1.vision_pb2.global___GetObjectPointCloudsRequest

class viam.gen.service.vision.v1.vision_pb2.GetObjectPointCloudsResponse(*, mime_type: str = ..., objects: collections.abc.Iterable[viam.gen.common.v1.common_pb2.PointCloudObject] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

mime_type: str: Actual MIME type of response

property objects: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.PointCloudObject]: List of objects in the scene

viam.gen.service.vision.v1.vision_pb2.global___GetObjectPointCloudsResponse

class viam.gen.service.vision.v1.vision_pb2.GetPropertiesRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str: name of the vision service

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: Literal['extra', b'extra']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.service.vision.v1.vision_pb2.global___GetPropertiesRequest

class viam.gen.service.vision.v1.vision_pb2.CaptureAllFromCameraRequest(*, name: str = ..., camera_name: str = ..., return_image: bool = ..., return_classifications: bool = ..., return_detections: bool = ..., return_object_point_clouds: bool = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str: name of the vision service

camera_name: str: name of camera source to use as input

return_image: bool: whether or not including the image in the response

return_classifications: bool: whether or not including classifications in the response

return_detections: bool: whether or not including detections in the response

return_object_point_clouds: bool: whether or not including pcd in the response

property extra: google.protobuf.struct_pb2.Struct

HasField(field_name: Literal['extra', b'extra']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.service.vision.v1.vision_pb2.global___CaptureAllFromCameraRequest

class viam.gen.service.vision.v1.vision_pb2.CaptureAllFromCameraResponse(*, image: viam.gen.component.camera.v1.camera_pb2.Image | None = ..., detections: collections.abc.Iterable[global___Detection] | None = ..., classifications: collections.abc.Iterable[global___Classification] | None = ..., objects: collections.abc.Iterable[viam.gen.common.v1.common_pb2.PointCloudObject] | None = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property image: viam.gen.component.camera.v1.camera_pb2.Image

property detections: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Detection]

property classifications: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Classification]

property objects: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.PointCloudObject]

property extra: google.protobuf.struct_pb2.Struct

HasField(field_name: Literal['extra', b'extra', 'image', b'image']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.service.vision.v1.vision_pb2.global___CaptureAllFromCameraResponse

class viam.gen.service.vision.v1.vision_pb2.GetPropertiesResponse(*, classifications_supported: bool = ..., detections_supported: bool = ..., object_point_clouds_supported: bool = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

classifications_supported: bool: whether or not classifactions are supported by the vision service

detections_supported: bool: whether or not detections are supported by the vision service

object_point_clouds_supported: bool: whether or not 3d segmentation is supported by the vision service

viam.gen.service.vision.v1.vision_pb2.global___GetPropertiesResponse