ImageAnnotation
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
Properties
| $labelBOTLabels | The additional labels suggested by the LabelBOT. |
from Annotation | |
| int | $id | from Annotation | |
| array | $points | from Annotation | |
| string | $created_at | from Annotation | |
| Shape | $shape | from Annotation |
Methods
Get the attributes that should be cast.
Get an estimated count of all annotations from pg_class statistics.
Scope a query to only include annotations that are visible for a certain user.
Scope a query to only include annotations that have a certain label attached.
Scope a query to only include annotations allowed by the session for the user.
The file, this annotation belongs to.
The labels, this annotation got assigned by the users.
Get the file_id attribute
Round the floats of the points array to 2 decimals before saving.
The image, this annotation belongs to.
Details
at line 20
protected array
casts()
Get the attributes that should be cast.
in
Annotation at line 51
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.
in
Annotation at line 66
Builder
scopeVisibleFor(Builder $query, User $user)
Scope a query to only include annotations that are visible for a certain user.
in
Annotation at line 99
Builder
scopeWithLabel(Builder $query, Label $label)
Scope a query to only include annotations that have a certain label attached.
in
Annotation 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.
at line 55
Annotation>
file()
The file, this annotation belongs to.
at line 73
AnnotationLabel, $this>
labels()
The labels, this annotation got assigned by the users.
at line 65
int
getFileIdAttribute()
Get the file_id attribute
in
Annotation at line 198
array
getPoints()
Get the points array of the annotation.
in
Annotation at line 206
Shape
getShape()
Get the shape of an annotation.
in
Annotation at line 214
VolumeFile
getFile()
Get the image/video, the annotation belongs to.
in
Annotation at line 222
int
getId()
Get the ID of the annotation.
in
Annotation at line 232
array
getLabelBOTLabelsAttribute()
Get the LabelBOT suggested labels.
at line 35
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.
at line 47
Image, $this>
image()
The image, this annotation belongs to.