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

Annotation

class Annotation extendsModel implementsAnnotation

An 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

Properties

protectedarray $hidden The attributes excluded from the model's JSON form.
protectedarray $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.

Builder
scopeWithLabel(Builder$query,Label$label)

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

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

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

BelongsTo
image()

The image, this annotation belongs to.

BelongsTo
shape()

The shape of this annotation.

HasMany
labels()

The labels, this annotation got assigned by the users.

array
getPoints()

Get the points array of the annotation.

Shape
getShape()

Get the shape of an annotation.

Image
getImage()

Get the image, the annotation belongs to.

Details

inHasPointsAttributeat line16
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 If the points array is invalid

inHasPointsAttributeat line57
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

at line45
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

at line72
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

at line87
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 line133
BelongsTo image()

The image, this annotation belongs to.

Return Value

BelongsTo

at line143
BelongsTo shape()

The shape of this annotation.

Return Value

BelongsTo

at line153
HasMany labels()

The labels, this annotation got assigned by the users.

Return Value

HasMany

at line161
array getPoints()

Get the points array of the annotation.

Return Value

array

at line169
Shape getShape()

Get the shape of an annotation.

Return Value

Shape

at line177
Image getImage()

Get the image, the annotation belongs to.

Return Value

Image