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

HasFactory

Properties

$labelBOTLabels

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

Methods

array
casts()

Get the attributes that should be cast.

static int
estimatedCount()

Get an estimated count of all annotations from pg_class statistics.

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

at line 31
protected array casts()

Get the attributes that should be cast.

Return Value

array

at line 49
static int estimatedCount()

Get an estimated count of all annotations from pg_class statistics.

This is much faster than a full table scan of a large table.

See: https://wiki.postgresql.org/wiki/Count_estimate

Return Value

int

at line 64
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 97
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 117
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 177
abstract Annotation> file()

The file, this annotation belongs to.

Return Value

Annotation>

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

The labels, this annotation got assigned by the users.

Return Value

AnnotationLabel, $this>

at line 191
abstract int getFileIdAttribute()

Get the file_id attribute

Return Value

int

at line 198
Shape, $this> shape()

The shape of this annotation.

Return Value

Shape, $this>

at line 206
array getPoints()

Get the points array of the annotation.

Return Value

array

at line 214
Shape getShape()

Get the shape of an annotation.

Return Value

Shape

at line 222
VolumeFile getFile()

Get the image/video, the annotation belongs to.

Return Value

VolumeFile

at line 230
int getId()

Get the ID of the annotation.

Return Value

int

at line 240
array getLabelBOTLabelsAttribute()

Get the LabelBOT suggested labels.

Return Value

array