Cloud AutoML V1beta1 Client - Class VideoObjectTrackingAnnotation (1.6.3)

Reference documentation and code samples for the Cloud AutoML V1beta1 Client class VideoObjectTrackingAnnotation.

Annotation details for video object tracking.

Generated from protobuf message google.cloud.automl.v1beta1.VideoObjectTrackingAnnotation

Namespace

Google \ Cloud \ AutoMl \ V1beta1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ instance_id string

Optional. The instance of the object, expressed as a positive integer. Used to tell apart objects of the same type (i.e. AnnotationSpec) when multiple are present on a single example. NOTE: Instance ID prediction quality is not a part of model evaluation and is done as best effort. Especially in cases when an entity goes off-screen for a longer time (minutes), when it comes back it may be given a new instance ID.

↳ time_offset Google\Protobuf\Duration

Required. A time (frame) of a video to which this annotation pertains. Represented as the duration since the video's start.

↳ bounding_box Google\Cloud\AutoMl\V1beta1\BoundingPoly

Required. The rectangle representing the object location on the frame (i.e. at the time_offset of the video).

↳ score float

Output only. The confidence that this annotation is positive for the video at the time_offset, value in [0, 1], higher means higher positivity confidence. For annotations created by the user the score is 1. When user approves an annotation, the original float score is kept (and not changed to 1).

getInstanceId

Optional. The instance of the object, expressed as a positive integer. Used to tell apart objects of the same type (i.e. AnnotationSpec) when multiple are present on a single example.

NOTE: Instance ID prediction quality is not a part of model evaluation and is done as best effort. Especially in cases when an entity goes off-screen for a longer time (minutes), when it comes back it may be given a new instance ID.

Returns
Type Description
string

setInstanceId

Optional. The instance of the object, expressed as a positive integer. Used to tell apart objects of the same type (i.e. AnnotationSpec) when multiple are present on a single example.

NOTE: Instance ID prediction quality is not a part of model evaluation and is done as best effort. Especially in cases when an entity goes off-screen for a longer time (minutes), when it comes back it may be given a new instance ID.

Parameter
Name Description
var string
Returns
Type Description
$this

getTimeOffset

Required. A time (frame) of a video to which this annotation pertains.

Represented as the duration since the video's start.

Returns
Type Description
Google\Protobuf\Duration|null

hasTimeOffset

clearTimeOffset

setTimeOffset

Required. A time (frame) of a video to which this annotation pertains.

Represented as the duration since the video's start.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getBoundingBox

Required. The rectangle representing the object location on the frame (i.e.

at the time_offset of the video).

Returns
Type Description
Google\Cloud\AutoMl\V1beta1\BoundingPoly|null

hasBoundingBox

clearBoundingBox

setBoundingBox

Required. The rectangle representing the object location on the frame (i.e.

at the time_offset of the video).

Parameter
Name Description
var Google\Cloud\AutoMl\V1beta1\BoundingPoly
Returns
Type Description
$this

getScore

Output only. The confidence that this annotation is positive for the video at the time_offset, value in [0, 1], higher means higher positivity confidence. For annotations created by the user the score is 1. When user approves an annotation, the original float score is kept (and not changed to 1).

Returns
Type Description
float

setScore

Output only. The confidence that this annotation is positive for the video at the time_offset, value in [0, 1], higher means higher positivity confidence. For annotations created by the user the score is 1. When user approves an annotation, the original float score is kept (and not changed to 1).

Parameter
Name Description
var float
Returns
Type Description
$this