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

Annotation

abstract class Annotation extends Model implements 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 list<string> $hidden

The attributes excluded from the model's JSON form.
protected array<string, string> $casts

The attributes that should be casted to native types.
$labelBOTLabels

The additional labels suggested by the LabelBOT.
int $id
array $points
string $created_at
int $shape_id

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
int
countDistinctCoordinates(array $points)

Counts number of distinct points

from  HasPointsAttribute
static int
cachedCount()

Get the count of all annotations.

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.

Annotation>
file()

The file, this annotation belongs to.

AnnotationLabel, $this>
labels()

The labels, this annotation got assigned by the users.

int
getFileIdAttribute()

Get the file_id attribute

Shape, $this>
shape()

The shape of this annotation.

array
getPoints()

Get the points array of the annotation.

Shape
getShape()

Get the shape of an annotation.

VolumeFile
getFile()

Get the image/video, the annotation belongs to.

int
getId()

Get the ID of the annotation.

array
getLabelBOTLabelsAttribute()

Get the LabelBOT suggested labels.

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 68
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 HasPointsAttribute at line 80
private int countDistinctCoordinates(array $points)

Counts number of distinct points

Parameters

array $points

containing the coordinates

Return Value

int

number of distinct points *

at line 53
static int cachedCount()

Get the count of all annotations.

The value is cached for 1 hour.

Return Value

int

at line 66
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 line 99
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 line 119
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 179
abstract Annotation> file()

The file, this annotation belongs to.

Return Value

Annotation>

at line 186
abstract AnnotationLabel, $this> labels()

The labels, this annotation got assigned by the users.

Return Value

AnnotationLabel, $this>

at line 193
abstract int getFileIdAttribute()

Get the file_id attribute

Return Value

int

at line 200
Shape, $this> shape()

The shape of this annotation.

Return Value

Shape, $this>

at line 208
array getPoints()

Get the points array of the annotation.

Return Value

array

at line 216
Shape getShape()

Get the shape of an annotation.

Return Value

Shape

at line 224
VolumeFile getFile()

Get the image/video, the annotation belongs to.

Return Value

VolumeFile

at line 232
int getId()

Get the ID of the annotation.

Return Value

int

at line 242
array getLabelBOTLabelsAttribute()

Get the LabelBOT suggested labels.

Return Value

array