viam.gen.component.camera.v1.camera_pb2

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

Attributes

`DESCRIPTOR`
`Global___GetImagesRequest`
`Global___GetImagesResponse`
`Global___Image`
`Global___GetPointCloudRequest`
`Global___GetPointCloudResponse`
`Global___GetPropertiesRequest`
`Global___GetPropertiesResponse`
`Global___Webcams`
`Global___Webcam`
`Global___Property`
`Global___IntrinsicParameters`
`Global___DistortionParameters`
`Global___ExtrinsicParameters`

Classes

`GetImagesRequest`	Abstract base class for protocol messages.
`GetImagesResponse`	Abstract base class for protocol messages.
`Image`	Abstract base class for protocol messages.
`GetPointCloudRequest`	Abstract base class for protocol messages.
`GetPointCloudResponse`	Abstract base class for protocol messages.
`GetPropertiesRequest`	Abstract base class for protocol messages.
`GetPropertiesResponse`	Abstract base class for protocol messages.
`Webcams`	Abstract base class for protocol messages.
`Webcam`	Abstract base class for protocol messages.
`Property`	Abstract base class for protocol messages.
`IntrinsicParameters`	Abstract base class for protocol messages.
`DistortionParameters`	Abstract base class for protocol messages.
`ExtrinsicParameters`	ExtrinsicParameters define the position of the camera

Module Contents

viam.gen.component.camera.v1.camera_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class viam.gen.component.camera.v1.camera_pb2.GetImagesRequest(*, name: str = ..., filter_source_names: collections.abc.Iterable[str] | 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.

name: str: Name of a camera

filter_source_names() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]: The names of the sensors to retrieve images from. If this is not provided, all images from all sensors will be returned.

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.camera.v1.camera_pb2.Global___GetImagesRequest = GetImagesRequest

class viam.gen.component.camera.v1.camera_pb2.GetImagesResponse(*, images: collections.abc.Iterable[Global___Image] | None = ..., response_metadata: common.v1.common_pb2.ResponseMetadata | 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.

images() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Image]: list of images returned from the camera system

response_metadata() → common.v1.common_pb2.ResponseMetadata: contains timestamp data

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.camera.v1.camera_pb2.Global___GetImagesResponse = GetImagesResponse

class viam.gen.component.camera.v1.camera_pb2.Image(*, source_name: str = ..., image: bytes = ..., mime_type: str = ..., annotations: app.data.v1.data_pb2.Annotations | 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.

source_name: str: the name of the sensor where the image came from

image: bytes: image in bytes

mime_type: str: The mime type of the image

annotations() → app.data.v1.data_pb2.Annotations: annotations can be used to store additional information about the image

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.camera.v1.camera_pb2.Global___Image = Image

class viam.gen.component.camera.v1.camera_pb2.GetPointCloudRequest(*, 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: Name of a camera

mime_type: str: Requested MIME type of response

extra() → google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.camera.v1.camera_pb2.Global___GetPointCloudRequest = GetPointCloudRequest

class viam.gen.component.camera.v1.camera_pb2.GetPointCloudResponse(*, mime_type: str = ..., point_cloud: bytes = ...)

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

point_cloud: bytes: Frame in bytes

type viam.gen.component.camera.v1.camera_pb2.Global___GetPointCloudResponse = GetPointCloudResponse

class viam.gen.component.camera.v1.camera_pb2.GetPropertiesRequest(*, 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.

name: str: Name of a camera

type viam.gen.component.camera.v1.camera_pb2.Global___GetPropertiesRequest = GetPropertiesRequest

class viam.gen.component.camera.v1.camera_pb2.GetPropertiesResponse(*, supports_pcd: bool = ..., intrinsic_parameters: Global___IntrinsicParameters | None = ..., distortion_parameters: Global___DistortionParameters | None = ..., mime_types: collections.abc.Iterable[str] | None = ..., frame_rate: float | None = ..., extrinsic_parameters: Global___ExtrinsicParameters | 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.

supports_pcd: bool: A boolean property determining whether the camera supports the return of pointcloud data

frame_rate: float: Optional camera frame rate for image capture timing

intrinsic_parameters() → Global___IntrinsicParameters: Parameters for doing a perspective of a 3D scene to a 2D plane If camera does not provide intrinsic parameters, leave the field empty Initializing the parameters with 0-values is considered an error

distortion_parameters() → Global___DistortionParameters: Parameters for modeling lens distortion in cameras If camera does not provide distortion parameters, leave the field empty Initializing the parameters with 0-values is considered an error

mime_types() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]: Supported MIME types by the camera

extrinsic_parameters() → Global___ExtrinsicParameters: Parameters for the camera’s position relative to a reference frame If camera does not provide extrinsic parameters, leave the field empty

HasField(field_name: _HasFieldArgType) → 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: _WhichOneofArgType__frame_rate) → _WhichOneofReturnType__frame_rate | 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

type viam.gen.component.camera.v1.camera_pb2.Global___GetPropertiesResponse = GetPropertiesResponse

class viam.gen.component.camera.v1.camera_pb2.Webcams(*, webcams: collections.abc.Iterable[Global___Webcam] | 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.

webcams() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Webcam]

type viam.gen.component.camera.v1.camera_pb2.Global___Webcams = Webcams

class viam.gen.component.camera.v1.camera_pb2.Webcam(*, label: str = ..., status: str = ..., properties: collections.abc.Iterable[Global___Property] | None = ..., name: str = ..., id: 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.

label: str: Camera driver label (for internal use only)

status: str: Camera driver status

name: str: Camera human-readable driver name

id: str: Camera unique identifier

properties() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Property]: Camera properties

type viam.gen.component.camera.v1.camera_pb2.Global___Webcam = Webcam

class viam.gen.component.camera.v1.camera_pb2.Property(*, width_px: int = ..., height_px: int = ..., frame_format: str = ..., frame_rate: float = ...)

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.

width_px: int: Video resolution width in px

height_px: int: Video resolution height in px

frame_format: str: Video frame format

frame_rate: float: Video frame rate in fps

type viam.gen.component.camera.v1.camera_pb2.Global___Property = Property

class viam.gen.component.camera.v1.camera_pb2.IntrinsicParameters(*, width_px: int = ..., height_px: int = ..., focal_x_px: float = ..., focal_y_px: float = ..., center_x_px: float = ..., center_y_px: float = ...)

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.

width_px: int

height_px: int

focal_x_px: float

focal_y_px: float

center_x_px: float

center_y_px: float

type viam.gen.component.camera.v1.camera_pb2.Global___IntrinsicParameters = IntrinsicParameters

class viam.gen.component.camera.v1.camera_pb2.DistortionParameters(*, model: str = ..., parameters: collections.abc.Iterable[float] | 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.

model: str

parameters() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[float]

type viam.gen.component.camera.v1.camera_pb2.Global___DistortionParameters = DistortionParameters

class viam.gen.component.camera.v1.camera_pb2.ExtrinsicParameters(*, translation: common.v1.common_pb2.Vector3 | None = ..., orientation: common.v1.common_pb2.Orientation | None = ...)

Bases: google.protobuf.message.Message

ExtrinsicParameters define the position of the camera relative to a reference frame (the world or another sensor).

translation() → common.v1.common_pb2.Vector3: The translation from the reference frame to the camera.

orientation() → common.v1.common_pb2.Orientation: The orientation from the reference frame to the camera.

HasField(field_name: _HasFieldArgType) → 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.

type viam.gen.component.camera.v1.camera_pb2.Global___ExtrinsicParameters = ExtrinsicParameters