class AnnotationCandidate extends MaiaAnnotation

Traits

HasFactory

Properties

bool $timestamps

Don't maintain timestamps for this model.

from  MaiaAnnotation
protected array $casts

The attributes that should be casted to native types.

from  MaiaAnnotation
protected string $table

The table associated with the model.

Methods

validatePoints(array $points)

Validates a points array for the shape of this annotation.

setPointsAttribute(array $points)

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

BelongsTo
image()

The image, this MAIA annotation belongs to.

BelongsTo
shape()

The shape of this MAIA annotation.

BelongsTo
job()

The MAIA job, this MAIA anotation belongs to.

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.

BelongsTo
label()

The label that has been (maybe) attached to this candidate.

BelongsTo
annotation()

The annotation that was (maybe) created based on this candidate.

static Factory
newFactory()

Create a new factory instance for the model.

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 62
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 MaiaAnnotation at line 38
BelongsTo image()

The image, this MAIA annotation belongs to.

Return Value

BelongsTo

in MaiaAnnotation at line 48
BelongsTo shape()

The shape of this MAIA annotation.

Return Value

BelongsTo

in MaiaAnnotation at line 58
BelongsTo job()

The MAIA job, this MAIA anotation belongs to.

Return Value

BelongsTo

in MaiaAnnotation at line 66
array getPoints()

Get the points array of the annotation.

Return Value

array

in MaiaAnnotation at line 74
Shape getShape()

Get the shape of an annotation.

Return Value

Shape

in MaiaAnnotation at line 82
VolumeFile getFile()

Get the image/video, the annotation belongs to.

Return Value

VolumeFile

at line 23
BelongsTo label()

The label that has been (maybe) attached to this candidate.

Return Value

BelongsTo

at line 33
BelongsTo annotation()

The annotation that was (maybe) created based on this candidate.

Return Value

BelongsTo

at line 43
static protected Factory newFactory()

Create a new factory instance for the model.

Return Value

Factory