1. class
  2. Biigle
  3. \
  4. Jobs
  5. \
  6. TrackObject

TrackObject

class TrackObject extends Job implements ShouldQueue

Attempts to track an obect in a video. The object is initially defined by a video annotation. The annotation will be updated with the positions determined with the object tracking method.

Traits

SerializesModels
Queueable
Dispatchable

Properties

int $tries

The number of times the job may be attempted.
protected int $annotationId

The annotation ID that defines the initial object to track.
protected int $userId

The user ID who initialized the tracking request.

Methods

static string
getRateLimitCacheKey(int $userId)

Return the cache key to store the number of concurrent jobs for each user.

__construct(VideoAnnotation $annotation, User $user)

Create a new instance.

void
handle()

Execute the job.

array
getTrackingKeyframes(VideoAnnotation $annotation)

Execute the object tracking method and get the resulting annotation key frames.

string
getInputJsonPath(VideoAnnotation $annotation)

Get the path to to input file for the object tracking script.

string
createInputJson(VideoAnnotation $annotation, string $videoPath)

Create the JSON file that is the input for the object tracking script.

maybeDeleteFile(string $path)

Delete a file if it exists.

string
getOutputJsonPath(int $annotationId)

Get the path to to output file for the object tracking script.

string
python(string $command)

Execute a Python script.

array
getStartWindow(VideoAnnotation $annotation)

Get the coordinates and dimensions of the start window for the object tracking script.

array
getPointsFromKeyframe(VideoAnnotation $annotation, array $keyframe)

Get the points of a keyframe depending on the annotation shape.

decrementCacheValue()

Decrement the count of object tracking jobs.

Details

at line 55
static string getRateLimitCacheKey(int $userId)

Return the cache key to store the number of concurrent jobs for each user.

Parameters

int $userId

Return Value

string

at line 66
__construct(VideoAnnotation $annotation, User $user)

Create a new instance.

Parameters

VideoAnnotation $annotation

The annotation that defines the initial object to track.
User $user

The user who initialized the tracking request.

at line 77
void handle()

Execute the job.

Return Value

void

at line 123
protected array getTrackingKeyframes(VideoAnnotation $annotation)

Execute the object tracking method and get the resulting annotation key frames.

Parameters

VideoAnnotation $annotation

Return Value

array

Each element is an array containing the key frame time as first element and the points as the remaining elements.

at line 157
protected string getInputJsonPath(VideoAnnotation $annotation)

Get the path to to input file for the object tracking script.

Parameters

VideoAnnotation $annotation

Return Value

string

at line 170
protected string createInputJson(VideoAnnotation $annotation, string $videoPath)

Create the JSON file that is the input for the object tracking script.

Parameters

VideoAnnotation $annotation
string $videoPath

Path to the video file.

Return Value

string

Path to the JSON file.

at line 190
protected maybeDeleteFile(string $path)

Delete a file if it exists.

Parameters

string $path

at line 204
protected string getOutputJsonPath(int $annotationId)

Get the path to to output file for the object tracking script.

Parameters

int $annotationId

Return Value

string

at line 216
protected string python(string $command)

Execute a Python script.

Parameters

string $command

Command to execute.

Return Value

string

The last line of the stout output.

at line 239
protected array getStartWindow(VideoAnnotation $annotation)

Get the coordinates and dimensions of the start window for the object tracking script.

Parameters

VideoAnnotation $annotation

Return Value

array

at line 282
protected array getPointsFromKeyframe(VideoAnnotation $annotation, array $keyframe)

Get the points of a keyframe depending on the annotation shape.

Parameters

VideoAnnotation $annotation
array $keyframe

Return Value

array

at line 296
protected decrementCacheValue()

Decrement the count of object tracking jobs.