Volume
class Volume extends Volume
Extends the base Biigle volume.
Traits
Constants
IMAGE_FILE_REGEX |
Regular expression that matches the supported image file extensions. This regex allows optional HTTP query parameters after the file names, too. Example "image.jpg?raw=1". This may be required for remote images with services like Dropbox. |
VIDEO_FILE_REGEX |
Regular expression that matches the supported video file extensions. This regex allows optional HTTP query parameters after the file names, too. Example "video.mp4?raw=1". This may be required for remote files with services like Dropbox. |
MIN_DELPHI_IMAGES |
Minimum number of manually annotated images required for Delphi laser point
detection. |
Properties
protected list<string> | $fillable | The attributes that are mass assignable. |
from Volume |
$hidden | The attributes hidden from the model's JSON form. |
from Volume | |
protected array<string,string> | $casts | The attributes that should be casted to native types. |
from Volume |
Methods
Set a dynamic JSON attribute.
Get a dynamic JSON attribute.
Parses a comma separated list of filenames to an array.
Scope a query to all volumes that are accessible by a user.
Return a query for all users associated to this volume through projects.
The active annotation sessions of this volume (if any).
Returns the active annotation session of this volume for the given user.
Check if the given annotation session is in conflict with existing ones.
An image that can be used as unique thumbnail for this volume.
Several images or videos that can be used for the preview thumbnail of a volume.
Flush the cached information if this volume has images with GPS coordinates.
Set or update the dynamic attribute for the export area.
Removes items from the annotations array if the laser point annotations are invalid.
Determines if the images of this volume can be processed with Delphi.
Determines whether there are images with automatically detected laser points in this volume.
Details
in
HasJsonAttributes at line 16
protected
setJsonAttr(string $key, mixed $value, string $attrs = 'attrs')
Set a dynamic JSON attribute.
in
HasJsonAttributes at line 38
protected mixed
getJsonAttr(string $key, mixed $default = null, string $attrs = 'attrs')
Get a dynamic JSON attribute.
in
HasMetadataFile at line 18
abstract string
getMetadataFileDisk()
Get the name of the disk to store metadata files.
in
HasMetadataFile at line 20
bool
hasMetadata()
No description
in
HasMetadataFile at line 25
void
saveMetadata(UploadedFile $file)
No description
in
HasMetadataFile at line 35
VolumeMetadata|null
getMetadata()
No description
in
HasMetadataFile at line 67
void
deleteMetadata(bool $noUpdate = false)
No description
in
Volume at line 84
static array
parseFilesQueryString(string $string)
Parses a comma separated list of filenames to an array.
in
Volume at line 98
Builder
scopeAccessibleBy(Builder $query, User $user)
Scope a query to all volumes that are accessible by a user.
in
Volume at line 116
User,$this>
creator()
The user that created the volume.
in
Volume at line 126
MediaType,$this>
mediaType()
The media type of this volume.
in
Volume at line 136
Image,$this>
images()
The images belonging to this volume.
in
Volume at line 146
Video,$this>
videos()
The videos belonging to this volume.
in
Volume at line 156
files()
The images or videos belonging to this volume.
in
Volume at line 171
orderedImages()
deprecated
deprecated
The images belonging to this volume ordered by filename (ascending).
in
Volume at line 181
orderedFiles()
The images belonging to this volume ordered by filename (ascending).
in
Volume at line 191
Builder
users()
Return a query for all users associated to this volume through projects.
in
Volume at line 210
Project,$this>
projects()
The project(s), this volume belongs to.
in
Volume at line 220
AnnotationSession,$this>
annotationSessions()
The annotation sessions of this volume.
in
Volume at line 230
AnnotationSession,$this>
activeAnnotationSession()
The active annotation sessions of this volume (if any).
in
Volume at line 250
AnnotationSession|null
getActiveAnnotationSession(User $user)
Returns the active annotation session of this volume for the given user.
An annotation session may be active for a volume but it is only also active for a user, if the user belongs to the set of restricted users of the annotation session.
in
Volume at line 270
bool
hasConflictingAnnotationSession(AnnotationSession $session)
Check if the given annotation session is in conflict with existing ones.
A conflict exists if the active time period of two sessions overlaps.
in
Volume at line 297
bool
isRemote()
Check if the images of this volume come from a remote URL.
in
Volume at line 307
Image|null
getThumbnailAttribute()
An image that can be used as unique thumbnail for this volume.
in
Volume at line 319
string|null
getThumbnailUrlAttribute()
URL to the thumbnail image of this volume.
in
Volume at line 329
Collection
getThumbnailsAttribute()
Several images or videos that can be used for the preview thumbnail of a volume.
in
Volume at line 353
Collection
getThumbnailsUrlAttribute()
URLs to the thumbnail images of this volume.
in
Volume at line 361
flushThumbnailCache()
Flush the cache that stores the volume thumbnail.
in
Volume at line 371
bool
hasGeoInfo()
Check if the volume has some images with GPS coordinates.
in
Volume at line 379
flushGeoInfoCache()
Flush the cached information if this volume has images with GPS coordinates.
in
Volume at line 390
setUrlAttribute(string|null $value)
Set the url attribute of this volume.
in
Volume at line 405
setCreatingAsyncAttribute(bool $value)
Set the creating_async attribute of this volume.
in
Volume at line 417
bool
getCreatingAsyncAttribute()
Get the creating_async attribute of this volume.
in
Volume at line 427
?array
getExportAreaAttribute()
Return the dynamic attribute for the export area.
in
Volume at line 435
setExportAreaAttribute(array|null $value)
Set or update the dynamic attribute for the export area.
in
Volume at line 457
bool
hasTiledImages()
Check if the there are tiled images in this volume.
in
Volume at line 468
bool
isImageVolume()
Specifies whether the volume is an image volume.
in
Volume at line 478
bool
isVideoVolume()
Specifies whether the volume is a video volume.
in
Volume at line 496
protected string
getThumbnailsCacheKey()
Get the cache key for volume thumbnails.
in
Volume at line 506
protected string
getGeoInfoCacheKey()
Get the cache key for volume geo info.
in
FiltersInvalidLaserPoints at line 16
Filtered
filterInvalidLaserPoints(Collection $annotations)
Removes items from the annotations array if the laser point annotations are invalid.
at line 34
static Volume
convert(Volume $volume)
Converts a regular Biigle volume to a Laserpoints volume.
at line 50
readyForDelphiDetection(Label $label)
Determines if the images of this volume can be processed with Delphi.
at line 91
bool
hasDetectedLaserpoints()
Determines whether there are images with automatically detected laser points in this volume.