← Back to packages

Package intrinsic_proto.perception.v1

Service CameraService

Service TrainService

Message ARTag

Message AssetMetadata

Message AxisAngle

Message CameraConfig

Message CameraDrivers

Message CameraIdentifier

Message CameraParams

Message CameraSetting

Message CameraSettingAccess

Message CameraSettingProperties

Message CaptureRequest

Message CaptureResponse

Message CaptureResult

Message CharucoPattern

Message CreateTrainingJobRequest

Message CropOptions

Message DescribeCameraRequest

Message DescribeCameraResponse

Message Dimensions

Message DistortionParams

Message EnumSettingProperties

Message FiniteNonTrivialSymmetry

Message FloatRange

Message FloatSettingProperties

Message GainSetting

Message GenICam

Message Icosahedron

Message ImageBuffer

Message IntegerRange

Message IntegerSettingProperties

Message IntrinsicParams

Message LatitudeLongitudeViewSpace

Message ListAvailableCamerasRequest

Message ListAvailableCamerasResponse

Message MarkerObject

Message MeshObject

Message PoseEstimateInRoot

Message PoseEstimationConfig

Message PoseRange

Message ReadCameraSettingAccessRequest

Message ReadCameraSettingAccessResponse

Message ReadCameraSettingPropertiesRequest

Message ReadCameraSettingPropertiesResponse

Message ReadCameraSettingRequest

Message ReadCameraSettingResponse

Message RevolutionSymmetryWithoutRotoReflection

Message SaveTrainingJobRequest

Message SaveTrainingJobResponse

Message SensorConfig

Message SensorConfigs

Message SensorImage

Message SensorImagePostProcessing

Message SensorInformation

Message SphericalSymmetry

Message Symmetry

Message Target

Message Targets

Message TrainingJobStatus

Message UpdateCameraSettingRequest

Message UpdateCameraSettingResponse

Message VerifyTrainingJobResponse

Enum ArucoDictionary

Enum DataType

Enum Encoding

Enum Hemisphere

Enum Mode

Enum PackingType

Enum PixelType

Enum PoseEstimatorType

Services

service CameraService intrinsic/perception/proto/v1/camera_service.proto

Describes the camera and its sensors. Enumerates connected sensors.

Captures image data from the requested sensors of the specified camera.

Reads and returns the access mode of a specific setting from a camera. The function returns an error if the camera is unknown.

Read the properties of the user specified camera and setting. The function returns an error if the camera is unknown or if the setting is not supported. If specific properties of a setting are not supported, they are not added to the result. The function only returns existing properties and triggers no errors for non-existing properties as these are optional to be implemented by the camera vendors.

Reads and returns the current value of a specific setting from a camera. The function returns an error if the camera is unknown or if the setting is not supported.

Update the value of a specific camera setting. The function returns an error if the camera is unknown or if the setting is not supported. Note: When updating camera parameters, beware that the modifications will apply to all instances. I.e. it will also affect all other clients who are using the same camera.

service TrainService intrinsic/perception/proto/v1/train_service.proto

Trains pose estimation models.

Trains a pose estimation model. Returns a longrunning.Operation with: metadata of type TrainingJobStatus (progress information, etc.) Training errors are reported through the longrunning.Operation.error field.

Lists training job operations that match the specified filter in the request.

Gets the latest state of a training job operation. Clients can use this method to poll the operation result at intervals.

Deletes a training job operation. Only training jobs which have been successfully cancelled or which are not running can be deleted.

Starts asynchronous cancellation on a training job operation. The server makes a best effort to cancel the operation, but success is not guaranteed. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an [Operation.error][] value with a [google.rpc.Status.code][] of 1, corresponding to Code.CANCELLED.

Checks an incoming CreateTrainingJobRequest for potential issues and provides feedback on the selected training configuration.

Messages

message ARTag (Nested in intrinsic_proto.perception.v1.MarkerObject ) intrinsic/perception/proto/v1/target.proto

Field Type Description
1 id uint64

AR tag bit pattern.

2 bits_per_side uint32

Defines the pattern bit size (maximal 8).

3 size float

Physical size of marker in meters.

message AssetMetadata intrinsic/perception/proto/v1/train_service.proto

Field Type Description
1 asset_name string

Name of the data asset that will be created.

2 id_version optional intrinsic_proto.assets.IdVersion

The ID and version of the training job to save. If not set, the default package will be used (ai.intrinsic) and asset_name will be used as name.

message AxisAngle intrinsic/perception/proto/v1/symmetry.proto

Field Type Description
1 axis intrinsic_proto.Vector3

Axis of rotation. Does not need to be normalized.

2 angle float

Angle of rotation specified in radians.

message CameraConfig intrinsic/perception/proto/v1/camera_config.proto

Specification of a single camera. The specification includes the driver to be used, connection parameters, but also intrinsic calibration info and optional per-sensor configuration.

Field Type Description
1 identifier intrinsic_proto.perception.v1.CameraIdentifier

A unique identifier of a specific camera. This identifier determines which underlying driver is used to access a camera.

2 camera_settings repeated intrinsic_proto.perception.v1.CameraSetting

A list of camera settings. Camera settings are applied in the order in which they are defined. The specification of camera settings is optional.

3 sensor_configs repeated intrinsic_proto.perception.v1.SensorConfig

A list of per-sensor configurations. These include per-sensor calibrations and poses. The specification of sensor configurations is optional.

message CameraDrivers intrinsic/perception/proto/v1/camera_drivers.proto

This message declares different camera drivers. Each driver references a specific implementation which is used to control and communicate with cameras.

Field Type Description

message CameraIdentifier intrinsic/perception/proto/v1/camera_identifier.proto

A unique identifier for a specific, physical camera.

Each driver uses a different underlying implementation and within each driver a specific hardware ID binds the identifier to a single physical camera.

Field Type Description
oneof drivers
3 genicam intrinsic_proto.perception.v1.CameraDrivers.GenICam

message CameraParams intrinsic/perception/proto/v1/camera_params.proto

This proto contains information about the image size and all internal camera parameters (intrinsic and distortion parameters).

Field Type Description
1 intrinsic_params intrinsic_proto.perception.v1.IntrinsicParams

The intrinsic camera parameters. If they are not presented, we are dealing with an uncalibrated camera.

2 distortion_params optional intrinsic_proto.perception.v1.DistortionParams

The distortion params of the camera. If they are not present, the camera is either uncalibrated or it provides undistorted images (in all likelihood synthetic one).

message CameraSetting intrinsic/perception/proto/v1/camera_settings.proto

This message encapsulates camera settings conforming with the GenICam Standard Features Naming Convention (SFNC).

Field Type Description
1 name string

The SFNC conforming feature name.

oneof value
2 integer_value int64

GenICam: IInteger - maps to a slider with value, min, max, and increment

3 float_value double

GenICam: IFloat - maps to a slider with value, min, and max

4 bool_value bool

GenICam: IBoolean - maps to a check box

5 string_value string

GenICam: IString - maps to an edit box showing a string

6 enumeration_value string

GenICam: IEnumeration - maps to a drop down box

7 command_value google.protobuf.Empty

GenICam: ICommand

message CameraSettingAccess intrinsic/perception/proto/v1/camera_settings.proto

Field Type Description
1 name string

The SFNC conforming feature name.

2 mode intrinsic_proto.perception.v1.CameraSettingAccess.Mode

message CameraSettingProperties intrinsic/perception/proto/v1/camera_settings.proto

Field Type Description
1 name string

The SFNC conforming feature name.

oneof setting_properties
2 float_properties intrinsic_proto.perception.v1.FloatSettingProperties
3 integer_properties intrinsic_proto.perception.v1.IntegerSettingProperties
4 enum_properties intrinsic_proto.perception.v1.EnumSettingProperties

message CaptureRequest intrinsic/perception/proto/v1/camera_service.proto

Field Type Description
1 camera_config intrinsic_proto.perception.v1.CameraConfig

The configuration of the camera from which images are to be captured from.

2 timeout google.protobuf.Duration

The timeout which is used for retrieving frames from the underlying driver implementation. If this timeout is implemented by the underlying camera driver, it will not spend more than the specified time when waiting for new frames. The timeout should be greater than the combined exposure and processing time. Processing times can be roughly estimated as a value between 10 - 50 ms. The timeout just serves as an upper limit to prevent blocking calls within the camera driver. In case of intermittent network errors users can try to increase the timeout. The default timeout (if unspecified) of 500 ms works well in common setups.

3 sensor_ids repeated int64

Optional. Request data only for the following sensor ids (i.e. transmit mask). Empty returns all sensor images.

4 post_processing_by_sensor_id map<int64, SensorImagePostProcessing>

Additional post processing options for each sensor. If present, sensor post processing options will override the global post processing options.

5 capture_result_location optional intrinsic_proto.kvstore.StorageLocation

If set the capture result will be stored in the specified key value store location, which will also be returned instead of the capture result itself.

message CaptureResponse intrinsic/perception/proto/v1/camera_service.proto

Field Type Description
oneof response
1 capture_result intrinsic_proto.perception.v1.CaptureResult
2 capture_result_location intrinsic_proto.kvstore.StorageLocation

message CaptureResult intrinsic/perception/proto/v1/capture_result.proto

This message represents a perception CaptureResult. A container for sensor images and any associated capture metadata.

Field Type Description
1 capture_at google.protobuf.Timestamp

Timestamp at which the images were captured. Value matches each sensor_image's acquisition_time, and is duplicated for capture result processing convenience.

2 sensor_images repeated intrinsic_proto.perception.v1.SensorImage

Images for each of the captured sensors

3 capture_duration optional google.protobuf.Duration

Duration needed to capture all images excluding post processing like HDR. Not all camera drivers will provide it.

message CharucoPattern intrinsic/perception/proto/v1/charuco_pattern.proto

Descriptor of a ChArUco pattern.

Field Type Description
1 squares_x int32

Number of squares of the ChArUco board in x direction.

2 squares_y int32

Number of squares of the ChArUco board in y direction.

3 square_length double

Length (width and height) of each square of the chessboard of the ChArUco board in m.

4 marker_length double

Length (width and height) of each ArUco marker on the ChArUco board in m.

5 dictionary intrinsic_proto.perception.v1.ArucoDictionary

Dictionary for the ArUco markers that are being used.

message CreateTrainingJobRequest intrinsic/perception/proto/v1/train_service.proto

Field Type Description
1 pose_estimation_config intrinsic_proto.perception.v1.PoseEstimationConfig

Pose estimation config to be trained. All file paths specified in this config must match the target paths in the file_references below.

3 custom_data optional google.protobuf.Any

A generic proto with user-specific custom data attached to the training job. The proto will be returned to the caller in the TrainingJobStatus message.

6 asset_metadata intrinsic_proto.perception.v1.AssetMetadata

Name of the data asset that will be created.

7 one_shot_asset_id intrinsic_proto.assets.Id

The ID of the one-shot base model asset that will be used to populate the pose estimator perception model. This is only used for one-shot pose estimators creation.

8 pose_estimator_type intrinsic_proto.perception.v1.PoseEstimatorType

Type of pose estimator to be trained. If POSE_ESTIMATOR_TYPE_UNSPECIFIED is selected, the params and inference_params fields of pose_estimation_config must be set. If any other pose estimator type is selected, the params and inference_params fields will be auto-filled with default values according to the pose estimator type.

message CropOptions intrinsic/perception/proto/v1/post_processing.proto

Field Type Description
1 origin_x int32
2 origin_y int32
3 dimensions intrinsic_proto.perception.v1.Dimensions

message DescribeCameraRequest intrinsic/perception/proto/v1/camera_service.proto

Field Type Description
1 camera_identifier intrinsic_proto.perception.v1.CameraIdentifier

The identifier of the camera that is to be described.

message DescribeCameraResponse intrinsic/perception/proto/v1/camera_service.proto

Field Type Description
1 sensors repeated intrinsic_proto.perception.v1.SensorInformation

message Dimensions intrinsic/perception/proto/v1/dimensions.proto

Field Type Description
1 cols int32

Image resolution along x axis, in pixels.

2 rows int32

Image resolution along y axis, in pixels.

message DistortionParams intrinsic/perception/proto/v1/distortion_params.proto

Distortion model and parameters.

Field Type Description
1 k1 double

First radial distortion coefficient.

2 k2 double

Second radial distortion coefficient.

3 k3 double

Third radial distortion coefficient.

4 p1 double

First tangetial distortion coefficient.

5 p2 double

Second tangetial distortion coefficient.

6 k4 optional double

Fourth radial distortion coefficient.

7 k5 optional double

Fifth radial distortion coefficient.

8 k6 optional double

Sixt radial distortion coefficient.

message EnumSettingProperties intrinsic/perception/proto/v1/settings.proto

Field Type Description
1 values repeated string

The allowed values for the enum.

message FiniteNonTrivialSymmetry (Nested in intrinsic_proto.perception.v1.Symmetry ) intrinsic/perception/proto/v1/symmetry.proto

Field Type Description
1 center intrinsic_proto.Vector3

Required symmetry center.

2 axis_angle intrinsic_proto.perception.v1.AxisAngle

Required symmetry axis and symmetry angle represented in angle-axis representation. Currently we only support one symmetry axis.

message FloatRange (Nested in intrinsic_proto.perception.v1.FloatSettingProperties ) intrinsic/perception/proto/v1/settings.proto

Field Type Description
1 minimum double
2 maximum double

message FloatSettingProperties intrinsic/perception/proto/v1/settings.proto

Field Type Description
1 range intrinsic_proto.perception.v1.FloatSettingProperties.FloatRange

The range of allowed floating point values.

2 increment double

The increment (or delta) between two neighboring allowed values.

3 unit optional string

The unit corresponding to the value. We typically default to SI units.

message GainSetting intrinsic/perception/proto/v1/camera_settings.proto

Field Type Description
1 value double

message GenICam (Nested in intrinsic_proto.perception.v1.CameraDrivers ) intrinsic/perception/proto/v1/camera_drivers.proto

The default driver which is used when communicating with GenICam cameras (Aravis).

Field Type Description
1 device_id string

message Icosahedron intrinsic/perception/proto/v1/pose_range.proto

Encodes vertices of a recursively subdivided icosahedron.

Field Type Description
1 depth int32

Recursion depth of the icosahedron. 0 means no subdivision with possible vertex indices from [0,12).

2 vertex repeated int32

Vertex index for the respective recursion depth.

message ImageBuffer intrinsic/perception/proto/v1/image_buffer.proto

An image buffer, which contains either raw and uncompressed image data or a compressed image.

Field Type Description
1 encoding intrinsic_proto.perception.v1.Encoding

The image buffer's encoding.

2 pixel_type intrinsic_proto.perception.v1.PixelType

Stores the underlying semantic pixel data which is stored in an image.

3 num_channels int32

The image's number of channels, i.e. components per pixel.

4 type intrinsic_proto.perception.v1.DataType

The underlying data type of the pixels.

5 dimensions optional intrinsic_proto.perception.v1.Dimensions

The width and height (cols and rows) of an image. This parameter is optional and must be specified when images are uncompressed, i.e. when encoding is ENCODING_UNSPECIFIED.

6 data bytes

The actual underlying data.

7 packing_type optional intrinsic_proto.perception.v1.PackingType

The packing type of the pixels. If not present, implementations should default to PACKING_TYPE_INTERLEAVED.

message IntegerRange (Nested in intrinsic_proto.perception.v1.IntegerSettingProperties ) intrinsic/perception/proto/v1/settings.proto

Field Type Description
1 minimum int64
2 maximum int64

message IntegerSettingProperties intrinsic/perception/proto/v1/settings.proto

Field Type Description
1 range intrinsic_proto.perception.v1.IntegerSettingProperties.IntegerRange

The range of allowed integer values.

2 increment int64

The increment (or delta) between two neighboring allowed values.

3 unit optional string

The unit corresponding to the value. We typically use SI units.

message IntrinsicParams intrinsic/perception/proto/v1/intrinsic_params.proto

Internal camera parameters such as focal length and principal point.

Field Type Description
1 focal_length_x double

Focal length in horizontal direction. Required. The focal length is specified in pixels.

2 focal_length_y double

Focal length in vertical direction. Required. The focal length is specified in pixels.

3 principal_point_x double

Horizontal location of the principal point in the image plane. Required. The principal point is specified in pixels.

4 principal_point_y double

Vertical location of the principal point in the image plane. Required. The principal point is specified in pixels.

5 dimensions intrinsic_proto.perception.v1.Dimensions

The dimensions of the image plane.

message LatitudeLongitudeViewSpace intrinsic/perception/proto/v1/pose_range.proto

Defines a min/max range for latitude/longitude/roll angles.

Field Type Description
1 min_longitude double

Minimum rotation of the camera along longitude (in degree).

2 max_longitude double

Maximum rotation of the camera along longitude (in degree).

3 min_latitude double

Minimum rotation of the camera along latitude (in degree).

4 max_latitude double

Maximum rotation of the camera along latitude (in degree).

5 min_camera_roll double

Minimum camera roll angle (in degrees).

6 max_camera_roll double

Maximum camera roll angle (in degrees).

7 reference_rotation_x double

Optional. Reference rotation frame of the model to be trained. These parameters only influence from which angles the model is seen during training not the resulting poses during inference. The rotation is parameterized by angles around the x,y,z axis in degree.

8 reference_rotation_y double
9 reference_rotation_z double

message ListAvailableCamerasRequest intrinsic/perception/proto/v1/camera_service.proto

In the future, this proto may contain a filter property to specify which cameras should be returned by the function. This would allow us to differentiate between physical cameras connected to the system and cameras which are already instantiated on the server side. In addition one could add filtering options to only list cameras of a specific driver.

Field Type Description

message ListAvailableCamerasResponse intrinsic/perception/proto/v1/camera_service.proto

Field Type Description
1 camera_identifiers repeated intrinsic_proto.perception.v1.CameraIdentifier

A list of unique camera identifiers. These can be used to create a CameraConfig which is required during camera creation.

message MarkerObject intrinsic/perception/proto/v1/target.proto

Field Type Description
oneof type
1 ar_tag intrinsic_proto.perception.v1.MarkerObject.ARTag
2 charuco_pattern intrinsic_proto.perception.v1.CharucoPattern

message MeshObject intrinsic/perception/proto/v1/target.proto

Field Type Description
1 filename string

Path to a mesh. Preferrably a glb file.

2 target_t_mesh optional intrinsic_proto.Affine3d

Initial translation, rotation, and scaling of the mesh in target coordinates.

message PoseEstimateInRoot intrinsic/perception/proto/v1/pose_estimate_in_root.proto

A pose estimate in the root frame for skill APIs.

Field Type Description
1 root_t_target intrinsic_proto.Pose

Pose of the object relative to the root object.

2 score double

Between 0..1.

3 id string

Class id of the estimate.

4 visibility_score optional float

Visibility score for the pose. Between 0..1. The visibility score indicates the proportion of the object that is visible, signifying their foreground presence. It helps in prioritizing the selection of parts during, for example, the picking process. It is defined as: Visible pixels / (Visible pixels + Occluded pixels)

message PoseEstimationConfig intrinsic/perception/proto/v1/pose_estimation_config.proto

Field Type Description
1 targets repeated intrinsic_proto.perception.v1.Target

A list of targets that the pose estimator should detect.

2 params google.protobuf.Any

Pose-estimator-specific training configuration.

3 inference_params google.protobuf.Any

Pose-estimator-specific inference configuration.

4 intrinsic_params intrinsic_proto.perception.v1.IntrinsicParams

Intrinsic camera parameters. This parameter might be required depending on the selected pose estimator; see individual pose estimator types for details.

5 origin optional string

String indicating the source of the config, such as a GCS path or ml job name.

message PoseRange intrinsic/perception/proto/v1/pose_range.proto

Encodes prior knowledge about the pose of an object.

Field Type Description
4 min_distance float

Minimal distance of the object's origin to the camera in meters.

5 max_distance float

Maximal distance of the object's origin to the camera in meters.

oneof view_space
1 icosahedron intrinsic_proto.perception.v1.Icosahedron

Encodes icosahedron vertices which represent individual views.

2 hemisphere intrinsic_proto.perception.v1.Hemisphere

Encodes all views of a hemisphere.

3 latitude_longitude_view_space intrinsic_proto.perception.v1.LatitudeLongitudeViewSpace

View space parameterization using latitude/longitude parameterization.

message ReadCameraSettingAccessRequest intrinsic/perception/proto/v1/camera_service.proto

Field Type Description
1 camera_identifier intrinsic_proto.perception.v1.CameraIdentifier

The identifier of the camera from which setting access is read.

2 name string

The setting name. The setting name must be defined by the Standard Feature Naming Conventions (SFNC) which is part of the GenICam standard.

message ReadCameraSettingAccessResponse intrinsic/perception/proto/v1/camera_service.proto

Field Type Description
1 access intrinsic_proto.perception.v1.CameraSettingAccess

The access mode of a specific setting.

message ReadCameraSettingPropertiesRequest intrinsic/perception/proto/v1/camera_service.proto

Field Type Description
1 camera_identifier intrinsic_proto.perception.v1.CameraIdentifier

The identifier of the camera from which setting properties are read.

2 name string

The setting name. The setting name must be defined by the Standard Feature Naming Conventions (SFNC) which is part of the GenICam standard.

message ReadCameraSettingPropertiesResponse intrinsic/perception/proto/v1/camera_service.proto

Field Type Description
1 properties intrinsic_proto.perception.v1.CameraSettingProperties

The properties of a specific setting. For numeric properties (integer and float), these include the valid range of parameters, their increment and their unit. For enumerations the properties contain the values (as strings) which can be set.

message ReadCameraSettingRequest intrinsic/perception/proto/v1/camera_service.proto

Field Type Description
1 camera_identifier intrinsic_proto.perception.v1.CameraIdentifier

The identifier of the camera from which the setting is read.

2 name string

The setting name. The setting name must be defined by the Standard Feature Naming Conventions (SFNC) which is part of the GenICam standard.

message ReadCameraSettingResponse intrinsic/perception/proto/v1/camera_service.proto

Field Type Description
1 setting intrinsic_proto.perception.v1.CameraSetting

The current values of a specific setting. The following types of settings are supported int64, double, bool, string or an enum value.

message RevolutionSymmetryWithoutRotoReflection (Nested in intrinsic_proto.perception.v1.Symmetry ) intrinsic/perception/proto/v1/symmetry.proto

Field Type Description
1 center intrinsic_proto.Vector3

Required symmetry center.

2 axis intrinsic_proto.Vector3

Required normalized symmetry axis.

message SaveTrainingJobRequest intrinsic/perception/proto/v1/train_service.proto

Field Type Description
1 name string

The name of the training job to save.

2 asset_id intrinsic_proto.assets.Id

The ID of the data asset that will be updated. If package is not set, the default package will be used (ai.intrinsic).

message SaveTrainingJobResponse intrinsic/perception/proto/v1/train_service.proto

Field Type Description
1 id_version intrinsic_proto.assets.IdVersion

The ID of the created data asset.

message SensorConfig intrinsic/perception/proto/v1/sensor_config.proto

Specification of a single sensor within a camera. This includes intrinsic calibration (including distortion params) and sensor pose relative to the device coordinate system. Minimal specification includes sensor ID only.

Field Type Description
1 id int64

ComponentIDValue or 0 for GenICam, sensor number for other cameras (e.g. IPS PU)

2 camera_t_sensor optional intrinsic_proto.Pose

Transforms the sensor data into the reference coordinate system of the camera.

3 camera_params optional intrinsic_proto.perception.v1.CameraParams

Sensor camera parameters.

message SensorConfigs intrinsic/perception/proto/v1/sensor_config.proto

Field Type Description
1 sensor_configs repeated intrinsic_proto.perception.v1.SensorConfig

message SensorImage intrinsic/perception/proto/v1/sensor_image.proto

Contains an image from a single sensor on a multiframe camera.

Field Type Description
1 sensor_config intrinsic_proto.perception.v1.SensorConfig

Configuration (calibration) for the sensor

2 acquisition_time google.protobuf.Timestamp

Timestamp at which the image was captured

3 buffer intrinsic_proto.perception.v1.ImageBuffer

Frame data

message SensorImagePostProcessing intrinsic/perception/proto/v1/post_processing.proto

Post processing options for requested sensor images.

Order of operations: raw image -> undistortion -> cropping -> resizing

Field Type Description
1 image_encoding intrinsic_proto.perception.v1.Encoding

Specifies how the returned image should be encoded.

2 skip_undistortion bool

If true, the returned image will be distorted. If false, the returned image might be undistorted depending whether the camera has undistortion parameters defined.

3 crop optional intrinsic_proto.perception.v1.CropOptions

Optionally crops the image. Note that cropping happens after undistortion but before resizing.

oneof resizing
4 resize intrinsic_proto.perception.v1.Dimensions

Resize dimensions.

5 resize_width int32

Resize width. Height is set automatically to aspect ratio.

6 resize_height int32

Resize height. Width is set automatically to aspect ratio.

message SensorInformation intrinsic/perception/proto/v1/camera_service.proto

Field Type Description
1 id int64

ComponentIDValue or 0 for Genicam, sensor number for other cameras (e.g. IPS PU)

2 display_name string

A human readable display name.

3 factory_camera_params optional intrinsic_proto.perception.v1.CameraParams

Sensor camera parameters from factory

4 camera_t_sensor optional intrinsic_proto.Pose

Transforms the sensor data into the reference coordinate system of the camera.

5 supported_pixel_types repeated intrinsic_proto.perception.v1.PixelType

Supported pixel types

6 dimensions intrinsic_proto.perception.v1.Dimensions

Dimensions of sensor output

7 disabled bool

Is sensor currently disabled

message SphericalSymmetry (Nested in intrinsic_proto.perception.v1.Symmetry ) intrinsic/perception/proto/v1/symmetry.proto

Field Type Description
1 center intrinsic_proto.Vector3

Required symmetry center.

message Symmetry intrinsic/perception/proto/v1/symmetry.proto

Symmetries as defined at https://arxiv.org/pdf/1612.04631.pdf

Field Type Description
oneof symmetry
1 finite_non_trivial_symmetry intrinsic_proto.perception.v1.Symmetry.FiniteNonTrivialSymmetry
2 revolution_symmetry_without_rotoreflection intrinsic_proto.perception.v1.Symmetry.RevolutionSymmetryWithoutRotoReflection
3 spherical_symmetry intrinsic_proto.perception.v1.Symmetry.SphericalSymmetry

message Target intrinsic/perception/proto/v1/target.proto

Defines a target object to detect.

Field Type Description
1 id string

Id will be reported back to the client to identify this object. May encode class and object id in the following way: {class}/{object_id}, for example "chair/grey_chair0".

4 pose_range intrinsic_proto.perception.v1.PoseRange

Restricts the pose range (orientation and position) of the object. Note: This serves as a hint during training but won't guarantee that all poses are from that pose range; poses outside the pose range may still be detected and returned to the client.

5 symmetry repeated intrinsic_proto.perception.v1.Symmetry

Stores symmetry type and related parameters such as symmetry axis.

oneof Type
2 mesh intrinsic_proto.perception.v1.MeshObject
3 marker intrinsic_proto.perception.v1.MarkerObject
6 scene_object intrinsic_proto.scene_object.v1.SceneObject

message Targets intrinsic/perception/proto/v1/target.proto

Defines a list of targets.

Field Type Description
1 targets repeated intrinsic_proto.perception.v1.Target

message TrainingJobStatus intrinsic/perception/proto/v1/train_service.proto

Meta data field (returned in google.longrunning.Operation):

Field Type Description
1 progress optional float

Progress indicator of the training job between [0, 1]. Not all training jobs provide this information.

2 custom_data optional google.protobuf.Any

Custom data attached by the caller during CreateTrainingJob.

3 create_time google.protobuf.Timestamp

Timestamp when this job was submitted for training.

4 asset_id intrinsic_proto.assets.Id

Asset ID that is associated with the training job.

message UpdateCameraSettingRequest intrinsic/perception/proto/v1/camera_service.proto

Field Type Description
1 camera_identifier intrinsic_proto.perception.v1.CameraIdentifier

The identifier of the camera on which settings are updated.

2 setting intrinsic_proto.perception.v1.CameraSetting

The settings values which will be used to for a parameter update.

message UpdateCameraSettingResponse intrinsic/perception/proto/v1/camera_service.proto

The response for setting camera parameters. This is currently a mere placeholder for future response values.

Field Type Description

message VerifyTrainingJobResponse intrinsic/perception/proto/v1/train_service.proto

Field Type Description
1 status repeated intrinsic_proto.status.ExtendedStatus

Repeated list of potential issues with the provided training configuration.

Enums

enum ArucoDictionary intrinsic/perception/proto/v1/charuco_pattern.proto

Name Number Description
DICT_ARUCO_ORIGINAL 0
DICT_4X4_50 1
DICT_4X4_100 2
DICT_4X4_250 3
DICT_4X4_1000 4
DICT_5X5_50 5
DICT_5X5_100 6
DICT_5X5_250 7
DICT_5X5_1000 8
DICT_6X6_50 9
DICT_6X6_100 10
DICT_6X6_250 11
DICT_6X6_1000 12
DICT_7X7_50 13
DICT_7X7_100 14
DICT_7X7_250 15
DICT_7X7_1000 16

enum DataType intrinsic/perception/proto/v1/image_buffer.proto

The underlying core component type of a pixel.

Name Number Description
TYPE_UNSPECIFIED 0

go/unspecified-enum

TYPE_UINT8 1

uint8_t

TYPE_UINT16 2

uint16_t

TYPE_UINT32 3

uint32_t

TYPE_INT8 4

int8_t

TYPE_INT16 5

int16_t

TYPE_INT32 6

int32_t

TYPE_FLOAT32 7

float

TYPE_FLOAT64 8

double

enum Encoding intrinsic/perception/proto/v1/image_buffer.proto

How the image is encoded / compressed. An unspecified encoding corresponds to uncompressed image data.

Name Number Description
ENCODING_UNSPECIFIED 0

uncompressed data, go/unspecified-enum

ENCODING_JPEG 1

JPG compression

ENCODING_PNG 2

PNG compression

ENCODING_WEBP 3

WEBP compression

ENCODING_YUV420P 4

YUV420P colorspace

enum Hemisphere intrinsic/perception/proto/v1/pose_range.proto

Encodes hemisphere in a configurable direction.

Name Number Description
HEMISPHERE_UNKNOWN 0
HEMISPHERE_POSITIVE_X 1
HEMISPHERE_NEGATIVE_X 2
HEMISPHERE_POSITIVE_Y 3
HEMISPHERE_NEGATIVE_Y 4
HEMISPHERE_POSITIVE_Z 5
HEMISPHERE_NEGATIVE_Z 6
HEMISPHERE_ALL 7

enum Mode intrinsic/perception/proto/v1/camera_settings.proto

The actual access mode, can be used as bit flags for read and write access.

Name Number Description
UNSUPPORTED 0
READ 1
WRITE 2
READ_WRITE 3

enum PackingType intrinsic/perception/proto/v1/image_buffer.proto

The packing type specifies how the pixels are packed, whether interleaved, or planar. For single-channel images, interleaved and planar are identical.

Name Number Description
PACKING_TYPE_UNSPECIFIED 0

go/unspecified-enum

PACKING_TYPE_INTERLEAVED 1

Pixel channels are stored interleaved, e.g., rgbrgbrgb… for RGB images.

PACKING_TYPE_PLANAR 2

Pixel channels are stored in separate planes, e.g., rrrr…rrrbbb…bbbggg…ggg

enum PixelType intrinsic/perception/proto/v1/image_buffer.proto

The pixel type together with the data type fully specifies the concept of a pixel. It makes it possible to differentiate pixels semantically, e.g. mere intensity value (e.g. heat) vs. a depth value (i.e. distance to camera).

Name Number Description
PIXEL_UNSPECIFIED 0

go/unspecified-enum

PIXEL_INTENSITY 1

Used for 1- and 3-channel intensity images.

PIXEL_DEPTH 2

Used for depth images.

PIXEL_POINT 3

Used for 3D point clouds.

PIXEL_NORMAL 4

Used for normals.

enum PoseEstimatorType intrinsic/perception/proto/v1/train_service.proto

Name Number Description
POSE_ESTIMATOR_TYPE_UNSPECIFIED 0
POSE_ESTIMATOR_TYPE_EDGE_BASED 1
POSE_ESTIMATOR_TYPE_SURFACE_BASED 2
POSE_ESTIMATOR_TYPE_SINGLE_VIEW_ML 3
POSE_ESTIMATOR_TYPE_MULTI_VIEW_ML 4
POSE_ESTIMATOR_TYPE_ONE_SHOT 5