Viam SDK
    Preparing search index...

    Class Detection3D

    Detection3D is one perceived object, described as a tree of transforms. transforms[0] is the root, parented to a frame the robot already knows (e.g. the camera). Each later transform's parent is the root or an earlier entry. Each physical_object is expressed relative to its own transform's origin.

    from message viam.service.vision.v1.Detection3D

    Hierarchy

    Index
    classifications: visionApi.Classification[]

    class hypotheses for the object

    from field: repeated viam.service.vision.v1.Classification classifications = 2;

    metadata?: Struct

    implementation-specific data, e.g. source camera or model name

    from field: google.protobuf.Struct metadata = 99;

    transforms: commonApi.Transform[]

    frame tree of this object, root first

    from field: repeated viam.common.v1.Transform transforms = 1;

    fields: FieldList
    runtime: ProtoRuntime
    typeName: "viam.service.vision.v1.Detection3D"
    • Parse from binary data, merging fields.

      Repeated fields are appended. Map entries are added, overwriting existing keys.

      If a message field is already present, it will be merged with the new data.

      Parameters

      • bytes: Uint8Array
      • Optionaloptions: Partial<BinaryReadOptions>

      Returns this

    • Parse a message from a JSON value.

      Parameters

      • jsonValue: JsonValue
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

    • Parse a message from a JSON string.

      Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

    • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

      Returns MessageType<visionApi.Detection3D>

    • Serialize the message to binary data.

      Parameters

      • Optionaloptions: Partial<BinaryWriteOptions>

      Returns Uint8Array

    • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

      Parameters

      • Optionaloptions: Partial<JsonWriteOptions>

      Returns JsonValue

    • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

      Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

      This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

      Returns JsonValue

    • Serialize the message to a JSON string.

      Parameters

      • Optionaloptions: Partial<JsonWriteStringOptions>

      Returns string

    • Parameters

      • bytes: Uint8Array
      • Optionaloptions: Partial<BinaryReadOptions>

      Returns visionApi.Detection3D

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns visionApi.Detection3D