1. class
  2. Biigle
  3. \
  4. Modules
  5. \
  6. Laserpoints
  7. \
  8. Image

Image

class Image extends Image

Extends the base Biigle image.

Traits

HasJsonAttributes
HasFactory

Constants

MIMES

Allowed image MIME types.
LASERPOINTS_ATTRIBUTE

Name of the attribute that stores the laser points information in the image 'attrs' object.
MIN_MANUAL_POINTS

Minimum number of required manual laser point annotations per image.
MAX_MANUAL_POINTS

Maximum number of supported manual laser point annotations per image.

Properties

bool $timestamps

Don't maintain timestamps for this model.

 from  VolumeFile
protected array $hidden

The attributes hidden in the model's JSON form.

 from  Image
protected array $casts

The attributes that should be casted to native types.

 from  Image
static private array $infoParams

Properties of the laser points object.

Methods

setJsonAttr(string $key, mixed $value, string $attrs = 'attrs')

Set a dynamic JSON attribute.

from  HasJsonAttributes
mixed
getJsonAttr(string $key, mixed $default = null, string $attrs = 'attrs')

Get a dynamic JSON attribute.

from  HasJsonAttributes
string
getUrlAttribute()

Adds the url attribute to the model. The url is the absolute path to the original file.

from  VolumeFile
string
getUrl()

Get the file URL.

from  VolumeFile
BelongsTo
volume()

The volume this video belongs to.

from  VolumeFile
setMetadataAttribute(array $value)

Set the metadata attribute.

from  VolumeFile
array
getMetadataAttribute()

Get the metadata attribute.

from  VolumeFile
setWidthAttribute(int $value)

Set the width attribute.

from  VolumeFile
int|null
getWidthAttribute()

Get the width attribute.

from  VolumeFile
setHeightAttribute(int $value)

Set the height attribute.

from  VolumeFile
int|null
getHeightAttribute()

Get the height attribute.

from  VolumeFile
setSizeAttribute(int $value)

Set the size attribute.

from  VolumeFile
int|null
getSizeAttribute()

Get the size attribute.

from  VolumeFile
string
getMimeTypeAttribute()

Get the mimeType attribute.

from  VolumeFile
setMimeTypeAttribute(string $value)

Set the mimeType attribute.

from  VolumeFile
string
getThumbnailUrlAttribute()

URL to the thumbnail of this image.

from  Image
HasMany
labels()

The labels, this image got attached by the users.

from  Image
HasMany
annotations()

The annotations on this image.

from  Image
Response
getFile()

Get the original image as download response.

from  Image
setTilingInProgressAttribute(bool $value)

Set the tilingInProgress attribute.

from  Image
bool|null
getTilingInProgressAttribute()

Get the tilingInProgress attribute.

from  Image
static Image
convert(Image $image)

Converts a regular Biigle image to a Laserpoints image.

array
getLaserpointsAttribute()

Return the dynamic attribute for the laser points information.

setLaserpointsAttribute(array $value)

Set or update the dynamic attribute for the laser points information.

float
getAreaAttribute()

Get the area attribute from the laser point detection.

int
getCountAttribute()

Get the count attribute from the laser point detection.

string
getMethodAttribute()

Get the method attribute from the laser point detection.

float
getDistanceAttribute()

Get the distance attribute from the laser point detection.

array
getPointsAttribute()

Get the points attribute from the laser point detection.

bool
getErrorAttribute()

Get the error attribute from the laser point detection.

bool
getMessageAttribute()

Get the message attribute from the lase point detection.

bool
readyForManualDetection(Label $label)

Determines if this image has a valid number of manually annotated laser points.

mixed
accessLaserpointsArray(string $key)

Get an attribute from the laser points array.

Details

in HasJsonAttributes at line 16
protected setJsonAttr(string $key, mixed $value, string $attrs = 'attrs')

Set a dynamic JSON attribute.

Parameters

string $key

Key of the attribute in the JSON.
mixed $value

Value of the attribute in the JSON.
string $attrs

Name of the JSON column of the model.

in HasJsonAttributes at line 38
protected mixed getJsonAttr(string $key, mixed $default = null, string $attrs = 'attrs')

Get a dynamic JSON attribute.

Parameters

string $key

Key of the attribute in the JSON.
mixed $default

Default value.
string $attrs

Name of the JSON column of the model.

Return Value

mixed

in VolumeFile at line 27
string getUrlAttribute()

Adds the url attribute to the model. The url is the absolute path to the original file.

Return Value

string

in VolumeFile at line 35
string getUrl()

Get the file URL.

This may be a remote URL starting with "http://" or "https://", or a storage disk path starting with "[disk-name]://".

Return Value

string

in VolumeFile at line 45
BelongsTo volume()

The volume this video belongs to.

Return Value

BelongsTo

in VolumeFile at line 55
setMetadataAttribute(array $value)

Set the metadata attribute.

Parameters

array $value

in VolumeFile at line 65
array getMetadataAttribute()

Get the metadata attribute.

Return Value

array

in VolumeFile at line 75
setWidthAttribute(int $value)

Set the width attribute.

Parameters

int $value

in VolumeFile at line 85
int|null getWidthAttribute()

Get the width attribute.

Return Value

int|null

in VolumeFile at line 95
setHeightAttribute(int $value)

Set the height attribute.

Parameters

int $value

in VolumeFile at line 105
int|null getHeightAttribute()

Get the height attribute.

Return Value

int|null

in VolumeFile at line 115
setSizeAttribute(int $value)

Set the size attribute.

Parameters

int $value

in VolumeFile at line 125
int|null getSizeAttribute()

Get the size attribute.

Return Value

int|null

in VolumeFile at line 135
string getMimeTypeAttribute()

Get the mimeType attribute.

Return Value

string

in VolumeFile at line 145
setMimeTypeAttribute(string $value)

Set the mimeType attribute.

Parameters

string $value

in Image at line 149
string getThumbnailUrlAttribute()

URL to the thumbnail of this image.

Return Value

string

in Image at line 65
HasMany labels()

The labels, this image got attached by the users.

Return Value

HasMany

in Image at line 55
HasMany annotations()

The annotations on this image.

Return Value

HasMany

in Image at line 75
Response getFile()

Get the original image as download response.

Return Value

Response

in Image at line 129
setTilingInProgressAttribute(bool $value)

Set the tilingInProgress attribute.

Parameters

bool $value

in Image at line 139
bool|null getTilingInProgressAttribute()

Get the tilingInProgress attribute.

Return Value

bool|null

at line 61
static Image convert(Image $image)

Converts a regular Biigle image to a Laserpoints image.

Parameters

Image $image

Regular Biigle image instance

Return Value

Image

at line 75
array getLaserpointsAttribute()

Return the dynamic attribute for the laser points information.

Return Value

array

at line 85
setLaserpointsAttribute(array $value)

Set or update the dynamic attribute for the laser points information.

Parameters

array $value

The value to set

at line 103
float getAreaAttribute()

Get the area attribute from the laser point detection.

Return Value

float

at line 113
int getCountAttribute()

Get the count attribute from the laser point detection.

Return Value

int

at line 123
string getMethodAttribute()

Get the method attribute from the laser point detection.

Return Value

string

at line 133
float getDistanceAttribute()

Get the distance attribute from the laser point detection.

Return Value

float

at line 143
array getPointsAttribute()

Get the points attribute from the laser point detection.

Return Value

array

at line 153
bool getErrorAttribute()

Get the error attribute from the laser point detection.

Return Value

bool

at line 163
bool getMessageAttribute()

Get the message attribute from the lase point detection.

Return Value

bool

at line 176
bool readyForManualDetection(Label $label)

Determines if this image has a valid number of manually annotated laser points.

Parameters

Label $label

The laser point label.

Return Value

bool

Exceptions

Exception

at line 202
protected mixed accessLaserpointsArray(string $key)

Get an attribute from the laser points array.

Parameters

string $key

Return Value

mixed