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

HasFactory

Properties

$labelBOTLabels

The additional labels suggested by the LabelBOT.

from  Annotation
int $id from  Annotation
array $points from  Annotation
string $created_at from  Annotation
int $shape_id from  Annotation

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.

getShape()

Get the shape of an annotation.

getFile()

Get the image/video, the annotation belongs to.

int
getId()

Get the ID of the annotation.

array
getLabelBOTLabelsAttribute()

Get the LabelBOT suggested labels.

setPointsAttribute(array $points)

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

Image, $this>
image()

The image, this annotation belongs to.

Details

at line 20
protected array casts()

Get the attributes that should be cast.

Return Value

array

in Annotation 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

in Annotation 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

in Annotation 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

in Annotation 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 57
Annotation> file()

The file, this annotation belongs to.

Return Value

Annotation>

at line 75
AnnotationLabel, $this> labels()

The labels, this annotation got assigned by the users.

Return Value

AnnotationLabel, $this>

at line 67
int getFileIdAttribute()

Get the file_id attribute

Return Value

int

in Annotation at line 198
Shape, $this> shape()

The shape of this annotation.

Return Value

Shape, $this>

in Annotation at line 206
array getPoints()

Get the points array of the annotation.

Return Value

array

in Annotation at line 214
Shape getShape()

Get the shape of an annotation.

Return Value

Shape

in Annotation at line 222
VolumeFile getFile()

Get the image/video, the annotation belongs to.

Return Value

VolumeFile

in Annotation at line 230
int getId()

Get the ID of the annotation.

Return Value

int

in Annotation at line 240
array getLabelBOTLabelsAttribute()

Get the LabelBOT suggested labels.

Return Value

array

at line 37
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 line 49
Image, $this> image()

The image, this annotation belongs to.

Return Value

Image, $this>