viam.gen.service.vision.v1.vision_pb2 ===================================== .. py:module:: viam.gen.service.vision.v1.vision_pb2 .. autoapi-nested-parse:: @generated by mypy-protobuf. Do not edit manually! isort:skip_file Attributes ---------- .. autoapisummary:: viam.gen.service.vision.v1.vision_pb2.DESCRIPTOR viam.gen.service.vision.v1.vision_pb2.global___GetDetectionsRequest viam.gen.service.vision.v1.vision_pb2.global___GetDetectionsResponse viam.gen.service.vision.v1.vision_pb2.global___GetDetectionsFromCameraRequest viam.gen.service.vision.v1.vision_pb2.global___GetDetectionsFromCameraResponse viam.gen.service.vision.v1.vision_pb2.global___Detection viam.gen.service.vision.v1.vision_pb2.global___GetClassificationsRequest viam.gen.service.vision.v1.vision_pb2.global___GetClassificationsResponse viam.gen.service.vision.v1.vision_pb2.global___GetClassificationsFromCameraRequest viam.gen.service.vision.v1.vision_pb2.global___GetClassificationsFromCameraResponse viam.gen.service.vision.v1.vision_pb2.global___Classification viam.gen.service.vision.v1.vision_pb2.global___GetObjectPointCloudsRequest viam.gen.service.vision.v1.vision_pb2.global___GetObjectPointCloudsResponse viam.gen.service.vision.v1.vision_pb2.global___GetPropertiesRequest viam.gen.service.vision.v1.vision_pb2.global___CaptureAllFromCameraRequest viam.gen.service.vision.v1.vision_pb2.global___CaptureAllFromCameraResponse viam.gen.service.vision.v1.vision_pb2.global___GetPropertiesResponse Classes ------- .. autoapisummary:: viam.gen.service.vision.v1.vision_pb2.GetDetectionsRequest viam.gen.service.vision.v1.vision_pb2.GetDetectionsResponse viam.gen.service.vision.v1.vision_pb2.GetDetectionsFromCameraRequest viam.gen.service.vision.v1.vision_pb2.GetDetectionsFromCameraResponse viam.gen.service.vision.v1.vision_pb2.Detection viam.gen.service.vision.v1.vision_pb2.GetClassificationsRequest viam.gen.service.vision.v1.vision_pb2.GetClassificationsResponse viam.gen.service.vision.v1.vision_pb2.GetClassificationsFromCameraRequest viam.gen.service.vision.v1.vision_pb2.GetClassificationsFromCameraResponse viam.gen.service.vision.v1.vision_pb2.Classification viam.gen.service.vision.v1.vision_pb2.GetObjectPointCloudsRequest viam.gen.service.vision.v1.vision_pb2.GetObjectPointCloudsResponse viam.gen.service.vision.v1.vision_pb2.GetPropertiesRequest viam.gen.service.vision.v1.vision_pb2.CaptureAllFromCameraRequest viam.gen.service.vision.v1.vision_pb2.CaptureAllFromCameraResponse viam.gen.service.vision.v1.vision_pb2.GetPropertiesResponse Module Contents --------------- .. py:data:: DESCRIPTOR :type: google.protobuf.descriptor.FileDescriptor .. py:class:: GetDetectionsRequest(*, name: str = ..., image: bytes = ..., width: int = ..., height: int = ..., mime_type: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:attribute:: name :type: str name of the vision service .. py:attribute:: image :type: bytes the image, encoded as bytes .. py:attribute:: width :type: int the width of the image .. py:attribute:: height :type: int the height of the image .. py:attribute:: mime_type :type: str the actual MIME type of image .. py:property:: extra :type: google.protobuf.struct_pb2.Struct Additional arguments to the method .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___GetDetectionsRequest .. py:class:: GetDetectionsResponse(*, detections: collections.abc.Iterable[global___Detection] | None = ...) Bases: :py:obj:`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. .. py:property:: detections :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Detection] the bounding boxes and labels .. py:data:: global___GetDetectionsResponse .. py:class:: GetDetectionsFromCameraRequest(*, name: str = ..., camera_name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:attribute:: name :type: str name of the vision service .. py:attribute:: camera_name :type: str name of camera source to use as input .. py:property:: extra :type: google.protobuf.struct_pb2.Struct .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___GetDetectionsFromCameraRequest .. py:class:: GetDetectionsFromCameraResponse(*, detections: collections.abc.Iterable[global___Detection] | None = ...) Bases: :py:obj:`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. .. py:property:: detections :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Detection] the bounding boxes and labels .. py:data:: global___GetDetectionsFromCameraResponse .. py:class:: Detection(*, x_min: int | None = ..., y_min: int | None = ..., x_max: int | None = ..., y_max: int | None = ..., confidence: float = ..., class_name: str = ..., x_min_normalized: float | None = ..., y_min_normalized: float | None = ..., x_max_normalized: float | None = ..., y_max_normalized: float | None = ...) Bases: :py:obj:`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. .. py:attribute:: x_min :type: int the four corners of the box .. py:attribute:: y_min :type: int .. py:attribute:: x_max :type: int .. py:attribute:: y_max :type: int .. py:attribute:: confidence :type: float the confidence of the detection .. py:attribute:: class_name :type: str label associated with the detected object .. py:attribute:: x_min_normalized :type: float the four corners of the box, in proportion to the respective image dimension .. py:attribute:: y_min_normalized :type: float .. py:attribute:: x_max_normalized :type: float .. py:attribute:: y_max_normalized :type: float .. py:method:: HasField(field_name: Literal['_x_max', b'_x_max', '_x_max_normalized', b'_x_max_normalized', '_x_min', b'_x_min', '_x_min_normalized', b'_x_min_normalized', '_y_max', b'_y_max', '_y_max_normalized', b'_y_max_normalized', '_y_min', b'_y_min', '_y_min_normalized', b'_y_min_normalized', 'x_max', b'x_max', 'x_max_normalized', b'x_max_normalized', 'x_min', b'x_min', 'x_min_normalized', b'x_min_normalized', 'y_max', b'y_max', 'y_max_normalized', b'y_max_normalized', 'y_min', b'y_min', 'y_min_normalized', b'y_min_normalized']) -> 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: WhichOneof(oneof_group: Literal['_x_max', b'_x_max']) -> Literal['x_max'] | None WhichOneof(oneof_group: Literal['_x_max_normalized', b'_x_max_normalized']) -> Literal['x_max_normalized'] | None WhichOneof(oneof_group: Literal['_x_min', b'_x_min']) -> Literal['x_min'] | None WhichOneof(oneof_group: Literal['_x_min_normalized', b'_x_min_normalized']) -> Literal['x_min_normalized'] | None WhichOneof(oneof_group: Literal['_y_max', b'_y_max']) -> Literal['y_max'] | None WhichOneof(oneof_group: Literal['_y_max_normalized', b'_y_max_normalized']) -> Literal['y_max_normalized'] | None WhichOneof(oneof_group: Literal['_y_min', b'_y_min']) -> Literal['y_min'] | None WhichOneof(oneof_group: Literal['_y_min_normalized', b'_y_min_normalized']) -> Literal['y_min_normalized'] | None Returns the name of the field that is set inside a oneof group. If no field is set, returns None. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:data:: global___Detection .. py:class:: GetClassificationsRequest(*, name: str = ..., image: bytes = ..., width: int = ..., height: int = ..., mime_type: str = ..., n: int = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:attribute:: name :type: str name of the vision service .. py:attribute:: image :type: bytes the image encoded as bytes .. py:attribute:: width :type: int the width of the image .. py:attribute:: height :type: int the height of the image .. py:attribute:: mime_type :type: str the actual MIME type of image .. py:attribute:: n :type: int the number of classifications desired .. py:property:: extra :type: google.protobuf.struct_pb2.Struct Additional arguments to the method .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___GetClassificationsRequest .. py:class:: GetClassificationsResponse(*, classifications: collections.abc.Iterable[global___Classification] | None = ...) Bases: :py:obj:`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. .. py:property:: classifications :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Classification] .. py:data:: global___GetClassificationsResponse .. py:class:: GetClassificationsFromCameraRequest(*, name: str = ..., camera_name: str = ..., n: int = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:attribute:: name :type: str name of the vision service .. py:attribute:: camera_name :type: str the image encoded as bytes .. py:attribute:: n :type: int the number of classifications desired .. py:property:: extra :type: google.protobuf.struct_pb2.Struct Additional arguments to the method .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___GetClassificationsFromCameraRequest .. py:class:: GetClassificationsFromCameraResponse(*, classifications: collections.abc.Iterable[global___Classification] | None = ...) Bases: :py:obj:`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. .. py:property:: classifications :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Classification] .. py:data:: global___GetClassificationsFromCameraResponse .. py:class:: Classification(*, class_name: str = ..., confidence: float = ...) Bases: :py:obj:`google.protobuf.message.Message` the general form of the output from a classifier .. py:attribute:: class_name :type: str the class name .. py:attribute:: confidence :type: float the confidence score of the classification .. py:data:: global___Classification .. py:class:: GetObjectPointCloudsRequest(*, name: str = ..., camera_name: str = ..., mime_type: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:attribute:: name :type: str .. py:attribute:: camera_name :type: str Name of a camera .. py:attribute:: mime_type :type: str Requested MIME type of response .. py:property:: extra :type: google.protobuf.struct_pb2.Struct Additional arguments to the method .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___GetObjectPointCloudsRequest .. py:class:: GetObjectPointCloudsResponse(*, mime_type: str = ..., objects: collections.abc.Iterable[viam.gen.common.v1.common_pb2.PointCloudObject] | None = ...) Bases: :py:obj:`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. .. py:attribute:: mime_type :type: str Actual MIME type of response .. py:property:: objects :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.PointCloudObject] List of objects in the scene .. py:data:: global___GetObjectPointCloudsResponse .. py:class:: GetPropertiesRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...) Bases: :py:obj:`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. .. py:attribute:: name :type: str name of the vision service .. py:property:: extra :type: google.protobuf.struct_pb2.Struct Additional arguments to the method .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___GetPropertiesRequest .. py:class:: 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: :py:obj:`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. .. py:attribute:: name :type: str name of the vision service .. py:attribute:: camera_name :type: str name of camera source to use as input .. py:attribute:: return_image :type: bool whether or not including the image in the response .. py:attribute:: return_classifications :type: bool whether or not including classifications in the response .. py:attribute:: return_detections :type: bool whether or not including detections in the response .. py:attribute:: return_object_point_clouds :type: bool whether or not including pcd in the response .. py:property:: extra :type: google.protobuf.struct_pb2.Struct .. py: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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___CaptureAllFromCameraRequest .. py:class:: 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: :py:obj:`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. .. py:property:: image :type: viam.gen.component.camera.v1.camera_pb2.Image .. py:property:: detections :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Detection] .. py:property:: classifications :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Classification] .. py:property:: objects :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.PointCloudObject] .. py:property:: extra :type: google.protobuf.struct_pb2.Struct .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___CaptureAllFromCameraResponse .. py:class:: GetPropertiesResponse(*, classifications_supported: bool = ..., detections_supported: bool = ..., object_point_clouds_supported: bool = ...) Bases: :py:obj:`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. .. py:attribute:: classifications_supported :type: bool whether or not classifactions are supported by the vision service .. py:attribute:: detections_supported :type: bool whether or not detections are supported by the vision service .. py:attribute:: object_point_clouds_supported :type: bool whether or not 3d segmentation is supported by the vision service .. py:data:: global___GetPropertiesResponse