1. class
  2. Biigle
  3. \
  4. ImageAnnotation

ImageAnnotation

class ImageAnnotation extends Annotation

An image annotation is a region of an image that can be labeled by the users.

It consists of one or many points and has a specific shape.

Traits

HasPointsAttribute
HasFactory

Properties

protected array $hidden

The attributes excluded from the model's JSON form.

 from  Annotation
protected array $casts

The attributes that should be casted to native types.

Methods

validatePoints(array $points)

Validates a points array for the shape of this annotation.

from  HasPointsAttribute
setPointsAttribute(array $points)

Round the floats of the points array to 2 decimals before saving.

from  HasPointsAttribute
Builder
scopeVisibleFor(Builder $query, User $user)

Scope a query to only include annotations that are visible for a certain user.

from  Annotation
Builder
scopeWithLabel(Builder $query, Label $label)

Scope a query to only include annotations that have a certain label attached.

from  Annotation
Builder
scopeAllowedBySession(Builder $query, AnnotationSession $session, User $user)

Scope a query to only include annotations allowed by the session for the user.

from  Annotation
BelongsTo
file()

The file, this annotation belongs to.

HasMany
labels()

The labels, this annotation got assigned by the users.

int
getFileIdAttribute()

Get the file_id attribute

BelongsTo
shape()

The shape of this annotation.

from  Annotation
array
getPoints()

Get the points array of the annotation.

from  Annotation
Shape
getShape()

Get the shape of an annotation.

from  Annotation
VolumeFile
getFile()

Get the image/video, the annotation belongs to.

from  Annotation
BelongsTo
image()

The image, this annotation belongs to.

Details

in HasPointsAttribute at line 16
validatePoints(array $points)

Validates a points array for the shape of this annotation.

Parameters

array $points

Points array like [x1, y1, x2, y2, x3, y3, ...]

Exceptions

Exception

in HasPointsAttribute at line 64
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.

Parameters

array $points

in Annotation at line 45
Builder scopeVisibleFor(Builder $query, User $user)

Scope a query to only include annotations that are visible for a certain user.

Parameters

Builder $query
User $user

The user to whom the restrictions should apply ('own' user)

Return Value

Builder

in Annotation at line 78
Builder scopeWithLabel(Builder $query, Label $label)

Scope a query to only include annotations that have a certain label attached.

Parameters

Builder $query
Label $label

Return Value

Builder

in Annotation at line 98
Builder scopeAllowedBySession(Builder $query, AnnotationSession $session, User $user)

Scope a query to only include annotations allowed by the session for the user.

Parameters

Builder $query
AnnotationSession $session
User $user

The user to whom the restrictions should apply ('own' user)

Return Value

Builder

at line 39
BelongsTo file()

The file, this annotation belongs to.

Return Value

BelongsTo

at line 59
HasMany labels()

The labels, this annotation got assigned by the users.

Return Value

HasMany

at line 49
int getFileIdAttribute()

Get the file_id attribute

Return Value

int

in Annotation at line 179
BelongsTo shape()

The shape of this annotation.

Return Value

BelongsTo

in Annotation at line 187
array getPoints()

Get the points array of the annotation.

Return Value

array

in Annotation at line 195
Shape getShape()

Get the shape of an annotation.

Return Value

Shape

in Annotation at line 203
VolumeFile getFile()

Get the image/video, the annotation belongs to.

Return Value

VolumeFile

at line 29
BelongsTo image()

The image, this annotation belongs to.

Return Value

BelongsTo