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

Image

class Image extendsImage

Extends the base Biigle image.

Traits

HasJsonAttributes

Constants

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 Image
protectedarray $hidden The attributes hidden in the model's JSON form. from Image
protectedarray $casts The attributes that should be casted to native types. from Image
protectedarray $dates The attributes that should be mutated to dates. from Image
staticprivatearray $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
getUrl()

Get the file URL.

from Image
BelongsTo
volume()

The volume, this image belongs to.

from Image
BelongsTo
annotations()

The annotations on this image.

from Image
HasMany
labels()

The labels, this image got attached by the users.

from Image
string
getUrlAttribute()

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

from Image
setMetadataAttribute(array$value)

Set the image metadata attribute.

from Image
array
getMetadataAttribute()

Get the image metadata attribute.

from Image
Response
getFile()

Get the original image as download response.

from Image
setWidthAttribute(int$value)

Set the width attribute.

from Image
int|null
getWidthAttribute()

Get the width attribute.

from Image
setHeightAttribute(int$value)

Set the height attribute.

from Image
int|null
getHeightAttribute()

Get the height attribute.

from Image
setSizeAttribute(int$value)

Set the size attribute.

from Image
int|null
getSizeAttribute()

Get the size attribute.

from Image
setMimetypeAttribute(string$value)

Set the mimetype attribute.

from Image
string|null
getMimetypeAttribute()

Get the mimetype attribute.

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

inHasJsonAttributesat line16
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.

inHasJsonAttributesat line38
protectedmixed 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

inImageat line60
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

inImageat line70
BelongsTo volume()

The volume, this image belongs to.

Return Value

BelongsTo

inImageat line80
BelongsTo annotations()

The annotations on this image.

Return Value

BelongsTo

inImageat line90
HasMany labels()

The labels, this image got attached by the users.

Return Value

HasMany

inImageat line101
string getUrlAttribute()

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

Return Value

string

inImageat line111
setMetadataAttribute(array$value)

Set the image metadata attribute.

Parameters

array $value

inImageat line121
array getMetadataAttribute()

Get the image metadata attribute.

Return Value

array

inImageat line131
Response getFile()

Get the original image as download response.

Return Value

Response

inImageat line173
setWidthAttribute(int$value)

Set the width attribute.

Parameters

int $value

inImageat line183
int|null getWidthAttribute()

Get the width attribute.

Return Value

int|null

inImageat line193
setHeightAttribute(int$value)

Set the height attribute.

Parameters

int $value

inImageat line203
int|null getHeightAttribute()

Get the height attribute.

Return Value

int|null

inImageat line213
setSizeAttribute(int$value)

Set the size attribute.

Parameters

int $value

inImageat line223
int|null getSizeAttribute()

Get the size attribute.

Return Value

int|null

inImageat line233
setMimetypeAttribute(string$value)

Set the mimetype attribute.

Parameters

string $value

inImageat line243
string|null getMimetypeAttribute()

Get the mimetype attribute.

Return Value

string|null

inImageat line253
setTilingInProgressAttribute(bool$value)

Set the tilingInProgress attribute.

Parameters

bool $value

inImageat line263
bool|null getTilingInProgressAttribute()

Get the tilingInProgress attribute.

Return Value

bool|null

at line61
staticImage convert(Image$image)

Converts a regular Biigle image to a Laserpoints image.

Parameters

Image $image Regular Biigle image instance

Return Value

Image

at line75
array getLaserpointsAttribute()

Return the dynamic attribute for the laser points information.

Return Value

array

at line85
setLaserpointsAttribute(array$value)

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

Parameters

array $value The value to set

at line103
float getAreaAttribute()

Get the area attribute from the laser point detection.

Return Value

float

at line113
int getCountAttribute()

Get the count attribute from the laser point detection.

Return Value

int

at line123
string getMethodAttribute()

Get the method attribute from the laser point detection.

Return Value

string

at line133
float getDistanceAttribute()

Get the distance attribute from the laser point detection.

Return Value

float

at line143
array getPointsAttribute()

Get the points attribute from the laser point detection.

Return Value

array

at line153
bool getErrorAttribute()

Get the error attribute from the laser point detection.

Return Value

bool

at line163
bool getMessageAttribute()

Get the message attribute from the lase point detection.

Return Value

bool

at line176
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 If the image has an invalid count of manually annotated laser points

at line202
protectedmixed accessLaserpointsArray(string$key)

Get an attribute from the laser points array.

Parameters

string $key

Return Value

mixed