VideoAnnotation
class VideoAnnotation extends Annotation
Traits
Properties
| $hidden | The attributes excluded from the model's JSON form. |
from Annotation | |
| protected array<string,string> | $casts | The attributes that should be casted to native types. |
|
| int | $id | from Annotation | |
| array | $points | from Annotation | |
| string | $created_at | from Annotation | |
| int | $shape_id | from Annotation | |
| protected array<int,string> | $fillable | The attributes that are mass assignable. |
Methods
Validate the points and frames of this annotation.
Round the floats of the points array to 2 decimals before saving.
Counts number of distinct points
Scope a query to only include annotations that are visible for a certain user.
Scope a query to only include annotations that have a certain label attached.
Scope a query to only include annotations allowed by the session for the user.
The file, this annotation belongs to.
The labels, this annotation got assigned by the users.
Get the file_id attribute
The video, this annotation belongs to.
Get the interpolated points at a specific point of time.
Get the interpolated points of this annotation between the specified frames.
Get the points of this annotation prepared for interpolation.
Interpolate between two points arrays.
Convert the points array of a rectangle (frame) to points that can be interpolated.
Convert points that can be interpolated back to the points of a rectangle (frame).
Details
at line 90
validatePoints(array $points = [])
Validate the points and frames of this annotation.
at line 77
setPointsAttribute(array $points)
Round the floats of the points array to 2 decimals before saving.
This is a more than sufficient precision for annotation point coordinates and saves memory in the DB as well as when processing the annotations in PHP.
in
HasPointsAttribute at line 80
private int
countDistinctCoordinates(array $points)
Counts number of distinct points
in
Annotation at line 50
Builder
scopeVisibleFor(Builder $query, User $user)
Scope a query to only include annotations that are visible for a certain user.
in
Annotation at line 83
Builder
scopeWithLabel(Builder $query, Label $label)
Scope a query to only include annotations that have a certain label attached.
in
Annotation at line 103
Builder
scopeAllowedBySession(Builder $query, AnnotationSession $session, User $user)
Scope a query to only include annotations allowed by the session for the user.
at line 46
file()
The file, this annotation belongs to.
at line 64
labels()
The labels, this annotation got assigned by the users.
at line 56
int
getFileIdAttribute()
Get the file_id attribute
in
Annotation at line 184
Annotation>
shape()
The shape of this annotation.
in
Annotation at line 192
array
getPoints()
Get the points array of the annotation.
in
Annotation at line 200
Shape
getShape()
Get the shape of an annotation.
in
Annotation at line 208
VolumeFile
getFile()
Get the image/video, the annotation belongs to.
at line 38
VideoAnnotation>
video()
The video, this annotation belongs to.
at line 122
array
interpolatePoints(float $time)
Get the interpolated points at a specific point of time.
This method must be equivalent to the interpolatePoints function of the JavaScript annotation model!
at line 157
protected array
interpolateBetweenFrames(int $index1, int $index2, float $progress)
Get the interpolated points of this annotation between the specified frames.
at line 184
protected array
getInterpolationPoints()
Get the points of this annotation prepared for interpolation.
at line 207
protected array
interpolateNaive(array $from, array $to, float $progress)
Interpolate between two points arrays.
at line 220
protected array
rectangleToInterpolationPoints(array $points)
Convert the points array of a rectangle (frame) to points that can be interpolated.
at line 245
protected array
interpolationPointsToRectangle(array $points)
Convert points that can be interpolated back to the points of a rectangle (frame).