A

AddAbundanceReportTypeClass in namespace [Global Namespace]
AddImageCocoReportTypeClass in namespace [Global Namespace]
AddImageIfdoReportTypeClass in namespace [Global Namespace]
AddLocationReportTypesClass in namespace [Global Namespace]
AddReportsReadyAtColumnClass in namespace [Global Namespace]
AddVideoAnnotationReportTypeClass in namespace [Global Namespace]
AddVideoLabelReportTypeClass in namespace [Global Namespace]
AnnotationClass in namespace Biigle

An image annotation is a region of an image that can be labeled by the users.

AnnotationLabelClass in namespace Biigle
$ AnnotationLabel#annotation_idProperty in class AnnotationLabel
AnnotationLabel::annotation() — Method in class AnnotationLabel

The annotation, this annotation label belongs to.

AnnotationSessionClass in namespace Biigle

An annotation session groups multiple annotations of a volume based on their creation date.

$ AnnotationSession#appendsProperty in class AnnotationSession

The accessors to append to the model's array form.

AnnotationSession::annotations() — Method in class AnnotationSession

Get a query for all annotations that belong to this session.

AnnotationSession::allowsAccess() — Method in class AnnotationSession

Check if the given user is allowed to access the annotation if this annotation session is active.

AnnouncementClass in namespace Biigle

Announcements are broadcasts from the application administrators that should reach all users of the instance.

ApiTokenClass in namespace Biigle
ApidocClass in namespace Biigle\Console\Commands
AnnotationClass in namespace Biigle\Contracts

An annotation model.

AnnotationLabelAttachedClass in namespace Biigle\Events
$ ObjectTrackingFailed#annotationProperty in class ObjectTrackingFailed

The video annotation that finished tracking.

$ ObjectTrackingSucceeded#annotationProperty in class ObjectTrackingSucceeded

The video annotation that finished tracking.

AnnotationSessionControllerClass in namespace Biigle\Http\Controllers\Api
AnnotationControllerClass in namespace Biigle\Http\Controllers\Api\Annotations\Filters
AnnotationUserControllerClass in namespace Biigle\Http\Controllers\Api\Annotations\Filters
AnnouncementControllerClass in namespace Biigle\Http\Controllers\Api
ApiTokenControllerClass in namespace Biigle\Http\Controllers\Api
ProjectLabelTreeController::available() — Method in class ProjectLabelTreeController

Display all label trees that can be used by the specified project.

ProjectUserController::attach() — Method in class ProjectUserController

Adds a new user to the specified project.

ProjectVolumeController::attach() — Method in class ProjectVolumeController

Attaches the existing specified volume to the existing specified project.

UserRegistrationController::accept() — Method in class UserRegistrationController

Approves a user sign up.

AnnotationLabelControllerClass in namespace Biigle\Http\Controllers\Api\Volumes\Filters
AnyFileLabelControllerClass in namespace Biigle\Http\Controllers\Api\Volumes\Filters
LoginController::attemptLogin() — Method in class LoginController

Attempt to log the user into the application.

AnnouncementsControllerClass in namespace Biigle\Http\Controllers\Views\Admin
AnnotationToolControllerClass in namespace Biigle\Http\Controllers\Views\Annotations
DashboardController::annotationsActivityItems() — Method in class DashboardController

Get the most recently annotated images of a user.

SettingsController::account() — Method in class SettingsController

Shows the account settings.

SettingsController::authentication() — Method in class SettingsController

Shows the authentication settings.

AuthenticateClass in namespace Biigle\Http\Middleware
AuthenticateRegisterClass in namespace Biigle\Http\Middleware
$ VerifyCsrfToken#addHttpCookieProperty in class VerifyCsrfToken

Indicates whether the XSRF-TOKEN cookie should be set on the response.

AttachProjectUserClass in namespace Biigle\Http\Requests
AttachProjectUser::authorize() — Method in class AttachProjectUser

Determine if the user is authorized to make this request.

CloneVolume::authorize() — Method in class CloneVolume

Determine if the user is authorized to make this request.

$ DestroyAnnotationSession#annotationSessionProperty in class DestroyAnnotationSession

The annotation session that should be deleted.

DestroyAnnotationSession::authorize() — Method in class DestroyAnnotationSession

Determine if the user is authorized to make this request.

DestroyLabel::authorize() — Method in class DestroyLabel

Determine if the user is authorized to make this request.

DestroyLabelTree::authorize() — Method in class DestroyLabelTree

Determine if the user is authorized to make this request.

DestroyLabelTreeUser::authorize() — Method in class DestroyLabelTreeUser

Determine if the user is authorized to make this request.

DestroyLabelTreeVersion::authorize() — Method in class DestroyLabelTreeVersion

Determine if the user is authorized to make this request.

DestroyOwnUser::authorize() — Method in class DestroyOwnUser

Determine if the user is authorized to make this request.

DestroyPinnedProject::authorize() — Method in class DestroyPinnedProject

Determine if the user is authorized to make this request.

DestroyProjectUser::authorize() — Method in class DestroyProjectUser

Determine if the user is authorized to make this request.

DestroyUser::authorize() — Method in class DestroyUser

Determine if the user is authorized to make this request.

$ DestroyVideoAnnotationLabel#annotationLabelProperty in class DestroyVideoAnnotationLabel

The annotation label that should be deleted

DestroyVideoAnnotationLabel::authorize() — Method in class DestroyVideoAnnotationLabel

Determine if the user is authorized to make this request.

DestroyVolumeFile::authorize() — Method in class DestroyVolumeFile

Determine if the user is authorized to make this request.

JoinProjectInvitation::authorize() — Method in class JoinProjectInvitation

Determine if the user is authorized to make this request.

LinkVideoAnnotation::authorize() — Method in class LinkVideoAnnotation

Determine if the user is authorized to make this request.

$ SplitVideoAnnotation#annotationProperty in class SplitVideoAnnotation

The annotation that should be split.

SplitVideoAnnotation::authorize() — Method in class SplitVideoAnnotation

Determine if the user is authorized to make this request.

StoreAnnotationSession::authorize() — Method in class StoreAnnotationSession

Determine if the user is authorized to make this request.

StoreAnnouncement::authorize() — Method in class StoreAnnouncement

Determine if the user is authorized to make this request.

StoreFederatedSearchInstance::authorize() — Method in class StoreFederatedSearchInstance

Determine if the user is authorized to make this request.

StoreImageAnnotation::authorize() — Method in class StoreImageAnnotation

Determine if the user is authorized to make this request.

$ StoreImageAnnotationLabel#annotationProperty in class StoreImageAnnotationLabel

The annotation to which the label should be attached.

StoreImageAnnotationLabel::authorize() — Method in class StoreImageAnnotationLabel

Determine if the user is authorized to make this request.

StoreImageAnnotations::authorize() — Method in class StoreImageAnnotations

Determine if the user is authorized to make this request.

StoreLabel::authorize() — Method in class StoreLabel

Determine if the user is authorized to make this request.

StoreLabelTree::authorize() — Method in class StoreLabelTree

Determine if the user is authorized to make this request.

StoreLabelTreeAuthorizedProject::authorize() — Method in class StoreLabelTreeAuthorizedProject

Determine if the user is authorized to make this request.

StoreLabelTreeMerge::authorize() — Method in class StoreLabelTreeMerge

Determine if the user is authorized to make this request.

StoreLabelTreeUser::authorize() — Method in class StoreLabelTreeUser

Determine if the user is authorized to make this request.

StoreLabelTreeVersion::authorize() — Method in class StoreLabelTreeVersion

Determine if the user is authorized to make this request.

StorePendingVolume::authorize() — Method in class StorePendingVolume

Determine if the user is authorized to make this request.

StorePendingVolumeImport::authorize() — Method in class StorePendingVolumeImport

Determine if the user is authorized to make this request.

StorePinnedProject::authorize() — Method in class StorePinnedProject

Determine if the user is authorized to make this request.

StoreProject::authorize() — Method in class StoreProject

Determine if the user is authorized to make this request.

StoreProjectInvitation::authorize() — Method in class StoreProjectInvitation

Determine if the user is authorized to make this request.

StoreProjectLabelTree::authorize() — Method in class StoreProjectLabelTree

Determine if the user is authorized to make this request.

StoreUser::authorize() — Method in class StoreUser

Determine if the user is authorized to make this request.

StoreVideoAnnotation::authorize() — Method in class StoreVideoAnnotation

Determine if the user is authorized to make this request.

StoreVideoAnnotation::annotationContained() — Method in class StoreVideoAnnotation

Check if the point or circle annotation is fully contained by the video.

$ StoreVideoAnnotationLabel#annotationProperty in class StoreVideoAnnotationLabel

The annotation to which the label should be attached.

StoreVideoAnnotationLabel::authorize() — Method in class StoreVideoAnnotationLabel

Determine if the user is authorized to make this request.

StoreVolume::authorize() — Method in class StoreVolume

Determine if the user is authorized to make this request.

StoreVolumeFile::authorize() — Method in class StoreVolumeFile

Determine if the user is authorized to make this request.

StoreVolumeFileLabel::authorize() — Method in class StoreVolumeFileLabel

Determine if the user is authorized to make this request.

StoreVolumeMetadata::authorize() — Method in class StoreVolumeMetadata

Determine if the user is authorized to make this request.

$ UpdateAnnotationSession#annotationSessionProperty in class UpdateAnnotationSession

The annotation session that should be updated.

UpdateAnnotationSession::authorize() — Method in class UpdateAnnotationSession

Determine if the user is authorized to make this request.

UpdateFederatedSearchInstance::authorize() — Method in class UpdateFederatedSearchInstance

Determine if the user is authorized to make this request.

UpdateLabel::authorize() — Method in class UpdateLabel

Determine if the user is authorized to make this request.

UpdateLabelTree::authorize() — Method in class UpdateLabelTree

Determine if the user is authorized to make this request.

UpdateLabelTreeUser::authorize() — Method in class UpdateLabelTreeUser

Determine if the user is authorized to make this request.

UpdateLabelTreeVersion::authorize() — Method in class UpdateLabelTreeVersion

Determine if the user is authorized to make this request.

UpdateOwnUser::authorize() — Method in class UpdateOwnUser

Determine if the user is authorized to make this request.

UpdatePendingVolume::authorize() — Method in class UpdatePendingVolume

Determine if the user is authorized to make this request.

UpdatePendingVolumeAnnotationLabels::authorize() — Method in class UpdatePendingVolumeAnnotationLabels

Determine if the user is authorized to make this request.

UpdatePendingVolumeFileLabels::authorize() — Method in class UpdatePendingVolumeFileLabels

Determine if the user is authorized to make this request.

UpdatePendingVolumeLabelMap::authorize() — Method in class UpdatePendingVolumeLabelMap

Determine if the user is authorized to make this request.

UpdatePendingVolumeUserMap::authorize() — Method in class UpdatePendingVolumeUserMap

Determine if the user is authorized to make this request.

UpdateProject::authorize() — Method in class UpdateProject

Determine if the user is authorized to make this request.

UpdateProjectUser::authorize() — Method in class UpdateProjectUser

Determine if the user is authorized to make this request.

UpdateUser::authorize() — Method in class UpdateUser

Determine if the user is authorized to make this request.

$ UpdateUserSettings#additionalRulesProperty in class UpdateUserSettings

Additional validation rules that can be added during runtime.

UpdateUserSettings::addRule() — Method in class UpdateUserSettings

Add a new settings validation rule.

UpdateUserSettings::authorize() — Method in class UpdateUserSettings

Determine if the user is authorized to make this request.

$ UpdateVideoAnnotation#annotationProperty in class UpdateVideoAnnotation

The annotation that should be updated

UpdateVideoAnnotation::authorize() — Method in class UpdateVideoAnnotation

Determine if the user is authorized to make this request.

UpdateVolume::authorize() — Method in class UpdateVolume

Determine if the user is authorized to make this request.

Image::annotations() — Method in class Image

The annotations on this image.

ImageAnnotationLabel::annotation() — Method in class ImageAnnotationLabel

The annotation, this annotation label belongs to.

$ TrackObject#annotationProperty in class TrackObject

The annotation that defines the initial object to track.

LabelTree::addMember() — Method in class LabelTree

Add a new member with a certain role.

LabelTree::authorizedProjects() — Method in class LabelTree

The projects that are authorized to use this private label tree.

AnanasServiceProviderClass in namespace Biigle\Modules\Ananas
AnnotationAssistanceRequestClass in namespace Biigle\Modules\Ananas

With an annotation assistance request a BIIGLE user can consult some externa person for the label of a specific annotation.

AnnotationAssistanceRequest::annotation() — Method in class AnnotationAssistanceRequest

The annotation to which the assistance request belongs.

AnnotationAssistanceRequestFactoryClass in namespace Biigle\Modules\Ananas\Database\Factories
AnnotationAssistanceRequestControllerClass in namespace Biigle\Modules\Ananas\Http\Controllers\Api
AnnotationAssistanceRequestControllerClass in namespace Biigle\Modules\Ananas\Http\Controllers\Views
$ StoreAnnotationAssistanceRequest#annotationProperty in class StoreAnnotationAssistanceRequest

The annotation to create the request for.

StoreAnnotationAssistanceRequest::authorize() — Method in class StoreAnnotationAssistanceRequest

Determine if the user is authorized to make this request.

$ UpdateAnnotationAssistanceRequest#ananasProperty in class UpdateAnnotationAssistanceRequest

The request to update.

UpdateAnnotationAssistanceRequest::authorize() — Method in class UpdateAnnotationAssistanceRequest

Determine if the user is authorized to make this request.

AnnotationAssistanceRequestClass in namespace Biigle\Modules\Ananas\Notifications
AnnotationAssistanceResponseClass in namespace Biigle\Modules\Ananas\Notifications
AnnotationAssistanceRequestObserverClass in namespace Biigle\Modules\Ananas\Observers
AnnotationAssistanceRequestPolicyClass in namespace Biigle\Modules\Ananas\Policies
AnnotationAssistanceRequestPolicy::access() — Method in class AnnotationAssistanceRequestPolicy

Determine if the given assistance request can be accessed by the user.

StoreColorSortSequence::authorize() — Method in class StoreColorSortSequence

Determine if the user is authorized to make this request.

AnnotationCatalogControllerClass in namespace Biigle\Modules\Largo\Http\Controllers\Views\LabelTrees
IndexProjectAnnotationsSimilarity::authorize() — Method in class IndexProjectAnnotationsSimilarity

Determine if the user is authorized to make this request.

IndexVolumeAnnotationsSimilarity::authorize() — Method in class IndexVolumeAnnotationsSimilarity

Determine if the user is authorized to make this request.

StoreLargoSession::authorize() — Method in class StoreLargoSession

Determine if the user is authorized to make this request.

StoreProjectLargoSession::authorize() — Method in class StoreProjectLargoSession

Determine if the user is authorized to make this request.

StoreVolumeLargoSession::authorize() — Method in class StoreVolumeLargoSession

Determine if the user is authorized to make this request.

ApplyLargoSessionClass in namespace Biigle\Modules\Largo\Jobs
ApplyLargoSession::applyDismissedLabels() — Method in class ApplyLargoSession

Detach annotation labels that were dismissed in a Largo session.

ApplyLargoSession::applyChangedLabels() — Method in class ApplyLargoSession

Attach annotation labels that were chosen in a Largo session.

$ RemoveAnnotationPatches#annotationIdsProperty in class RemoveAnnotationPatches

Map of the annotation ID to the image/video UUID of the annotation whose patch should be removed.

AttachLabelListenerClass in namespace Biigle\Modules\Largo\Listeners
AnnotationObserverClass in namespace Biigle\Modules\Largo\Observers
ComputeImage::authorize() — Method in class ComputeImage

Determine if the user is authorized to make this request.

ComputeVolume::authorize() — Method in class ComputeVolume

Determine if the user is authorized to make this request.

Image::accessLaserpointsArray() — Method in class Image

Get an attribute from the laser points array.

AnnotationCandidateClass in namespace Biigle\Modules\Maia
AnnotationCandidate::annotation() — Method in class AnnotationCandidate

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

AnnotationCandidateFeatureVectorClass in namespace Biigle\Modules\Maia
$ MigratePatchStorage#acDiskProperty in class MigratePatchStorage

MAIA annotation candidate patch storage disk.

AnnotationCandidateFactoryClass in namespace Biigle\Modules\Maia\Database\Factories
AnnotationCandidateFeatureVectorFactoryClass in namespace Biigle\Modules\Maia\Database\Factories
AnnotationCandidateControllerClass in namespace Biigle\Modules\Maia\Http\Controllers\Api
AreaKnowledgeTransferVolumeControllerClass in namespace Biigle\Modules\Maia\Http\Controllers\Api
ContinueMaiaJob::authorize() — Method in class ContinueMaiaJob

Determine if the user is authorized to make this request.

DestroyMaiaJob::authorize() — Method in class DestroyMaiaJob

Determine if the user is authorized to make this request.

StoreMaiaJob::authorize() — Method in class StoreMaiaJob

Determine if the user is authorized to make this request.

SubmitAnnotationCandidates::authorize() — Method in class SubmitAnnotationCandidates

Determine if the user is authorized to make this request.

UpdateAnnotationCandidate::authorize() — Method in class UpdateAnnotationCandidate

Determine if the user is authorized to make this request.

UpdateTrainingProposal::authorize() — Method in class UpdateTrainingProposal

Determine if the user is authorized to make this request.

$ DeleteAnnotationPatches#annotationCandidatesProperty in class DeleteAnnotationPatches

The annotation candidates to delete, grouped by image ID.

MaiaJob::annotationCandidates() — Method in class MaiaJob

The annotation candidates of this MAIA job.

AnnotationCandidatePolicyClass in namespace Biigle\Modules\Maia\Policies
AnnotationCandidatePolicy::access() — Method in class AnnotationCandidatePolicy

Determine if the given annotation candidate can be accessed by the user.

AnnotationCandidatePolicy::attachLabel() — Method in class AnnotationCandidatePolicy

Determine if the user can attach the given label to the given candidate.

MaiaJobPolicy::access() — Method in class MaiaJobPolicy

Determine if the given job can be accessed by the user.

TrainingProposalPolicy::access() — Method in class TrainingProposalPolicy

Determine if the given training proposal can be accessed by the user.

AreaKnowledgeTransferVolumeClass in namespace Biigle\Modules\Maia\Rules
$ Converter#acquisitionFormatProperty in class Converter
$ Converter#annotatorsProperty in class Converter
Converter::addAnnotations() — Method in class Converter
Converter::annotationClass() — Method in class Converter
AdminControllerClass in namespace Biigle\Modules\Newsletter\Http\Controllers\Views
DestroyNewsletterSubscriber::authorize() — Method in class DestroyNewsletterSubscriber

Determine if the user is authorized to make this request.

StoreNewsletter::authorize() — Method in class StoreNewsletter

Determine if the user is authorized to make this request.

StoreNewsletterSubscriber::authorize() — Method in class StoreNewsletterSubscriber

Determine if the user is authorized to make this request.

UpdateNewsletter::authorize() — Method in class UpdateNewsletter

Determine if the user is authorized to make this request.

NewsletterPolicy::access() — Method in class NewsletterPolicy

Determine if the given user can access a newsletter.

StoreProjectReport::authorize() — Method in class StoreProjectReport

Determine if the user is authorized to make this request.

StoreVolumeReport::authorize() — Method in class StoreVolumeReport

Determine if the user is authorized to make this request.

ReportPolicy::access() — Method in class ReportPolicy

Determine if the given report can be accessed by the user.

AbundanceReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Projects\ImageAnnotations
AnnotationLocationReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Projects\ImageAnnotations
AnnotationReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Projects\ImageAnnotations
AreaReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Projects\ImageAnnotations
AbundanceReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Volumes\ImageAnnotations
AbundanceReportGenerator::aggregateChildLabels() — Method in class AbundanceReportGenerator

Aggregate the number of child labels to the number of the highest parent label and remove the child labels from the list.

AnnotationLocationReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Volumes\ImageAnnotations
AnnotationReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Volumes\ImageAnnotations
AreaReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Volumes\ImageAnnotations
$ VolumeReportGenerator#annotationSessionProperty in class VolumeReportGenerator

Cache for the annotation session the report may be restricted to.

ShowPublicLabelTreeExport::authorize() — Method in class ShowPublicLabelTreeExport

Determine if the user is authorized to make this request.

Export::addIds() — Method in class Export

Add more model IDs to this export.

Export::addToZip() — Method in class Export

Add the file of this report to a zip.

ArchiveManagerClass in namespace Biigle\Modules\Sync\Support\Import
LabelTreeImport::attachLabelTreeMembers() — Method in class LabelTreeImport

Attach members to imported label trees.

ExtendUserDisk::authorize() — Method in class ExtendUserDisk

Determine if the user is authorized to make this request.

StoreUserDisk::authorize() — Method in class StoreUserDisk

Determine if the user is authorized to make this request.

UpdateUserDisk::authorize() — Method in class UpdateUserDisk

Determine if the user is authorized to make this request.

UserDiskPolicy::access() — Method in class UserDiskPolicy

Determine if the given disk can be accessed (i.e. used for new volumes) by the user.

UserDisksServiceProvider::addStorageConfigResolver() — Method in class UserDisksServiceProvider

Add the storage disk config resolver for 'disk-*' disks.

StorageRequestController::approve() — Method in class StorageRequestController

Approve a storage request

ApproveStorageRequestClass in namespace Biigle\Modules\UserStorage\Http\Requests
ApproveStorageRequest::authorize() — Method in class ApproveStorageRequest

Determine if the user is authorized to make this request.

DestroyStorageRequestDirectory::authorize() — Method in class DestroyStorageRequestDirectory

Determine if the user is authorized to make this request.

DestroyStorageRequestFile::authorize() — Method in class DestroyStorageRequestFile

Determine if the user is authorized to make this request.

ExtendStorageRequest::authorize() — Method in class ExtendStorageRequest

Determine if the user is authorized to make this request.

RejectStorageRequest::authorize() — Method in class RejectStorageRequest

Determine if the user is authorized to make this request.

StoreStorageRequest::authorize() — Method in class StoreStorageRequest

Determine if the user is authorized to make this request.

StoreStorageRequestFile::authorize() — Method in class StoreStorageRequestFile

Determine if the user is authorized to make this request.

UpdateStorageRequest::authorize() — Method in class UpdateStorageRequest

Determine if the user is authorized to make this request.

ApproveStorageRequestClass in namespace Biigle\Modules\UserStorage\Jobs
AssembleChunkedFileClass in namespace Biigle\Modules\UserStorage\Jobs
StorageRequestPolicy::access() — Method in class StorageRequestPolicy

Determine if the given request can be accessed by the user.

StorageRequestPolicy::approve() — Method in class StorageRequestPolicy

Determine if the given user can approve the storage request.

$ StorageRequest#appendsProperty in class StorageRequest

The accessors to append to the model's array form.

$ InAppNotification#actionProperty in class InAppNotification

Label of the action link.

$ InAppNotification#actionLinkProperty in class InAppNotification

Action link (URL).

$ PendingVolume#attributesProperty in class PendingVolume

Default values for attributes.

AnnotationLabelPolicyClass in namespace Biigle\Policies
AnnotationPolicyClass in namespace Biigle\Policies
AnnotationPolicy::access() — Method in class AnnotationPolicy

Determine if the user may access the given annotation.

AnnotationPolicy::attachLabel() — Method in class AnnotationPolicy

Determine if the user can attach the given label to the given annotation.

AnnouncementPolicyClass in namespace Biigle\Policies
ApiTokenPolicyClass in namespace Biigle\Policies
LabelTreePolicy::access() — Method in class LabelTreePolicy

Determine if the given label tree can be accessed by the user.

LabelTreePolicy::addMember() — Method in class LabelTreePolicy

Determine if the user can add members to the given label tree.

LabelTreeVersionPolicy::access() — Method in class LabelTreeVersionPolicy

Determine if the given label tree version can be accessed by the user.

PendingVolumePolicy::access() — Method in class PendingVolumePolicy

Determine if the given pending volume can be accessed by the user.

ProjectInvitationPolicy::access() — Method in class ProjectInvitationPolicy

Determine if the user can access the given invitation.

ProjectPolicy::access() — Method in class ProjectPolicy

Determine if the given project can be accessed by the user.

VolumeFilePolicy::access() — Method in class VolumeFilePolicy

Determine if the user can access the given file.

VolumeFilePolicy::addAnnotation() — Method in class VolumeFilePolicy

Determine if the user can add an annotation to given file.

VolumeFilePolicy::attachLabel() — Method in class VolumeFilePolicy

Determine if the user can attach the given label to the given file.

VolumePolicy::access() — Method in class VolumePolicy

Determine if the given volume can be accessed by the user.

Project::admins() — Method in class Project

All members of this project with the admin role.

Project::addUserId() — Method in class Project

Adds the user with the given role to this project.

Project::addVolumeId() — Method in class Project

Adds a volume to this project if it wasn't already.

Project::authorizedLabelTrees() — Method in class Project

The private label trees that authorized this project to use them.

$ ProjectInvitation#appendsProperty in class ProjectInvitation

The accessors to append to the model's array form.

AppServiceProviderClass in namespace Biigle\Providers
AuthServiceProviderClass in namespace Biigle\Providers
AlertClass in namespace Biigle\QueueAlert\Notifications
Role::admin() — Method in class Role
Role::adminId() — Method in class Role
ApiGuardClass in namespace Biigle\Services\Auth
AnnotationClass in namespace Biigle\Services\MetadataParsing
$ FileMetadata#annotationsProperty in class FileMetadata
FileMetadata::addAnnotation() — Method in class FileMetadata
FileMetadata::addFileLabel() — Method in class FileMetadata
VideoMetadata::addFrame() — Method in class VideoMetadata
VolumeMetadata::addFile() — Method in class VolumeMetadata
$ Modules#apidocPathsProperty in class Modules

Additional source paths to generate the API documentation from.

Modules::addMixin() — Method in class Modules
FilesystemManager::addConfigResolver() — Method in class FilesystemManager

Register a config resolver Closure.

User::apiTokens() — Method in class User

Api tokens of this user.

Video::annotations() — Method in class Video

The annotations that belong to this video.

VideoAnnotationLabel::annotation() — Method in class VideoAnnotationLabel

The video annotation, this annotation label belongs to.

Volume::annotationSessions() — Method in class Volume

The annotation sessions of this volume.

Volume::activeAnnotationSession() — Method in class Volume

The active annotation sessions of this volume (if any).

VolumeFile::annotations() — Method in class VolumeFile

The annotations that belong to this file.

B

Announcement::booted() — Method in class Announcement

The "booted" method of the model.

ObjectTrackingFailed::broadcastOn() — Method in class ObjectTrackingFailed

Get the channels the event should broadcast on.

ObjectTrackingFailed::broadcastWith() — Method in class ObjectTrackingFailed

Get the data to broadcast.

ObjectTrackingSucceeded::broadcastOn() — Method in class ObjectTrackingSucceeded

Get the channels the event should broadcast on.

ObjectTrackingSucceeded::broadcastWith() — Method in class ObjectTrackingSucceeded

Get the data to broadcast.

FileCache::batch() — Method in class FileCache

Perform a callback with the paths of many cached files. Use this to prevent pruning of the files while they are processed.

FileCache::batchOnce() — Method in class FileCache

Like batch but deletes the cached files afterwards (if they are not used somewhere else).

FileCache::batch() — Method in class FileCache

Perform a callback with the paths of many cached files. Use this to prevent pruning of the files while they are processed.

FileCache::batchOnce() — Method in class FileCache

Like batch but deletes the cached files afterwards (if they are not used somewhere else).

FileCacheServiceProvider::boot() — Method in class FileCacheServiceProvider

Bootstrap the application events.

FileCacheFake::batch() — Method in class FileCacheFake

Perform a callback with the paths of many cached files. Use this to prevent pruning of the files while they are processed.

FileCacheFake::batchOnce() — Method in class FileCacheFake

Like batch but deletes the cached files afterwards (if they are not used somewhere else).

VolumeFileLabelController::baseStore() — Method in class VolumeFileLabelController

Creates a new label for the specified file.

BrowserControllerClass in namespace Biigle\Http\Controllers\Api\Volumes
$ UpdateFederatedSearchIndex#backoffProperty in class UpdateFederatedSearchIndex

Retry a failed job after 5 minutes.

AnanasServiceProvider::boot() — Method in class AnanasServiceProvider

Bootstrap the application events.

AnnotationAssistanceRequestPolicy::before() — Method in class AnnotationAssistanceRequestPolicy

Intercept all checks.

LSLoginServiceProvider::boot() — Method in class LSLoginServiceProvider

Bootstrap the application events.

ColorSortServiceProvider::boot() — Method in class ColorSortServiceProvider

Bootstrap the application events.

DemoServiceProvider::boot() — Method in class DemoServiceProvider

Bootstrap the application events.

DenbiServiceServiceProvider::boot() — Method in class DenbiServiceServiceProvider

Bootstrap the application events.

GeoServiceProvider::boot() — Method in class GeoServiceProvider

Bootstrap the application events.

KpisServiceProvider::boot() — Method in class KpisServiceProvider

Bootstrap the application events.

LargoSessionFailed::broadcastOn() — Method in class LargoSessionFailed

Get the channels the event should broadcast on.

LargoSessionFailed::broadcastWith() — Method in class LargoSessionFailed

Get the data to broadcast.

LargoSessionSaved::broadcastOn() — Method in class LargoSessionSaved

Get the channels the event should broadcast on.

LargoSessionSaved::broadcastWith() — Method in class LargoSessionSaved

Get the data to broadcast.

LargoServiceProvider::boot() — Method in class LargoServiceProvider

Bootstrap the application events.

LaserpointsServiceProvider::boot() — Method in class LaserpointsServiceProvider

Bootstrap the application events.

EmbeddingAvailable::broadcastOn() — Method in class EmbeddingAvailable

Get the channels the event should broadcast on.

EmbeddingAvailable::broadcastWith() — Method in class EmbeddingAvailable

Get the data to broadcast.

EmbeddingFailed::broadcastOn() — Method in class EmbeddingFailed

Get the channels the event should broadcast on.

EmbeddingFailed::broadcastWith() — Method in class EmbeddingFailed

Get the data to broadcast.

MagicSamServiceProvider::boot() — Method in class MagicSamServiceProvider

Bootstrap the application events.

ObjectDetection::bundleTrainingProposals() — Method in class ObjectDetection

Bundle the training proposals to be sent to the GPU server.

ObjectDetection::buildImagesMap() — Method in class ObjectDetection

Build the map from image ID to path of the cached image file.

MaiaServiceProvider::boot() — Method in class MaiaServiceProvider

Bootstrap the application events.

AnnotationCandidatePolicy::before() — Method in class AnnotationCandidatePolicy

Intercept all checks.

MaiaJobPolicy::before() — Method in class MaiaJobPolicy

Intercept all checks.

TrainingProposalPolicy::before() — Method in class TrainingProposalPolicy

Intercept all checks.

MetadataIfdoServiceProvider::boot() — Method in class MetadataIfdoServiceProvider

Bootstrap the application events.

NewsletterServiceProvider::boot() — Method in class NewsletterServiceProvider

Bootstrap the application events.

VerifyEmail::buildMailMessage() — Method in class VerifyEmail

Get the verify email notification mail message for the given URL.

ReportPolicy::before() — Method in class ReportPolicy

Intercept all checks.

ReportsServiceProvider::boot() — Method in class ReportsServiceProvider

Bootstrap the application events.

BasicReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Projects\ImageAnnotations
BasicReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Projects\ImageLabels
BasicReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Volumes\ImageAnnotations
BasicReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Volumes\ImageLabels
SyncServiceProvider::boot() — Method in class SyncServiceProvider

Bootstrap the application events.

UserDiskPolicy::before() — Method in class UserDiskPolicy

Intercept all checks.

UserDisksServiceProvider::boot() — Method in class UserDisksServiceProvider

Bootstrap the application events.

StorageRequestPolicy::before() — Method in class StorageRequestPolicy

Intercept all checks.

StorageRequest::booted() — Method in class StorageRequest

The "booted" method of the model.

$ ChunkedFileStreamPump#bufferProperty in class ChunkedFileStreamPump
UserStorageServiceProvider::boot() — Method in class UserStorageServiceProvider

Bootstrap the application events.

PendingVolume::booted() — Method in class PendingVolume
AnnotationPolicy::before() — Method in class AnnotationPolicy

Intercept all checks.

LabelTreePolicy::before() — Method in class LabelTreePolicy

Intercept all checks.

LabelTreeVersionPolicy::before() — Method in class LabelTreeVersionPolicy

Intercept all checks.

PendingVolumePolicy::before() — Method in class PendingVolumePolicy

Intercept all checks.

ProjectInvitationPolicy::before() — Method in class ProjectInvitationPolicy

Intercept all checks.

ProjectPolicy::before() — Method in class ProjectPolicy

Intercept all checks.

VolumeFilePolicy::before() — Method in class VolumeFilePolicy

Intercept all checks.

VolumePolicy::before() — Method in class VolumePolicy

Intercept all checks.

AppServiceProvider::boot() — Method in class AppServiceProvider

Bootstrap any application services.

AuthServiceProvider::boot() — Method in class AuthServiceProvider

Register any authentication / authorization services.

BroadcastServiceProviderClass in namespace Biigle\Providers
BroadcastServiceProvider::boot() — Method in class BroadcastServiceProvider

Bootstrap any application services.

EventServiceProvider::boot() — Method in class EventServiceProvider

Register any events for your application.

RouteServiceProvider::boot() — Method in class RouteServiceProvider

Define your route model bindings, pattern filters, etc.

QueueAlertServiceProvider::boot() — Method in class QueueAlertServiceProvider

Bootstrap the application events.

Volume::booted() — Method in class Volume

C

$ Annotation#castsProperty in class Annotation

The attributes that should be casted to native types.

$ Annotation#created_atProperty in class Annotation
$ AnnotationLabel#castsProperty in class AnnotationLabel

The attributes that should be casted to native types.

$ AnnotationSession#castsProperty in class AnnotationSession

The attributes that should be casted to native types.

$ Announcement#castsProperty in class Announcement

The attributes that should be casted to native types.

Kernel::commands() — Method in class Kernel

Register the Closure based commands for the application.

LabelSourceAdapterContract::create() — Method in class LabelSourceAdapterContract

Create the label (or labels) from the label source based on an API request.

$ FederatedSearchInstance#castsProperty in class FederatedSearchInstance

The attributes that should be casted to native types.

FederatedSearchInstance::createLocalToken() — Method in class FederatedSearchInstance

Create a new local token and store the sha256 hash in the attribute of this model.

$ FederatedSearchModel#castsProperty in class FederatedSearchModel

The attributes that should be casted to native types.

FileCache::clear() — Method in class FileCache

Delete all unused cached files.

$ FileCache#configProperty in class FileCache

File cache configuration.

$ FileCache#clientProperty in class FileCache

Guzzle HTTP client to use

FileCache::clear() — Method in class FileCache

Delete all unused cached files.

FileCache::cacheFromResource() — Method in class FileCache

Store the file from the given resource to a cached file.

ClearFileCacheClass in namespace Biigle\FileCache\Listeners
FileCacheFake::clear() — Method in class FileCacheFake

Delete all unused cached files.

ControllerClass in namespace Biigle\Http\Controllers\Api
VolumeController::clone() — Method in class VolumeController

Clones volume to destination project.

LoginController::credentials() — Method in class LoginController

Get the needed authorization credentials from the request.

RegisterController::create() — Method in class RegisterController

Create a new user instance after a valid registration.

ResetPasswordController::credentials() — Method in class ResetPasswordController

Get the password reset credentials from the request.

ControllerClass in namespace Biigle\Http\Controllers
AnnouncementsController::create() — Method in class AnnouncementsController

Shows the admin new announcement page.

ControllerClass in namespace Biigle\Http\Controllers\Views
LabelTreeVersionsController::create() — Method in class LabelTreeVersionsController

Show the create label tree version page.

LabelTreesController::create() — Method in class LabelTreesController

Show the create label tree page.

ProjectsController::create() — Method in class ProjectsController

Shows the create project page.

VolumeCloneController::clone() — Method in class VolumeCloneController

Shows the volume clone page.

VolumeController::create() — Method in class VolumeController

Shows the create volume page.

CloneVolumeClass in namespace Biigle\Http\Requests
$ StoreLabelTreeMerge#createProperty in class StoreLabelTreeMerge

Flat array of labels to create.

UpdateFederatedSearchInstance::checkRemoteConnection() — Method in class UpdateFederatedSearchInstance

Check the connection to the remote instance.

$ Image#castsProperty in class Image

The attributes that should be casted to native types.

$ ImageAnnotation#castsProperty in class ImageAnnotation

The attributes that should be casted to native types.

$ ImageAnnotationLabel#castsProperty in class ImageAnnotationLabel

The attributes that should be casted to native types.

CloneImagesOrVideosClass in namespace Biigle\Jobs
$ CloneImagesOrVideos#copyProperty in class CloneImagesOrVideos
$ CloneImagesOrVideos#cloneAnnotationsProperty in class CloneImagesOrVideos

Boolean for cloning annotation labels.

$ CloneImagesOrVideos#cloneFileLabelsProperty in class CloneImagesOrVideos

Boolean for cloning file labels.

CloneImagesOrVideos::copyImages() — Method in class CloneImagesOrVideos

Copies (selected) images from given volume to volume copy.

CloneImagesOrVideos::copyImageAnnotation() — Method in class CloneImagesOrVideos

Copies (selected) image annotation and annotation labels from volume to volume copy.

CloneImagesOrVideos::copyImageLabels() — Method in class CloneImagesOrVideos

Copies (selected) image labels from given volume to volume copy.

CloneImagesOrVideos::copyVideos() — Method in class CloneImagesOrVideos

Copies (selected) videos from given volume to volume copy.

CloneImagesOrVideos::copyVideoAnnotation() — Method in class CloneImagesOrVideos

Copies (selected) video annotations and annotation labels from given volume to volume copy.

CloneImagesOrVideos::copyVideoLabels() — Method in class CloneImagesOrVideos

Copies (selected) video labels from volume to volume copy.

CloneImagesOrVideos::copyMetadataFile() — Method in class CloneImagesOrVideos
CreateNewImagesOrVideosClass in namespace Biigle\Jobs
CreateNewImagesOrVideos::createFiles() — Method in class CreateNewImagesOrVideos

Create an array to be inserted as new image or video models.

ProcessNewImage::collectMetadata() — Method in class ProcessNewImage

Collect image metadata.

TrackObject::createInputJson() — Method in class TrackObject

Create the JSON file that is the input for the object tracking script.

UpdateFederatedSearchIndex::cleanupDanglingModels() — Method in class UpdateFederatedSearchIndex

Delete all federated search models of the current instance that are not accessible by any user.

$ Label#castsProperty in class Label

The attributes that should be casted to native types.

Label::children() — Method in class Label

The child labels of this label if they are ordered in a tree-like structue.

Label::canBeDeleted() — Method in class Label

Determines if the label can be deleted.

$ LabelTree#castsProperty in class LabelTree

The attributes that should be casted to native types.

LabelTree::canBeDeleted() — Method in class LabelTree

Determines if the label tree can be safely deleted.

$ LabelTreeVersion#castsProperty in class LabelTreeVersion

The attributes that should be casted to native types.

CleanupImageThumbnailsClass in namespace Biigle\Listeners
CleanupImageTilesClass in namespace Biigle\Listeners
CleanupVideoThumbnailsClass in namespace Biigle\Listeners
CreateRedisLoggerClass in namespace Biigle\Logging
$ LogManager#channelProperty in class LogManager

The default logging channel.

$ AnnotationAssistanceRequest#castsProperty in class AnnotationAssistanceRequest

The attributes that should be casted to native types.

AnnotationAssistanceRequestController::create() — Method in class AnnotationAssistanceRequestController

Create a new annotation assistance request.

AnnotationAssistanceRequestObserver::created() — Method in class AnnotationAssistanceRequestObserver

Handle the event of creatinga new assistance request.

LSLoginController::callback() — Method in class LSLoginController

Handle the authentication response

ColorSortServiceProviderClass in namespace Biigle\Modules\ColorSort
ComputeNewSequenceClass in namespace Biigle\Modules\ColorSort\Jobs
$ Sequence#castsProperty in class Sequence

The attributes that should be casted to native types.

ConfigClass in namespace Biigle\Modules\Demo\Console\Commands
CountUniqueUserClass in namespace Biigle\Modules\Kpis\Console\Commands
CountUserClass in namespace Biigle\Modules\Kpis\Console\Commands
ConfigClass in namespace Biigle\Modules\Largo\Console\Commands
$ StoreLargoSession#changedImageAnnotationsProperty in class StoreLargoSession

The changed_image_annotations request attribute.

$ StoreLargoSession#changedVideoAnnotationsProperty in class StoreLargoSession

The changed_video_annotations request attribute.

$ ImageAnnotationLabelFeatureVector#castsProperty in class ImageAnnotationLabelFeatureVector

The attributes that should be casted to native types.

$ ApplyLargoSession#changedImageAnnotationsProperty in class ApplyLargoSession

Array of all changed image annotation IDs for each label.

$ ApplyLargoSession#changedVideoAnnotationsProperty in class ApplyLargoSession

Array of all changed video annotation IDs for each label.

CopyAnnotationFeatureVectorClass in namespace Biigle\Modules\Largo\Jobs
CopyImageAnnotationFeatureVectorClass in namespace Biigle\Modules\Largo\Jobs
CopyVideoAnnotationFeatureVectorClass in namespace Biigle\Modules\Largo\Jobs
ProcessAnnotatedFile::createSvgs() — Method in class ProcessAnnotatedFile

Generate and upload annotation SVGs for the file.

ProcessAnnotatedFile::createSvg() — Method in class ProcessAnnotatedFile

Generate and upload an SVG for the annotation.

ProcessAnnotatedFile::computeRotationAngle() — Method in class ProcessAnnotatedFile

Computes angle between two vectors

$ RemoveAnnotationPatches#chunkSizeProperty in class RemoveAnnotationPatches

Number of annotations to start chunking of this job.

$ VideoAnnotationLabelFeatureVector#castsProperty in class VideoAnnotationLabelFeatureVector

The attributes that should be casted to native types.

ConfigClass in namespace Biigle\Modules\Laserpoints\Console\Commands
LaserpointsController::computeImage() — Method in class LaserpointsController

Compute distance between laser points for an image.

LaserpointsController::computeVolume() — Method in class LaserpointsController

Compute distance between laser points for a volume.

ComputeImageClass in namespace Biigle\Modules\Laserpoints\Http\Requests
ComputeVolumeClass in namespace Biigle\Modules\Laserpoints\Http\Requests
Image::convert() — Method in class Image

Converts a regular Biigle image to a Laserpoints image.

Volume::convert() — Method in class Volume

Converts a regular Biigle volume to a Laserpoints volume.

$ AnnotationCandidateFeatureVector#castsProperty in class AnnotationCandidateFeatureVector

The attributes that should be casted to native types.

ContinueMaiaJobClass in namespace Biigle\Modules\Maia\Http\Requests
$ UpdateAnnotationCandidate#candidateProperty in class UpdateAnnotationCandidate

The annotation candidate to update

ConvertAnnotationCandidatesClass in namespace Biigle\Modules\Maia\Jobs
DetectionJob::cleanup() — Method in class DetectionJob

Clean up temporary data produced by this job.

DetectionJob::createTmpDir() — Method in class DetectionJob

Create the temporary directory for this request.

DetectionJob::createMaiaAnnotations() — Method in class DetectionJob

Create MAIA annotations from the training proposals.

DetectionJob::createMaiaAnnotation() — Method in class DetectionJob

Create an insert array for a MAIA annotation.

NoveltyDetection::createInputJson() — Method in class NoveltyDetection

Create the JSON file that is the input to the novelty detection script.

ObjectDetection::createDatasetJson() — Method in class ObjectDetection

Create the JSON file that is the input to the dataset generation script.

ObjectDetection::createTrainingJson() — Method in class ObjectDetection

Create the JSON file that is the input to the training script.

ObjectDetection::createInferenceJson() — Method in class ObjectDetection

Create the JSON file that is the input to the inference script.

PrepareAnnotationsJob::convertAnnotations() — Method in class PrepareAnnotationsJob

Convert all matching annotations to training proposals.

PrepareAnnotationsJob::convertAnnotationChunk() — Method in class PrepareAnnotationsJob

Convert a chunk of annotations to training proposals.

PrepareAnnotationsJob::convertAnnotationPointsToCircle() — Method in class PrepareAnnotationsJob

Convert the points of an annotation to the points of a circle.

PrepareAnnotationsJob::convertPolygonToCirlce() — Method in class PrepareAnnotationsJob

Determine the points of a circle from the points of a polygon.

$ MaiaAnnotation#castsProperty in class MaiaAnnotation

The attributes that should be casted to native types.

$ MaiaJob#castsProperty in class MaiaJob

The attributes that should be casted to native types.

$ TrainingProposal#castsProperty in class TrainingProposal

The attributes that should be casted to native types.

$ TrainingProposalFeatureVector#castsProperty in class TrainingProposalFeatureVector

The attributes that should be casted to native types.

ConverterClass in namespace Biigle\Modules\MetadataIfdo
Converter::convert() — Method in class Converter
RegisterControllerMixin::create() — Method in class RegisterControllerMixin

Handle a newly created user.

AdminController::create() — Method in class AdminController

Shows the create newsletter view.

NewsletterController::create() — Method in class NewsletterController

Creates a new newsletter subscriber

NewsletterController::created() — Method in class NewsletterController

Shows the created page.

$ Newsletter#castsProperty in class Newsletter

The attributes that should be casted to native types.

$ NewsletterSubscriber#castsProperty in class NewsletterSubscriber

The attributes that should be casted to native types.

NewsletterPolicy::create() — Method in class NewsletterPolicy

Determine if the given user can create a newsletter.

ReportObserver::creating() — Method in class ReportObserver

Fill the attributes that depend on the source.

$ Report#castsProperty in class Report

The attributes that should be casted to native types.

CsvFileClass in namespace Biigle\Modules\Reports\Support
File::close() — Method in class File

Close the file.

CocoReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Projects\ImageAnnotations
CsvReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Projects\ImageAnnotations
CsvReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Projects\ImageLabels
CsvReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Projects\VideoAnnotations
CsvReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Projects\VideoLabels
AbundanceReportGenerator::createCsv() — Method in class AbundanceReportGenerator

Create a CSV file for a single sheet of the spreadsheet of this report.

AnnotationLocationReportGenerator::createNdJSON() — Method in class AnnotationLocationReportGenerator

Create the newline delimited GeoJSON file.

AreaReportGenerator::createCsv() — Method in class AreaReportGenerator

Create a CSV file for a single sheet of the spreadsheet of this report.

BasicReportGenerator::createCsv() — Method in class BasicReportGenerator

Create a CSV file for a single plot of this report.

CocoReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Volumes\ImageAnnotations
CocoReportGenerator::createCsv() — Method in class CocoReportGenerator

Create a CSV file for this report.

CsvReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Volumes\ImageAnnotations
CsvReportGenerator::createCsv() — Method in class CsvReportGenerator

Create a CSV file for this report.

ExtendedReportGenerator::createCsv() — Method in class ExtendedReportGenerator

Create a CSV file for a single sheet of the spreadsheet of this report.

FullReportGenerator::createCsv() — Method in class FullReportGenerator

Create a CSV file for a single sheet of the spreadsheet of this report.

ImageLocationReportGenerator::createNdJSON() — Method in class ImageLocationReportGenerator

Create the newline delimited GeoJSON file.

BasicReportGenerator::createCsv() — Method in class BasicReportGenerator

Create a CSV file for a single sheet of the spreadsheet of this report.

CsvReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Volumes\ImageLabels
CsvReportGenerator::createCsv() — Method in class CsvReportGenerator

Create a CSV file for this report.

ImageLocationReportGenerator::createNdJSON() — Method in class ImageLocationReportGenerator

Create the newline delimited GeoJSON file.

$ PythonScriptRunner#codeProperty in class PythonScriptRunner

Exit code of the exec call.

CsvReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Volumes\VideoAnnotations
CsvReportGenerator::createCsv() — Method in class CsvReportGenerator

Create a CSV file for this report.

CsvReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Volumes\VideoLabels
CsvReportGenerator::createCsv() — Method in class CsvReportGenerator

Create a CSV file for this report.

Volume::convert() — Method in class Volume

Converts a regular Biigle volume to an export volume.

ControllerClass in namespace Biigle\Modules\Sync\Http\Controllers\Api\Export
Export::cleanUp() — Method in class Export

Clean up any temporary files.

ImageAnnotationExport::cleanUp() — Method in class ImageAnnotationExport

Clean up any temporary files.

ImageAnnotationLabelExport::cleanUp() — Method in class ImageAnnotationLabelExport

Clean up any temporary files.

ImageExport::cleanUp() — Method in class ImageExport

Clean up any temporary files.

ImageLabelExport::cleanUp() — Method in class ImageLabelExport

Clean up any temporary files.

PublicLabelExport::cleanUp() — Method in class PublicLabelExport

Clean up any temporary files.

VideoAnnotationExport::cleanUp() — Method in class VideoAnnotationExport

Clean up any temporary files.

VideoAnnotationLabelExport::cleanUp() — Method in class VideoAnnotationLabelExport

Clean up any temporary files.

VideoExport::cleanUp() — Method in class VideoExport

Clean up any temporary files.

VideoLabelExport::cleanUp() — Method in class VideoLabelExport

Clean up any temporary files.

Import::collectJson() — Method in class Import

Read a JSON file containing an array and wrap it in a Laravel collection.

CheckExpiredUserDisksClass in namespace Biigle\Modules\UserDisks\Console\Commands
UserDiskPolicy::create() — Method in class UserDiskPolicy

Determine if the given user can create a new disk.

$ UserDisk#castsProperty in class UserDisk

The attributes that should be cast.

CheckExpiredStorageRequestsClass in namespace Biigle\Modules\UserStorage\Console\Commands
StorageRequestController::create() — Method in class StorageRequestController

Show the view to create a new storage request.

$ StoreStorageRequestFile#chunkOrFileExistsProperty in class StoreStorageRequestFile
$ UpdateStorageRequest#chunkedFilesProperty in class UpdateStorageRequest

Chunked files of a stroage request.

$ DeleteStorageRequestFile#chunksProperty in class DeleteStorageRequestFile

Chunks of an uploaded file that was not assembled yet.

StorageRequestPolicy::create() — Method in class StorageRequestPolicy

Determine if the given user can create a new request.

$ StorageRequest#castsProperty in class StorageRequest

The attributes that should be cast.

$ StorageRequestFile#castsProperty in class StorageRequestFile

The attributes that should be cast.

ChunkedFileStreamPumpClass in namespace Biigle\Modules\UserStorage\Support

When invoked repeadetly, subsequently returns the content of storage request file chunks. This is meant to be used together with a \GuzzleHttp\Psr7\PumpStream.

$ ChunkedFileStreamPump#currentChunkProperty in class ChunkedFileStreamPump

Index of the current chunk to return for the stream.

User::convert() — Method in class User

Converts a regular user to an user storage user.

ProjectObserver::creating() — Method in class ProjectObserver

A project must not be created without having a creator.

ProjectObserver::created() — Method in class ProjectObserver

Handle actions for newly created projects.

VolumeObserver::creating() — Method in class VolumeObserver

A volume must not be created without having a creator.

$ PendingVolume#castsProperty in class PendingVolume

The attributes that should be cast.

AnnouncementPolicy::create() — Method in class AnnouncementPolicy

Determine whether the user can create announcements.

ApiTokenPolicy::create() — Method in class ApiTokenPolicy

Determine if the given user can create API tokens.

CachedPolicyClass in namespace Biigle\Policies

A policy for caching the return values of the authorization rules during a request.

$ CachedPolicy#cacheProperty in class CachedPolicy

The cache instance to use for caching policies.

FederatedSearchInstancePolicy::create() — Method in class FederatedSearchInstancePolicy

Determine whether the user can create instances.

LabelTreePolicy::create() — Method in class LabelTreePolicy

Determine if the given user can create label trees.

LabelTreePolicy::createLabel() — Method in class LabelTreePolicy

Determine if the user can add labels to the given label tree.

LabelTreeVersionPolicy::create() — Method in class LabelTreeVersionPolicy

Determine if the given user can create version of a label tree.

ProjectPolicy::create() — Method in class ProjectPolicy

Determine if the given user can create projects.

UserPolicy::create() — Method in class UserPolicy

Determine if the given user can create users.

Project::creator() — Method in class Project

The user that created this project. On creation this user is automatically added to the project's users with the 'admin' role by the ProjectObserver.

Project::changeRole() — Method in class Project

Changes the role of an existing user in this project.

$ ProjectInvitation#castsProperty in class ProjectInvitation

The attributes that should be casted to native types.

CheckQueuesClass in namespace Biigle\QueueAlert
$ CheckQueues#cacheProperty in class CheckQueues

The cache manager instance.

CheckQueues::checkQueue() — Method in class CheckQueues

Check a single queue and send an alert if necessary.

$ Alert#connectionsProperty in class Alert

Queue connection name.

$ GreaterThan#compareProperty in class GreaterThan

The value to compare.

$ LessThan#compareProperty in class LessThan

The value to compare.

$ WormsAdapter#clientProperty in class WormsAdapter

SOAP client for the WoRMS webservice.

WormsAdapter::create() — Method in class WormsAdapter

Create the label (or labels) from the label source based on an API request.

WormsAdapter::createSingleLabel() — Method in class WormsAdapter

Create (and save) a single label.

WormsAdapter::createRecursiveLabels() — Method in class WormsAdapter

Create (and save) a label and all WoRMS parents that don't already exist in the tree.

CsvParserClass in namespace Biigle\Services\MetadataParsing
$ Modules#controllerMixinsProperty in class Modules

The controller mixins of every module.

Modules::callControllerMixins() — Method in class Modules

Call all controller mixins registered for a certain controller.

Shape::circle() — Method in class Shape
Shape::circleId() — Method in class Shape
$ FilesystemManager#configResolversProperty in class FilesystemManager

The registered config resolvers.

HasPointsAttribute::countDistinctCoordinates() — Method in class HasPointsAttribute

Counts number of distinct points

$ User#castsProperty in class User

The attributes that should be casted to native types.

User::checkCanBeDeleted() — Method in class User

Checks if the user can be deleted.

$ Video#castsProperty in class Video

The attributes that should be casted to native types.

$ VideoAnnotation#castsProperty in class VideoAnnotation

The attributes that should be casted to native types.

$ Volume#castsProperty in class Volume

The attributes that should be casted to native types.

Volume::creator() — Method in class Volume

The user that created the volume.

$ VolumeFileLabel#castsProperty in class VolumeFileLabel

The attributes that should be casted to native types.

CreateCopriaColorSortSequencesTableClass in namespace [Global Namespace]
CreateGeoOverlaysTableClass in namespace [Global Namespace]
CreateIndicesClass in namespace [Global Namespace]
CreateReportsTableClass in namespace [Global Namespace]

D

AddAbundanceReportType::down() — Method in class AddAbundanceReportType

Reverse the migrations.

AddImageCocoReportType::down() — Method in class AddImageCocoReportType

Reverse the migrations.

AddImageIfdoReportType::down() — Method in class AddImageIfdoReportType

Reverse the migrations.

AddLocationReportTypes::down() — Method in class AddLocationReportTypes

Reverse the migrations.

AddReportsReadyAtColumn::down() — Method in class AddReportsReadyAtColumn

Reverse the migrations.

AddVideoAnnotationReportType::down() — Method in class AddVideoAnnotationReportType

Reverse the migrations.

AddVideoLabelReportType::down() — Method in class AddVideoLabelReportType

Reverse the migrations.

$ Apidoc#descriptionProperty in class Apidoc

The console command description.

$ MigrateTiledImages#descriptionProperty in class MigrateTiledImages

The console command description.

$ NewUser#descriptionProperty in class NewUser

The console command description.

$ PruneNotifications#descriptionProperty in class PruneNotifications

The console command description.

$ UpdateVideoMetadata#descriptionProperty in class UpdateVideoMetadata

The console command description.

$ UpdateVideoMetadata#dryRunProperty in class UpdateVideoMetadata

Is this a dry run?

$ UpdateVolumeUrls#descriptionProperty in class UpdateVolumeUrls

The console command description.

$ UpdateVolumeUrls#dryRunProperty in class UpdateVolumeUrls

Is this a dry run?

$ UpdateVolumeUrls#disksProperty in class UpdateVolumeUrls

Available storage disks.

$ ObjectTrackingFailed#deleteWhenMissingModelsProperty in class ObjectTrackingFailed

Ignore this event if the annotation does not exist any more.

$ ObjectTrackingSucceeded#deleteWhenMissingModelsProperty in class ObjectTrackingSucceeded

Ignore this event if the annotation does not exist any more.

$ Handler#dontFlashProperty in class Handler

A list of the inputs that are never flashed for validation exceptions.

$ PruneFileCache#descriptionProperty in class PruneFileCache

The console command description.

FileCache::delete() — Method in class FileCache

Delete a cached file it it is not used.

AnnotationSessionController::destroy() — Method in class AnnotationSessionController

Removes the annotation session.

AnnouncementController::destroy() — Method in class AnnouncementController

Delete an announcement.

ApiTokenController::destroy() — Method in class ApiTokenController

Removes the specified API token.

FederatedSearchInstanceController::destroy() — Method in class FederatedSearchInstanceController

Disonnect a remote federated search instance.

ImageAnnotationController::destroy() — Method in class ImageAnnotationController

Removes the annotation.

ImageAnnotationLabelController::destroy() — Method in class ImageAnnotationLabelController

Deletes the specified annotation label.

ImageController::destroy() — Method in class ImageController

Delete an image.

LabelController::destroy() — Method in class LabelController

Delete a label.

LabelTreeAuthorizedProjectController::destroy() — Method in class LabelTreeAuthorizedProjectController

Remove authorization of a project to use a private label tree.

LabelTreeController::destroy() — Method in class LabelTreeController

Removes the specified label tree.

LabelTreeUserController::destroy() — Method in class LabelTreeUserController

Removes the specified member from the specified label tree.

LabelTreeVersionController::destroy() — Method in class LabelTreeVersionController

Removes the specified label tree version.

NotificationController::destroy() — Method in class NotificationController

Delete a read notification.

PendingVolumeController::destroy() — Method in class PendingVolumeController

Delete a pending volume

ProjectController::destroy() — Method in class ProjectController

Removes the specified project.

ProjectInvitationController::destroy() — Method in class ProjectInvitationController

Deletes a project invitation.

ProjectLabelTreeController::destroy() — Method in class ProjectLabelTreeController

Removes a label tree form the specified project.

ProjectUserController::destroy() — Method in class ProjectUserController

Removes a user form the specified project.

ProjectVolumeController::destroy() — Method in class ProjectVolumeController

Removes the specified volume from the specified project.

UserController::destroy() — Method in class UserController

Removes the specified user.

UserController::destroyOwn() — Method in class UserController

Removes the own user.

UserPinnedProjectController::destroy() — Method in class UserPinnedProjectController

Unpin a project.

VideoAnnotationController::destroy() — Method in class VideoAnnotationController

Removes a video annotation.

VideoAnnotationLabelController::destroy() — Method in class VideoAnnotationLabelController

Detach a label

VideoController::destroy() — Method in class VideoController

Delete a video.

VolumeFileLabelController::destroy() — Method in class VolumeFileLabelController

Deletes the specified file label.

MetadataController::destroy() — Method in class MetadataController

Delete a metadata file attached to a volume

UsersController::delete() — Method in class UsersController

Shows the admin delete user page.

DashboardControllerClass in namespace Biigle\Http\Controllers\Views
ManualController::documentationArticle() — Method in class ManualController

Show a documentation article.

DestroyAnnotationSessionClass in namespace Biigle\Http\Requests
DestroyImageClass in namespace Biigle\Http\Requests
DestroyLabelClass in namespace Biigle\Http\Requests
DestroyLabelTreeClass in namespace Biigle\Http\Requests
DestroyLabelTreeUserClass in namespace Biigle\Http\Requests
DestroyLabelTreeVersionClass in namespace Biigle\Http\Requests
DestroyOwnUserClass in namespace Biigle\Http\Requests
DestroyPinnedProjectClass in namespace Biigle\Http\Requests
DestroyProjectUserClass in namespace Biigle\Http\Requests
DestroyUserClass in namespace Biigle\Http\Requests
$ DestroyUser#destroyUserProperty in class DestroyUser

The user to delete.

DestroyVideoClass in namespace Biigle\Http\Requests
DestroyVideoAnnotationLabelClass in namespace Biigle\Http\Requests
DestroyVolumeFileClass in namespace Biigle\Http\Requests
$ Ifdo#debugProperty in class Ifdo
$ CloneImagesOrVideos#deleteWhenMissingModelsProperty in class CloneImagesOrVideos

Ignore this job if the project or volume does not exist any more.

DeleteVolumeClass in namespace Biigle\Jobs
$ ImportVolumeMetadata#deleteWhenMissingModelsProperty in class ImportVolumeMetadata

Ignore this job if the pending volume does not exist any more.

$ MigrateTiledImage#diskProperty in class MigrateTiledImage

Name of the storage disk that holds the ZIP files of tiled images.

$ ProcessNewImage#deleteWhenMissingModelsProperty in class ProcessNewImage

Ignore this job if the image does not exist any more.

$ ProcessNewVideo#deleteWhenMissingModelsProperty in class ProcessNewVideo

Ignore this job if the video does not exist any more.

$ ProcessNewVolumeFiles#deleteWhenMissingModelsProperty in class ProcessNewVolumeFiles

Ignore this job if the volume does not exist any more.

$ TileSingleImage#deleteWhenMissingModelsProperty in class TileSingleImage

Ignore this job if the image does not exist any more.

$ TrackObject#deleteWhenMissingModelsProperty in class TrackObject

Ignore this job if the annotation does not exist any more.

$ UpdateFederatedSearchIndex#deleteWhenMissingModelsProperty in class UpdateFederatedSearchIndex

Ignore this job if the volume does not exist any more.

$ UpdateVolumeMetadata#deleteWhenMissingModelsProperty in class UpdateVolumeMetadata

Ignore this job if the project or volume does not exist any more.

LabelTree::detachUnauthorizedProjects() — Method in class LabelTree

Detaches all projects that are not among the authorized projects.

$ Publish#descriptionProperty in class Publish

The console command description.

AnnotationAssistanceRequestFactory::definition() — Method in class AnnotationAssistanceRequestFactory

Define the model's default state.

AnnotationAssistanceRequestController::destroy() — Method in class AnnotationAssistanceRequestController

Delete an annotation assistance request.

AnnotationAssistanceRequestPolicy::destroy() — Method in class AnnotationAssistanceRequestPolicy

Determine if the given assistance request can be deleted by the user.

LsloginIdFactory::definition() — Method in class LsloginIdFactory

Define the model's default state.

$ Publish#descriptionProperty in class Publish

The console command description.

VolumeColorSortSequenceController::destroy() — Method in class VolumeColorSortSequenceController

Delete a color sort sequence.

$ ComputeNewSequence#deleteWhenMissingModelsProperty in class ComputeNewSequence

Ignore this job if the annotation does not exist any more.

ImageObserver::deleted() — Method in class ImageObserver

Updates the color sort sequences containing the ID of the deleted image.

$ Config#descriptionProperty in class Config

The console command description.

DemoServiceProviderClass in namespace Biigle\Modules\Demo
DemoProjectControllerClass in namespace Biigle\Modules\Demo\Http\Controllers\Api
DenbiServiceServiceProviderClass in namespace Biigle\Modules\DenbiService
$ Publish#descriptionProperty in class Publish

The console command description.

$ CountUniqueUser#descriptionProperty in class CountUniqueUser

The console command description.

$ CountUser#descriptionProperty in class CountUser

The console command description.

DetermineStorageUsageClass in namespace Biigle\Modules\Kpis\Console\Commands
$ DetermineStorageUsage#descriptionProperty in class DetermineStorageUsage

The console command description.

$ Config#descriptionProperty in class Config

The console command description.

$ GenerateMissing#descriptionProperty in class GenerateMissing

The console command description.

GenerateMissing::dispatcheProcessJob() — Method in class GenerateMissing
$ InitializeFeatureVectors#descriptionProperty in class InitializeFeatureVectors

The console command description.

$ MigratePatchStorage#descriptionProperty in class MigratePatchStorage

The console command description.

$ MigratePatchStorage#diskProperty in class MigratePatchStorage

Largo patch storage disk.

$ MigratePatchStorage#dryRunProperty in class MigratePatchStorage

Specifies if this is a dry run.

$ Publish#descriptionProperty in class Publish

The console command description.

ImageAnnotationLabelFeatureVectorFactory::definition() — Method in class ImageAnnotationLabelFeatureVectorFactory

Define the model's default state.

VideoAnnotationLabelFeatureVectorFactory::definition() — Method in class VideoAnnotationLabelFeatureVectorFactory

Define the model's default state.

$ StoreLargoSession#dismissedImageAnnotationsProperty in class StoreLargoSession

The dismissed_image_annotations request attribute.

$ StoreLargoSession#dismissedVideoAnnotationsProperty in class StoreLargoSession

The dismissed_video_annotations request attribute.

$ ApplyLargoSession#dismissedImageAnnotationsProperty in class ApplyLargoSession

Array of all dismissed image annotation IDs for each label.

$ ApplyLargoSession#dismissedVideoAnnotationsProperty in class ApplyLargoSession

Array of all dismissed video annotation IDs for each label.

ApplyLargoSession::deleteDanglingAnnotations() — Method in class ApplyLargoSession

Delete annotations that now have no more labels attached.

$ CopyAnnotationFeatureVector#deleteWhenMissingModelsProperty in class CopyAnnotationFeatureVector

Ignore this job if the annotation does not exist any more.

$ ProcessAnnotatedFile#deleteWhenMissingModelsProperty in class ProcessAnnotatedFile

Ignore this job if the annotation does not exist any more.

RemoveAnnotationPatches::deletePatches() — Method in class RemoveAnnotationPatches

Delete the annotation patches.

RemoveImageAnnotationPatches::deletePatches() — Method in class RemoveImageAnnotationPatches

Delete the annotation patches.

RemoveVideoAnnotationPatches::deletePatches() — Method in class RemoveVideoAnnotationPatches

Delete the annotation patches.

AnnotationObserver::deleting() — Method in class AnnotationObserver

Handle the event of deleting a single annotation.

$ Config#descriptionProperty in class Config

The console command description.

$ Publish#descriptionProperty in class Publish

The console command description.

$ Job#distanceProperty in class Job

Distance between laser points im cm to use for computation.

$ ProcessDelphiJob#distanceProperty in class ProcessDelphiJob

Distance between laser points im cm to use for computation.

$ ProcessDelphiJob#deleteWhenMissingModelsProperty in class ProcessDelphiJob

Ignore this job if the image does not exist any more.

$ ProcessImageManualJob#deleteWhenMissingModelsProperty in class ProcessImageManualJob

Ignore this job if the image does not exist any more.

$ ProcessManualJob#distanceProperty in class ProcessManualJob

Distance between laser points im cm to use for computation.

$ ProcessManualJob#deleteWhenMissingModelsProperty in class ProcessManualJob

Ignore this job if the image does not exist any more.

$ ProcessVolumeDelphiJob#deleteWhenMissingModelsProperty in class ProcessVolumeDelphiJob

Ignore this job if the image does not exist any more.

DelphiApplyClass in namespace Biigle\Modules\Laserpoints\Support

Wrapper for the Delphi laser points detection script.

DelphiGatherClass in namespace Biigle\Modules\Laserpoints\Support

Wrapper for the Delphi gather script.

DetectClass in namespace Biigle\Modules\Laserpoints\Support

Wrapper for the manual laser points detection script.

$ PruneOldEmbeddings#descriptionProperty in class PruneOldEmbeddings

The console command description.

$ EmbeddingAvailable#deleteWhenMissingModelsProperty in class EmbeddingAvailable

Ignore this job if the image or user does not exist any more.

$ EmbeddingFailed#deleteWhenMissingModelsProperty in class EmbeddingFailed

Ignore this job if the image or user does not exist any more.

$ GenerateEmbedding#deleteWhenMissingModelsProperty in class GenerateEmbedding

Ignore this job if the image or user does not exist any more.

$ MigratePatchStorage#descriptionProperty in class MigratePatchStorage

The console command description.

$ MigratePatchStorage#dryRunProperty in class MigratePatchStorage

Specifies if this is a dry run.

$ Publish#descriptionProperty in class Publish

The console command description.

AnnotationCandidateFactory::definition() — Method in class AnnotationCandidateFactory

Define the model's default state.

AnnotationCandidateFeatureVectorFactory::definition() — Method in class AnnotationCandidateFeatureVectorFactory

Define the model's default state.

MaiaJobFactory::definition() — Method in class MaiaJobFactory

Define the model's default state.

MaiaJobStateFactory::definition() — Method in class MaiaJobStateFactory

Define the model's default state.

TrainingProposalFactory::definition() — Method in class TrainingProposalFactory

Define the model's default state.

TrainingProposalFeatureVectorFactory::definition() — Method in class TrainingProposalFeatureVectorFactory

Define the model's default state.

MaiaJobController::destroy() — Method in class MaiaJobController

Delete a MAIA job.

DestroyMaiaJobClass in namespace Biigle\Modules\Maia\Http\Requests
$ ConvertAnnotationCandidates#deleteWhenMissingModelsProperty in class ConvertAnnotationCandidates

Ignore this job if the MAIA job does not exist any more.

DeleteAnnotationPatchChunkClass in namespace Biigle\Modules\Maia\Jobs
$ DeleteAnnotationPatchChunk#diskProperty in class DeleteAnnotationPatchChunk

Storage disk to delete files in.

DeleteAnnotationPatchesClass in namespace Biigle\Modules\Maia\Jobs
DeleteAnnotationPatches::deleteAnnotations() — Method in class DeleteAnnotationPatches

Delete MAIA annotations form the specified storage disk.

DetectionJobClass in namespace Biigle\Modules\Maia\Jobs
$ DetectionJob#deleteWhenMissingModelsProperty in class DetectionJob

Ignore this job if the MAIA job does not exist any more.

DetectionJob::dispatchFailure() — Method in class DetectionJob

Dispatch the job to notify the BIIGLE instance of a failure.

$ GenerateAnnotationCandidatePatches#deleteWhenMissingModelsProperty in class GenerateAnnotationCandidatePatches

Ignore this job if the MAIA job does not exist any more.

$ GenerateAnnotationFeatureVectors#deleteWhenMissingModelsProperty in class GenerateAnnotationFeatureVectors

Ignore this job if the MAIA job does not exist any more.

$ GenerateTrainingProposalPatches#deleteWhenMissingModelsProperty in class GenerateTrainingProposalPatches

Ignore this job if the MAIA job does not exist any more.

$ NotifyNoveltyDetectionComplete#deleteWhenMissingModelsProperty in class NotifyNoveltyDetectionComplete

Ignore this job if the MAIA job does not exist any more.

$ NotifyObjectDetectionComplete#deleteWhenMissingModelsProperty in class NotifyObjectDetectionComplete

Ignore this job if the MAIA job does not exist any more.

NoveltyDetection::dispatchFailure() — Method in class NoveltyDetection

Dispatch the job to notify the BIIGLE instance of a failure.

ObjectDetection::dispatchResponse() — Method in class ObjectDetection

Dispatch the job to store the object detection results.

ObjectDetection::dispatchFailure() — Method in class ObjectDetection

Dispatch the job to notify the BIIGLE instance of a failure.

$ PrepareAnnotationsJob#deleteWhenMissingModelsProperty in class PrepareAnnotationsJob

Ignore this job if the MAIA job does not exist any more.

DispatchMaiaJobClass in namespace Biigle\Modules\Maia\Listeners
DispatchObjectDetectionClass in namespace Biigle\Modules\Maia\Listeners
$ MaiaJob#dispatchesEventsProperty in class MaiaJob

The event map for the model.

MaiaJobPolicy::destroy() — Method in class MaiaJobPolicy

Determine if the given user can destroy the MAIA job.

$ PruneStaleSubscribers#descriptionProperty in class PruneStaleSubscribers

The console command description.

NewsletterFactory::definition() — Method in class NewsletterFactory

Define the model's default state.

NewsletterSubscriberFactory::definition() — Method in class NewsletterSubscriberFactory

Define the model's default state.

NewsletterController::destroy() — Method in class NewsletterController

Delete a newsletter draft

NewsletterSubscriberController::destroy() — Method in class NewsletterSubscriberController

Delete a newsletter subscriber.

NewsletterController::destroy() — Method in class NewsletterController

Deletes a newsletter subscriber.

DestroyNewsletterSubscriberClass in namespace Biigle\Modules\Newsletter\Http\Requests
NewsletterPolicy::destroy() — Method in class NewsletterPolicy

Determine if the given user can destroy a newsletter.

NewsletterSubscriberPolicy::destroy() — Method in class NewsletterSubscriberPolicy

Determine if the given user can destroy the subscriber.

$ Publish#descriptionProperty in class Publish

The console command description.

ReportFactory::definition() — Method in class ReportFactory

Define the model's default state.

ReportTypeFactory::definition() — Method in class ReportTypeFactory

Define the model's default state.

ReportsController::destroy() — Method in class ReportsController

Delete a report.

ExportAreaController::destroy() — Method in class ExportAreaController

Remove the export area.

ProjectObserver::deleted() — Method in class ProjectObserver

Update the source name of reports when the source is deleted.

ReportObserver::deleted() — Method in class ReportObserver

Remove report file of a report that should be deleted.

UserObserver::deleting() — Method in class UserObserver

Remove report files of a user that should be deleted.

VolumeObserver::deleted() — Method in class VolumeObserver

Update the source name of reports when the source is deleted.

ReportPolicy::destroy() — Method in class ReportPolicy

Determine if the given report can be destroyed by the user.

Report::deleteFile() — Method in class Report

Delete the file that belongs to this report.

$ CsvFile#delimiterProperty in class CsvFile

Field delimiter.

File::delete() — Method in class File

Delete the file.

$ Prune#descriptionProperty in class Prune

The console command description.

$ Publish#descriptionProperty in class Publish

The console command description.

$ Uuids#descriptionProperty in class Uuids

The console command description.

ImportController::destroy() — Method in class ImportController
$ ArchiveManager#diskProperty in class ArchiveManager

Storage disk for uploaded import archives.

ArchiveManager::delete() — Method in class ArchiveManager

Delete the files of an import.

$ CheckExpiredUserDisks#descriptionProperty in class CheckExpiredUserDisks

The console command description.

$ PruneExpiredUserDisks#descriptionProperty in class PruneExpiredUserDisks

The console command description.

UserDiskFactory::definition() — Method in class UserDiskFactory

Define the model's default state.

UserDiskController::destroy() — Method in class UserDiskController

Delete a storage disk

$ ExtendUserDisk#diskProperty in class ExtendUserDisk

Storage disk that should be approved.

$ UpdateUserDisk#diskProperty in class UpdateUserDisk

The user disk that should be updated.

$ UserDiskExpiresSoon#diskProperty in class UserDiskExpiresSoon

The storage disk that was confirmed

$ UserDiskExpiresSoon#deleteWhenMissingModelsProperty in class UserDiskExpiresSoon

Ignore this job if the disk does not exist any more.

UserDiskPolicy::destroy() — Method in class UserDiskPolicy

Determine if the given user can destroy the storage disk.

$ CheckExpiredStorageRequests#descriptionProperty in class CheckExpiredStorageRequests

The console command description.

$ PruneExpiredStorageRequests#descriptionProperty in class PruneExpiredStorageRequests

The console command description.

$ PruneStaleStorageRequests#descriptionProperty in class PruneStaleStorageRequests

The console command description.

StorageRequestFactory::definition() — Method in class StorageRequestFactory

Define the model's default state.

StorageRequestFileFactory::definition() — Method in class StorageRequestFileFactory

Define the model's default state.

StorageRequestController::destroy() — Method in class StorageRequestController

Delete a storage request with all its files.

StorageRequestDirectoryController::destroy() — Method in class StorageRequestDirectoryController

Delete directories of a storage request

StorageRequestFileController::destroy() — Method in class StorageRequestFileController

Delete files of a storage request

DestroyStorageRequestDirectoryClass in namespace Biigle\Modules\UserStorage\Http\Requests
DestroyStorageRequestFileClass in namespace Biigle\Modules\UserStorage\Http\Requests
$ ApproveStorageRequest#deleteWhenMissingModelsProperty in class ApproveStorageRequest

Ignore this job if the image does not exist any more.

$ AssembleChunkedFile#deleteWhenMissingModelsProperty in class AssembleChunkedFile

Ignore this job if the image does not exist any more.

DeleteStorageRequestDirectoryClass in namespace Biigle\Modules\UserStorage\Jobs
DeleteStorageRequestFileClass in namespace Biigle\Modules\UserStorage\Jobs
$ StorageRequestApproved#deleteWhenMissingModelsProperty in class StorageRequestApproved

Ignore this job if the image does not exist any more.

$ StorageRequestExpiresSoon#deleteWhenMissingModelsProperty in class StorageRequestExpiresSoon

Ignore this job if the request does not exist any more.

$ StorageRequestSubmitted#deleteWhenMissingModelsProperty in class StorageRequestSubmitted

Ignore this job if the image does not exist any more.

UserObserver::deleting() — Method in class UserObserver

Remove storage request files of a user that should be deleted.

StorageRequestPolicy::destroy() — Method in class StorageRequestPolicy

Determine if the given user can destroy the storage request.

$ ChunkedFileStreamPump#diskProperty in class ChunkedFileStreamPump

Storage disk to read chunks from.

ImageObserver::deleting() — Method in class ImageObserver

Handle the event of deleting a single image.

VideoObserver::deleting() — Method in class VideoObserver

Handle the event of deleting a single video.

VolumeObserver::deleting() — Method in class VolumeObserver

Handle the deletion of a volume.

AnnotationLabelPolicy::destroy() — Method in class AnnotationLabelPolicy

Determine if the user can delete the given annotation label.

AnnotationPolicy::destroy() — Method in class AnnotationPolicy

Determine if the user may delete the given annotation.

AnnouncementPolicy::destroy() — Method in class AnnouncementPolicy

Determine whether the user can delete the announcement.

ApiTokenPolicy::destroy() — Method in class ApiTokenPolicy

Determine if the given token can be deleted by the user.

FederatedSearchInstancePolicy::destroy() — Method in class FederatedSearchInstancePolicy

Determine whether the user can delete the instance.

LabelPolicy::destroy() — Method in class LabelPolicy

Determine if the user can remove the given label.

LabelTreePolicy::destroy() — Method in class LabelTreePolicy

Determine if the given label tree can be deleted by the user.

LabelTreeVersionPolicy::destroy() — Method in class LabelTreeVersionPolicy

Determine if the given label tree version can be deleted by the user.

PendingVolumePolicy::destroy() — Method in class PendingVolumePolicy

Determine if the given pending volume can be deleted by the user.

ProjectInvitationPolicy::destroy() — Method in class ProjectInvitationPolicy

Determine if the user can delete the given invitation.

ProjectPolicy::destroy() — Method in class ProjectPolicy

Determine if the given project can be deleted by the user.

UserPolicy::destroy() — Method in class UserPolicy

Determine if the given user can delete the user.

VolumeFileLabelPolicy::destroy() — Method in class VolumeFileLabelPolicy

Determine if the user can delete the given image label.

VolumeFilePolicy::destroy() — Method in class VolumeFilePolicy

Determine if the user can delete the given file.

VolumePolicy::destroy() — Method in class VolumePolicy

Determine if the given volume can be deleted by the user.

HasMetadataFile::deleteMetadata() — Method in class HasMetadataFile
CreateCopriaColorSortSequencesTable::down() — Method in class CreateCopriaColorSortSequencesTable

Reverse the migrations.

CreateGeoOverlaysTable::down() — Method in class CreateGeoOverlaysTable

Reverse the migrations.

CreateIndices::down() — Method in class CreateIndices

Reverse the migrations.

CreateReportsTable::down() — Method in class CreateReportsTable

Reverse the migrations.

InitializeMaiaTables::down() — Method in class InitializeMaiaTables

Reverse the migrations.

RemoveGeoOverlaysTable::down() — Method in class RemoveGeoOverlaysTable

Reverse the migrations.

RenameReportTypes::down() — Method in class RenameReportTypes

Reverse the migrations.

RenameTable::down() — Method in class RenameTable

Reverse the migrations.

RenameTransectColumn::down() — Method in class RenameTransectColumn

Reverse the migrations.

RenameVideoSourceType::down() — Method in class RenameVideoSourceType

Reverse the migrations.

UpdateJobParams::down() — Method in class UpdateJobParams

Reverse the migrations.

E

FileCache::exists() — Method in class FileCache

Check if a file exists.

FileCache::exists() — Method in class FileCache

Check if a file exists.

FileCache::existsRemote() — Method in class FileCache

Check for existence of a remte file.

FileCache::existsDisk() — Method in class FileCache

Check for existence of a file from a storage disk.

FileCache::ensurePathExists() — Method in class FileCache

Creates the cache directory if it doesn't exist yet.

FileCacheFake::exists() — Method in class FileCacheFake

Check if a file exists.

UsersController::edit() — Method in class UsersController

Shows the admin edit user page.

VolumeController::edit() — Method in class VolumeController

Shows the volume edit page.

EncryptCookiesClass in namespace Biigle\Http\Middleware
$ EncryptCookies#exceptProperty in class EncryptCookies

The names of the cookies that should not be encrypted.

$ PreventRequestsDuringMaintenance#exceptProperty in class PreventRequestsDuringMaintenance

The URIs that should be reachable while maintenance mode is enabled.

$ TrimStrings#exceptProperty in class TrimStrings

The names of the attributes that should not be trimmed.

$ UpdateUserActivity#exceptProperty in class UpdateUserActivity

The URIs that should be excluded from updating the user activity.

$ ValidateSignature#exceptProperty in class ValidateSignature

The names of the query string parameters that should be ignored.

$ VerifyCsrfToken#exceptProperty in class VerifyCsrfToken

The URIs that should be excluded from CSRF verification.

Sort::execute() — Method in class Sort

Compute a color sort sequence.

EnsureTokenIsValidClass in namespace Biigle\Modules\Kpis\Http\Middleware
$ StoreLargoSession#emptyRequestProperty in class StoreLargoSession

Specifies whether the request is empty.

GenerateFeatureVectors::ensureBoxAspectRatio() — Method in class GenerateFeatureVectors

Modify a bounding box so it adheres to the aspect ratio given by width and height.

DelphiApply::execute() — Method in class DelphiApply

Execute a new Delphi laser point detection.

DelphiGather::execute() — Method in class DelphiGather

Execute a new Delphi preprocessing.

Detect::execute() — Method in class Detect

Execute a new manual laser point detection.

LaserpointsScript::exec() — Method in class LaserpointsScript

Execute a laser point detection command.

EmbeddingAvailableClass in namespace Biigle\Modules\MagicSam\Events
EmbeddingFailedClass in namespace Biigle\Modules\MagicSam\Events
DetectionJob::ensureDirectory() — Method in class DetectionJob

Creates the specified directory if it does not exist.

Converter::extractIfdoLabels() — Method in class Converter
Converter::extractIfdoAnnotators() — Method in class Converter
AdminController::edit() — Method in class AdminController

Shows the edit newsletter view.

EmailVerificationRequestClass in namespace Biigle\Modules\Newsletter\Http\Requests
ExportAreaControllerClass in namespace Biigle\Modules\Reports\Http\Controllers\Api\Volumes
$ CsvFile#enclosureProperty in class CsvFile

String enclosure character.

$ CsvFile#escape_charProperty in class CsvFile

Escape character.

ExtendedReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Projects\ImageAnnotations
$ ProjectReportGenerator#extensionProperty in class ProjectReportGenerator

File extension of the report file.

$ ReportGenerator#extensionProperty in class ReportGenerator

File extension of the report file.

ReportGenerator::expandLabelName() — Method in class ReportGenerator

Constructs a label name from the names of all parent labels and the label itself.

$ IfdoReportGenerator#extensionProperty in class IfdoReportGenerator

File extension of the report file.

$ AbundanceReportGenerator#extensionProperty in class AbundanceReportGenerator

File extension of the report file.

$ AnnotationLocationReportGenerator#extensionProperty in class AnnotationLocationReportGenerator

File extension of the report file.

AnnotationLocationReportGenerator::estimateAnnotationPosition() — Method in class AnnotationLocationReportGenerator

Estimate the position of an annotation in world coordinates.

$ AreaReportGenerator#extensionProperty in class AreaReportGenerator

File extension of the report file.

$ BasicReportGenerator#extensionProperty in class BasicReportGenerator

File extension of the report file.

$ CocoReportGenerator#extensionProperty in class CocoReportGenerator

File extension of the report file.

$ CsvReportGenerator#extensionProperty in class CsvReportGenerator

File extension of the report file.

ExtendedReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Volumes\ImageAnnotations
$ ExtendedReportGenerator#extensionProperty in class ExtendedReportGenerator

File extension of the report file.

$ FullReportGenerator#extensionProperty in class FullReportGenerator

File extension of the report file.

$ ImageLocationReportGenerator#extensionProperty in class ImageLocationReportGenerator

File extension of the report file.

$ BasicReportGenerator#extensionProperty in class BasicReportGenerator

File extension of the report file.

$ CsvReportGenerator#extensionProperty in class CsvReportGenerator

File extension of the report file.

$ ImageLocationReportGenerator#extensionProperty in class ImageLocationReportGenerator

File extension of the report file.

$ CsvReportGenerator#extensionProperty in class CsvReportGenerator

File extension of the report file.

$ CsvReportGenerator#extensionProperty in class CsvReportGenerator

File extension of the report file.

VolumeReportGenerator::expandLabelName() — Method in class VolumeReportGenerator

Constructs a label name from the names of all parent labels and the label itself.

VolumeReportGenerator::executeScript() — Method in class VolumeReportGenerator

Execute the external report parsing Python script.

ExportAdminControllerClass in namespace Biigle\Modules\Sync\Http\Controllers\Views
ExportClass in namespace Biigle\Modules\Sync\Support\Export
Import::expectedFiles() — Method in class Import

The files expected by this import.

Import::expectKeysInJson() — Method in class Import

Validates a JSON file to contain an array of objects, each of which has all the expected keys.

Import::expectColumnsInCsv() — Method in class Import

Validates a CSV file to contain the expected columns.

LabelTreeImport::expectedFiles() — Method in class LabelTreeImport

The files expected by this import.

PublicLabelTreeImport::expectedFiles() — Method in class PublicLabelTreeImport

The files expected by this import.

UserImport::expectedFiles() — Method in class UserImport

The files expected by this import.

VolumeImport::expectedFiles() — Method in class VolumeImport

The files expected by this import.

UserDiskController::extend() — Method in class UserDiskController

Extend a storage disk

ExtendUserDiskClass in namespace Biigle\Modules\UserDisks\Http\Requests
UserDisk::extend() — Method in class UserDisk

Extend the expiration date of the disk.

StorageRequestController::extend() — Method in class StorageRequestController

Extend a storage request

ExtendStorageRequestClass in namespace Biigle\Modules\UserStorage\Http\Requests
ProjectPolicy::editIn() — Method in class ProjectPolicy

Determine if the user can edit things in the given project.

VolumePolicy::editIn() — Method in class VolumePolicy

Determine if the user can edit something in the given volume.

Project::editors() — Method in class Project

All members of this project with the editor role.

EventServiceProviderClass in namespace Biigle\Providers
Role::expert() — Method in class Role
Role::expertId() — Method in class Role
Role::editor() — Method in class Role
Role::editorId() — Method in class Role
WormsAdapter::extractParents() — Method in class WormsAdapter

Extract the aphia IDs in correct ordering from a WoRMS classification hierarchy.

ParserFactory::extend() — Method in class ParserFactory

Add a new metadata parser to the list of known parsers.

Shape::ellipse() — Method in class Shape
Shape::ellipseId() — Method in class Shape

F

Annotation::file() — Method in class Annotation

The file, this annotation belongs to.

$ AnnotationLabel#fillableProperty in class AnnotationLabel

The attributes that are mass assignable.

$ Announcement#fillableProperty in class Announcement

The attributes that are mass assignable.

$ UpdateVideoMetadata#ffprobeProperty in class UpdateVideoMetadata

The FFProbe video instance.

LabelSourceAdapterContract::find() — Method in class LabelSourceAdapterContract

Find a label in the label source.

FederatedSearchInstanceClass in namespace Biigle
$ FederatedSearchInstance#fillableProperty in class FederatedSearchInstance

The attributes that are mass assignable.

FederatedSearchModelClass in namespace Biigle
FileClass in namespace Biigle\FileCache\Contracts
FileCacheClass in namespace Biigle\FileCache\Contracts
FileLockedExceptionClass in namespace Biigle\FileCache\Exceptions
FileCacheClass in namespace Biigle\FileCache\Facades
FileCache::fake() — Method in class FileCache

Use testing instance.

FileCacheClass in namespace Biigle\FileCache

The file cache.

$ FileCache#filesProperty in class FileCache

The Filesytem instance to use

FileCacheServiceProviderClass in namespace Biigle\FileCache
FileCacheFakeClass in namespace Biigle\FileCache\Testing
Controller::fuzzyRedirect() — Method in class Controller

Redirects to the _redirect URL, to a route or else back.

FederatedSearchIndexControllerClass in namespace Biigle\Http\Controllers\Api
FederatedSearchInstanceControllerClass in namespace Biigle\Http\Controllers\Api
LabelSourceController::find() — Method in class LabelSourceController

Find labels from a label source.

UserController::find() — Method in class UserController

Finds all users with firstnames or lastnames like $pattern.

FileLabelsControllerClass in namespace Biigle\Http\Controllers\Api\Volumes
FilenamesControllerClass in namespace Biigle\Http\Controllers\Api\Volumes
FileLabelControllerClass in namespace Biigle\Http\Controllers\Api\Volumes\Filters
FileLabelUserControllerClass in namespace Biigle\Http\Controllers\Api\Volumes\Filters
FilenameControllerClass in namespace Biigle\Http\Controllers\Api\Volumes\Filters
ForgotPasswordControllerClass in namespace Biigle\Http\Controllers\Auth
FederatedSearchControllerClass in namespace Biigle\Http\Controllers\Views\Admin
$ DestroyVolumeFile#fileProperty in class DestroyVolumeFile

The file that should be deleted.

$ LinkVideoAnnotation#firstAnnotationProperty in class LinkVideoAnnotation

The first annotation that should be linked.

$ StoreVolumeFileLabel#fileProperty in class StoreVolumeFileLabel

The file to which the label should be attached.

Ifdo::fromFile() — Method in class Ifdo
Ifdo::fromString() — Method in class Ifdo
$ Image#fillableProperty in class Image

The attributes that are mass assignable.

ImageAnnotation::file() — Method in class ImageAnnotation

The file, this annotation belongs to.

ImageLabel::file() — Method in class ImageLabel

The file, this volume file label belongs to.

$ CreateNewImagesOrVideos#filenamesProperty in class CreateNewImagesOrVideos

The filenames of the files to create.

ProcessNewImage::fracToFloat() — Method in class ProcessNewImage

Converts a fracture (string) like "1/2" to a float.

$ ProcessNewVideo#ffmpegVideoProperty in class ProcessNewVideo

The FFMpeg video instance.

$ ProcessNewVideo#ffprobeProperty in class ProcessNewVideo

The FFProbe instance.

$ LsloginId#fillableProperty in class LsloginId

The attributes that are mass assignable.

ComputeNewSequence::failed() — Method in class ComputeNewSequence

Handle a job failure.

FileCoordinatesControllerClass in namespace Biigle\Modules\Geo\Http\Controllers\Api
$ GenerateMissing#forceProperty in class GenerateMissing

Regenerate data without checking if it is missing.

FilterImageAnnotationsByLabelControllerClass in namespace Biigle\Modules\Largo\Http\Controllers\Api\Projects
FilterVideoAnnotationsByLabelControllerClass in namespace Biigle\Modules\Largo\Http\Controllers\Api\Projects
FilterImageAnnotationsByLabelControllerClass in namespace Biigle\Modules\Largo\Http\Controllers\Api\Volumes
FilterVideoAnnotationsByLabelControllerClass in namespace Biigle\Modules\Largo\Http\Controllers\Api\Volumes
$ StoreLargoSession#forceProperty in class StoreLargoSession

The force request attribute.

$ ImageAnnotationLabelFeatureVector#fillableProperty in class ImageAnnotationLabelFeatureVector

The attributes that are mass assignable.

$ ApplyLargoSession#forceProperty in class ApplyLargoSession

Whether to dismiss labels even if they were created by other users.

$ VideoAnnotationLabelFeatureVector#fillableProperty in class VideoAnnotationLabelFeatureVector

The attributes that are mass assignable.

DelphiGather::finish() — Method in class DelphiGather

Finish the Delphi preprocessing after all images have been processed.

FiltersInvalidLaserPointsClass in namespace Biigle\Modules\Laserpoints\Traits
FiltersInvalidLaserPoints::filterInvalidLaserPoints() — Method in class FiltersInvalidLaserPoints

Removes items from the annotations array if the laser point annotations are invalid.

$ EmbeddingAvailable#filenameProperty in class EmbeddingAvailable

The embedding filename on the storage disk.

$ AnnotationCandidateFeatureVector#fillableProperty in class AnnotationCandidateFeatureVector

The attributes that are mass assignable.

StoreMaiaJob::failedAuthorization() — Method in class StoreMaiaJob

Handle a failed authorization attempt.

$ DeleteAnnotationPatchChunk#filesProperty in class DeleteAnnotationPatchChunk

Files to delete in the storage disk.

DetectionJob::failed() — Method in class DetectionJob

The job failed to process.

DispatchMaiaJob::failed() — Method in class DispatchMaiaJob

Handle a job failure.

DispatchObjectDetection::failed() — Method in class DispatchObjectDetection

Handle a job failure.

$ TrainingProposalFeatureVector#fillableProperty in class TrainingProposalFeatureVector

The attributes that are mass assignable.

EmailVerificationRequest::fulfill() — Method in class EmailVerificationRequest

Fulfill the email verification request.

$ Newsletter#fillableProperty in class Newsletter

The attributes that are mass assignable.

$ NewsletterSubscriber#fillableProperty in class NewsletterSubscriber

The attributes that are mass assignable.

FileClass in namespace Biigle\Modules\Reports\Support
$ AbundanceReportGenerator#filenameProperty in class AbundanceReportGenerator

Name of the report for use as (part of) a filename.

$ AnnotationLocationReportGenerator#filenameProperty in class AnnotationLocationReportGenerator

Name of the report for use as (part of) a filename.

$ AreaReportGenerator#filenameProperty in class AreaReportGenerator

Name of the report for use as (part of) a filename.

$ BasicReportGenerator#filenameProperty in class BasicReportGenerator

Name of the report for use as (part of) a filename.

$ CocoReportGenerator#filenameProperty in class CocoReportGenerator

Name of the report for use as (part of) a filename.

$ CsvReportGenerator#filenameProperty in class CsvReportGenerator

Name of the report for use as (part of) a filename.

$ ExtendedReportGenerator#filenameProperty in class ExtendedReportGenerator

Name of the report for use as (part of) a filename.

FullReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Projects\ImageAnnotations
$ FullReportGenerator#filenameProperty in class FullReportGenerator

Name of the report for use as (part of) a filename.

$ ImageLocationReportGenerator#filenameProperty in class ImageLocationReportGenerator

Name of the report for use as (part of) a filename.

$ ImageIfdoReportGenerator#filenameProperty in class ImageIfdoReportGenerator

Name of the report for use as (part of) a filename.

$ BasicReportGenerator#filenameProperty in class BasicReportGenerator

Name of the report for use as (part of) a filename.

$ CsvReportGenerator#filenameProperty in class CsvReportGenerator

Name of the report for use as (part of) a filename.

$ ImageLocationReportGenerator#filenameProperty in class ImageLocationReportGenerator

Name of the report for use as (part of) a filename.

$ CsvReportGenerator#filenameProperty in class CsvReportGenerator

Name of the report for use as (part of) a filename.

$ VideoIfdoReportGenerator#filenameProperty in class VideoIfdoReportGenerator

Name of the report for use as (part of) a filename.

$ CsvReportGenerator#filenameProperty in class CsvReportGenerator

Name of the report for use as (part of) a filename.

$ ReportGenerator#filenameProperty in class ReportGenerator

Name of the report for use as (part of) a filename.

$ AbundanceReportGenerator#filenameProperty in class AbundanceReportGenerator

Name of the report for use as (part of) a filename.

$ AnnotationLocationReportGenerator#filenameProperty in class AnnotationLocationReportGenerator

Name of the report for use as (part of) a filename.

$ AreaReportGenerator#filenameProperty in class AreaReportGenerator

Name of the report for use as (part of) a filename.

$ BasicReportGenerator#filenameProperty in class BasicReportGenerator

Name of the report for use as (part of) a filename.

$ CocoReportGenerator#filenameProperty in class CocoReportGenerator

Name of the report for use as (part of) a filename.

$ CsvReportGenerator#filenameProperty in class CsvReportGenerator

Name of the report for use as (part of) a filename.

$ ExtendedReportGenerator#filenameProperty in class ExtendedReportGenerator

Name of the report for use as (part of) a filename.

FullReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Volumes\ImageAnnotations
$ FullReportGenerator#filenameProperty in class FullReportGenerator

Name of the report for use as (part of) a filename.

$ ImageLocationReportGenerator#filenameProperty in class ImageLocationReportGenerator

Name of the report for use as (part of) a filename.

$ ImageIfdoReportGenerator#filenameProperty in class ImageIfdoReportGenerator

Name of the report for use as (part of) a filename.

$ BasicReportGenerator#filenameProperty in class BasicReportGenerator

Name of the report for use as (part of) a filename.

$ CsvReportGenerator#filenameProperty in class CsvReportGenerator

Name of the report for use as (part of) a filename.

$ ImageLocationReportGenerator#filenameProperty in class ImageLocationReportGenerator

Name of the report for use as (part of) a filename.

$ CsvReportGenerator#filenameProperty in class CsvReportGenerator

Name of the report for use as (part of) a filename.

$ VideoIfdoReportGenerator#filenameProperty in class VideoIfdoReportGenerator

Name of the report for use as (part of) a filename.

$ CsvReportGenerator#filenameProperty in class CsvReportGenerator

Name of the report for use as (part of) a filename.

Import::filesMatch() — Method in class Import

Check if this import matches to the given import files.

Import::files() — Method in class Import

Get the basename of each file of this import.

$ UserDisk#fillableProperty in class UserDisk

The attributes that are mass assignable.

$ DestroyStorageRequestFile#fileProperty in class DestroyStorageRequestFile

Storage request file that should be deleted.

$ AssembleChunkedFile#fileProperty in class AssembleChunkedFile

The file to assemble.

$ DeleteStorageRequestFile#fileIdProperty in class DeleteStorageRequestFile

ID of the file that should be deleted

FilePrefixClass in namespace Biigle\Modules\UserStorage\Rules
$ StorageRequest#fillableProperty in class StorageRequest

The attributes that are mass assignable.

StorageRequest::files() — Method in class StorageRequest

The files belonging to this storage request.

$ StorageRequestFile#fillableProperty in class StorageRequestFile

The attributes that are mass assignable.

$ PendingVolume#fillableProperty in class PendingVolume

The attributes that are mass assignable.

FederatedSearchInstancePolicyClass in namespace Biigle\Policies
ProjectPolicy::forceEditIn() — Method in class ProjectPolicy

Determine if the user can edit things created by other users in the given project.

VolumePolicy::forceEditIn() — Method in class VolumePolicy

Determine if the user can edit things created by other users in the given volume.

Project::flushGeoInfoCache() — Method in class Project

Flush the cached information if this project has volumes which have images with GPS coordinates.

$ ProjectInvitation#fillableProperty in class ProjectInvitation

The attributes that are mass assignable.

ImageMetadata::fileMetadataPasses() — Method in class ImageMetadata
$ VolumeFileUnique#filesProperty in class VolumeFileUnique

The filenames that already exist.

WormsAdapter::find() — Method in class WormsAdapter

Find labels by scientific name.

WormsAdapter::filterUnaccepted() — Method in class WormsAdapter

Returns true for accepted WoRMS items and false otherwise.

FileMetadataClass in namespace Biigle\Services\MetadataParsing
$ MetadataParser#fileObjectProperty in class MetadataParser
$ VideoMetadata#framesProperty in class VideoMetadata
$ VolumeMetadata#filesProperty in class VolumeMetadata
FilesystemManagerClass in namespace Biigle\Support
User::federatedSearchModels() — Method in class User

The federated search models that the user can access

$ Video#fillableProperty in class Video

The attributes that are mass assignable.

$ VideoAnnotation#fillableProperty in class VideoAnnotation

The attributes that are mass assignable.

VideoAnnotation::file() — Method in class VideoAnnotation

The file, this annotation belongs to.

VideoLabel::file() — Method in class VideoLabel

The file, this volume file label belongs to.

$ Volume#fillableProperty in class Volume

The attributes that are mass assignable.

Volume::files() — Method in class Volume

The images or videos belonging to this volume.

Volume::flushThumbnailCache() — Method in class Volume

Flush the cache that stores the volume thumbnail.

Volume::flushGeoInfoCache() — Method in class Volume

Flush the cached information if this volume has images with GPS coordinates.

$ VolumeFile#filenameProperty in class VolumeFile
VolumeFileLabel::file() — Method in class VolumeFileLabel

The file, this volume file label belongs to.

G

Annotation::getFileIdAttribute() — Method in class Annotation

Get the file_id attribute

Annotation::getPoints() — Method in class Annotation

Get the points array of the annotation.

Annotation::getShape() — Method in class Annotation

Get the shape of an annotation.

Annotation::getFile() — Method in class Annotation

Get the image/video, the annotation belongs to.

AnnotationSession::getVolumeFileAnnotations() — Method in class AnnotationSession

Get the annotations of the file (with labels), filtered by the restrictions of this annotation session.

AnnotationSession::getStartsAtIso8601Attribute() — Method in class AnnotationSession

Get the start date formatted as ISO8601 string.

AnnotationSession::getEndsAtIso8601Attribute() — Method in class AnnotationSession

Get the end date formatted as ISO8601 string.

Announcement::getActive() — Method in class Announcement

Get the currently active announcement.

Annotation::getPoints() — Method in class Annotation

Get the points array of the annotation.

Annotation::getShape() — Method in class Annotation

Get the shape of an annotation.

Annotation::getFile() — Method in class Annotation

Get the image/video, the annotation belongs to.

Modules::getFacadeAccessor() — Method in class Modules

Get the registered name of the component.

FederatedSearchInstance::getRemoteTokenAttribute() — Method in class FederatedSearchInstance

Get the remote_token attribute.

FederatedSearchModel::getThumbnailUrlAttribute() — Method in class FederatedSearchModel

Get the model thumbnail url attribute.

FederatedSearchModel::getThumbnailUrlsAttribute() — Method in class FederatedSearchModel

Get the model thumbnail url attribute.

File::getUrl() — Method in class File

Get the file URL.

FileCache::get() — Method in class FileCache

Perform a callback with the path of a cached file. This takes care of shared locks on the cached file file so it is not corrupted due to concurrent write operations.

FileCache::getOnce() — Method in class FileCache

Like get but deletes the cached file afterwards (if it is not used somewhere else).

FileCache::getStream() — Method in class FileCache

Get a stream resource for an file. If the file is cached, the resource points to the cached file instead. This will not cache uncached files. Make sure to close the streams!

FileCache::getFacadeAccessor() — Method in class FileCache

Get the registered name of the component.

FileCache::get() — Method in class FileCache

Perform a callback with the path of a cached file. This takes care of shared locks on the cached file file so it is not corrupted due to concurrent write operations.

FileCache::getOnce() — Method in class FileCache

Like get but deletes the cached file afterwards (if it is not used somewhere else).

FileCache::getStream() — Method in class FileCache

Get a stream resource for an file. If the file is cached, the resource points to the cached file instead. This will not cache uncached files. Make sure to close the streams!

FileCache::getDiskFile() — Method in class FileCache

Cache an file from a storage disk and get the path to the cached file. Files from local disks are not cached.

FileCache::getCachedPath() — Method in class FileCache

Get the path to the cached file file.

FileCache::getFileStream() — Method in class FileCache

Get the stream resource for an file.

FileCache::getDisk() — Method in class FileCache

Get the storage disk on which a file is stored.

GenericFileClass in namespace Biigle\FileCache
GenericFile::getUrl() — Method in class GenericFile

Get the file URL.

FileCacheFake::get() — Method in class FileCacheFake

Perform a callback with the path of a cached file. This takes care of shared locks on the cached file file so it is not corrupted due to concurrent write operations.

FileCacheFake::getOnce() — Method in class FileCacheFake

Like get but deletes the cached file afterwards (if it is not used somewhere else).

FileCacheFake::getStream() — Method in class FileCacheFake

Get a stream resource for an file. If the file is cached, the resource points to the cached file instead. This will not cache uncached files. Make sure to close the streams!

ImageLabelController::getFileModel() — Method in class ImageLabelController

Get the file model class name.

ImageLabelController::getFileLabelModel() — Method in class ImageLabelController

Get the file label model class name.

VideoFileController::getByteRange() — Method in class VideoFileController

Determine the byte range that should be included in the response.

VideoLabelController::getFileModel() — Method in class VideoLabelController

Get the file model class name.

VideoLabelController::getFileLabelModel() — Method in class VideoLabelController

Get the file label model class name.

VolumeController::getFileIdsSortedByAnnotationTimestamps() — Method in class VolumeController

Return file ids which are sorted by annotations.created_at

VolumeFileLabelController::getFileModel() — Method in class VolumeFileLabelController

Get the file model class name.

VolumeFileLabelController::getFileLabelModel() — Method in class VolumeFileLabelController

Get the file label model class name.

IndexController::get() — Method in class IndexController

Shows the admin dashboard.

UsersController::get() — Method in class UsersController

Shows the admin users page.

ProjectStatisticsController::getVolumeStatistics() — Method in class ProjectStatisticsController

Get the statistics of volumes with a certain media type.

VolumeController::getProjects() — Method in class VolumeController

Get all projects that belong to a volume and that the user can access.

DestroyImage::getFileModel() — Method in class DestroyImage

Get the file model class name.

DestroyVideo::getFileModel() — Method in class DestroyVideo

Get the file model class name.

DestroyVolumeFile::getFileModel() — Method in class DestroyVolumeFile

Get the file model class name.

StoreImageLabel::getFileModel() — Method in class StoreImageLabel

Get the file model class;

StoreLabelTreeMerge::getFlatLabels() — Method in class StoreLabelTreeMerge

Returns a flat list of a nested array of labels and assigns a parent_index to each label, which indicates the position of the parent label in the list (as opposed to a parent_id, sinde the labels have no ID yet).

StoreVideoLabel::getFileModel() — Method in class StoreVideoLabel

Get the file model class;

StoreVolumeFileLabel::getFileModel() — Method in class StoreVolumeFileLabel

Get the file model class;

Ifdo::getValidator() — Method in class Ifdo
Ifdo::getErrors() — Method in class Ifdo
Ifdo::getDebug() — Method in class Ifdo
Ifdo::getJsonData() — Method in class Ifdo
Ifdo::getImageSetHeader() — Method in class Ifdo
Ifdo::getImageSetItems() — Method in class Ifdo
Ifdo::getIfdoVersion() — Method in class Ifdo
Image::getFile() — Method in class Image

Get the original image as download response.

Image::getTilingInProgressAttribute() — Method in class Image

Get the tilingInProgress attribute.

Image::getThumbnailUrlAttribute() — Method in class Image

URL to the thumbnail of this image.

ImageAnnotation::getFileIdAttribute() — Method in class ImageAnnotation

Get the file_id attribute

ImageLabel::getFileIdAttribute() — Method in class ImageLabel

Get the file ID attribute.

GenerateFederatedSearchIndexClass in namespace Biigle\Jobs
GenerateFederatedSearchIndex::generateLabelTreeIndex() — Method in class GenerateFederatedSearchIndex

Generate the label tree index.

GenerateFederatedSearchIndex::generateProjectIndex() — Method in class GenerateFederatedSearchIndex

Generate the project index.

GenerateFederatedSearchIndex::generateVolumeIndex() — Method in class GenerateFederatedSearchIndex

Generate the volume index.

ProcessNewImage::getExif() — Method in class ProcessNewImage

Get the exif information of an image if possible.

ProcessNewImage::getGps() — Method in class ProcessNewImage

Converts a EXIF GPS coordinate to a float see: http://stackoverflow.com/a/2572991/1796523.

ProcessNewImage::getVipsImage() — Method in class ProcessNewImage

Get a Vips image instance for the file.

ProcessNewVideo::getCodec() — Method in class ProcessNewVideo

Get the codec of a video

ProcessNewVideo::getVideoDuration() — Method in class ProcessNewVideo

Get the duration of the video.

ProcessNewVideo::getVideoDimensions() — Method in class ProcessNewVideo

Get the dimensions of a video

ProcessNewVideo::generateVideoThumbnail() — Method in class ProcessNewVideo

Generate a thumbnail from the video at the specified time.

ProcessNewVideo::getThumbnailTimes() — Method in class ProcessNewVideo

Get the times at which thumbnails should be sampled.

TileSingleImage::generateTiles() — Method in class TileSingleImage

Generate tiles for the image and put them to temporary storage.

TileSingleImage::getVipsImage() — Method in class TileSingleImage

Get the vips image instance.

TileSingleImage::getIterator() — Method in class TileSingleImage

Get the recursive directory iterator for the given path.

TrackObject::getRateLimitCacheKey() — Method in class TrackObject

Return the cache key to store the number of concurrent jobs for each user.

TrackObject::getTrackingKeyframes() — Method in class TrackObject

Execute the object tracking method and get the resulting annotation key frames.

TrackObject::getInputJsonPath() — Method in class TrackObject

Get the path to to input file for the object tracking script.

TrackObject::getOutputJsonPath() — Method in class TrackObject

Get the path to to output file for the object tracking script.

TrackObject::getStartWindow() — Method in class TrackObject

Get the coordinates and dimensions of the start window for the object tracking script.

TrackObject::getPointsFromKeyframe() — Method in class TrackObject

Get the points of a keyframe depending on the annotation shape.

UpdateFederatedSearchIndex::getValidator() — Method in class UpdateFederatedSearchIndex

Get the validator instance for the response.

LabelSource::getAdapter() — Method in class LabelSource

Returns the label source adapter of this label source.

LabelTree::getVersionedNameAttribute() — Method in class LabelTree

Get the name with a version suffix of this label tree.

CreateRedisLogger::getFallbackChannelName() — Method in class CreateRedisLogger

Get fallback log channel name.

LogManager::getLogFilenames() — Method in class LogManager

Get the filenames of the logfiles.

LogManager::getLogFileContent() — Method in class LogManager

Get the content of a logfile.

LogManager::getRedisLogMessages() — Method in class LogManager

Get the log messages.

LogManager::getRecentCount() — Method in class LogManager

Get the number of log messages of the last day(s).

LogManager::getFallbackChannelName() — Method in class LogManager

Get fallback log channel name.

AnnotationAssistanceRequest::generateToken() — Method in class AnnotationAssistanceRequest

Generate a token for use in the annotation assistance request URL.

AnnotationAssistanceRequest::getResponseLabelAttribute() — Method in class AnnotationAssistanceRequest

Get the chosen response label from the request labels array.

GeoServiceProviderClass in namespace Biigle\Modules\Geo
DetermineStorageUsage::getSizeInGB() — Method in class DetermineStorageUsage
Requests::getActions() — Method in class Requests
Requests::getVisits() — Method in class Requests
Storage::getStorageUsage() — Method in class Storage
User::getUser() — Method in class User
User::getUniqueUser() — Method in class User
GenerateMissingClass in namespace Biigle\Modules\Largo\Console\Commands
StoreLargoSession::getAffectedAnnotations() — Method in class StoreLargoSession

Get a list of unique annotation IDs that are either dismissed or changed.

StoreLargoSession::getRequiredLabelTrees() — Method in class StoreLargoSession

Returns the IDs of all label trees that must be available to apply the changes.

StoreProjectLargoSession::getAffectedImageVolumes() — Method in class StoreProjectLargoSession

Get the IDs of the image volumes that are associated with the referenced image annotations.

StoreProjectLargoSession::getAffectedVideoVolumes() — Method in class StoreProjectLargoSession

Get the IDs of the video volumes that are associated with the referenced video annotations.

StoreVolumeLargoSession::getAvailableLabelTrees() — Method in class StoreVolumeLargoSession

Get label trees of projects that the requesting user and the volume have in common.

CopyAnnotationFeatureVector::getFeatureVectorQuery() — Method in class CopyAnnotationFeatureVector

Get a query for the feature vectors associated with the annotation of this job.

CopyImageAnnotationFeatureVector::getFeatureVectorQuery() — Method in class CopyImageAnnotationFeatureVector

Get a query for the feature vectors associated with the annotation of this job.

CopyVideoAnnotationFeatureVector::getFeatureVectorQuery() — Method in class CopyVideoAnnotationFeatureVector

Get a query for the feature vectors associated with the annotation of this job.

GenerateFeatureVectorsClass in namespace Biigle\Modules\Largo\Jobs
GenerateFeatureVectors::getAnnotationBoundingBox() — Method in class GenerateFeatureVectors

Get the bounding box of an annotation

GenerateFeatureVectors::getPointBoundingBox() — Method in class GenerateFeatureVectors

Get the bounding box of a point annotation.

GenerateFeatureVectors::getCircleBoundingBox() — Method in class GenerateFeatureVectors

Get the bounding box of a circle annotation.

GenerateFeatureVectors::getPolygonBoundingBox() — Method in class GenerateFeatureVectors

Get the bounding box of an annotation that is no point, circle or whole frame.

GenerateFeatureVectors::generateInput() — Method in class GenerateFeatureVectors

Generate the input for the python script.

GenerateFeatureVectors::generateFileInput() — Method in class GenerateFeatureVectors
InitializeFeatureVectorChunk::getInsertData() — Method in class InitializeFeatureVectorChunk

Get the array to insert new feature vector models into the DB.

InitializeFeatureVectorChunk::getFeatureVectors() — Method in class InitializeFeatureVectorChunk

Generate feature vectors from the thumbnails of many annotations.

ProcessAnnotatedFile::getTargetPath() — Method in class ProcessAnnotatedFile

Assemble the target path for an annotation patch.

ProcessAnnotatedFile::getAnnotationPatch() — Method in class ProcessAnnotatedFile

Get the annotation patch as buffer.

ProcessAnnotatedFile::generateFeatureVectors() — Method in class ProcessAnnotatedFile

Generates feature vectors for the specified annotations belonging to the file of this job. This method either creates new feature vector models or updates the existing ones for the annotations.

ProcessAnnotatedFile::getAnnotationQuery() — Method in class ProcessAnnotatedFile

Get the query builder for the annotations (maybe filtered by IDs).

ProcessAnnotatedFile::getSVGAnnotation() — Method in class ProcessAnnotatedFile

Draw annotation as SVG

ProcessAnnotatedFile::getRectangleSvgAnnotation() — Method in class ProcessAnnotatedFile

Get an SVG rectangle element.

ProcessAnnotatedFile::getEllipseSvgAnnotation() — Method in class ProcessAnnotatedFile

Get an SVG ellipse element.

ProcessAnnotatedFile::getOrientedCoordinates() — Method in class ProcessAnnotatedFile

Determines position of coordinate

ProcessAnnotatedImage::generateFeatureVectors() — Method in class ProcessAnnotatedImage

Generates feature vectors for the specified annotations belonging to the file of this job. This method either creates new feature vector models or updates the existing ones for the annotations.

ProcessAnnotatedImage::getVipsImage() — Method in class ProcessAnnotatedImage

Get the vips image instance.

ProcessAnnotatedImage::getAnnotationQuery() — Method in class ProcessAnnotatedImage

Get the query builder for the annotations (maybe filtered by IDs).

ProcessAnnotatedVideo::getVideo() — Method in class ProcessAnnotatedVideo

Get the FFMpeg video instance.

ProcessAnnotatedVideo::getVideoFrame() — Method in class ProcessAnnotatedVideo

Get a video frame from a specific time as VipsImage object.

ProcessAnnotatedVideo::getAnnotationQuery() — Method in class ProcessAnnotatedVideo

Get the query builder for the annotations (maybe filtered by IDs).

AnnotationObserver::getSavedDispatch() — Method in class AnnotationObserver

Get the dispatched job on a saved event.

AnnotationObserver::getDeletingDispatch() — Method in class AnnotationObserver

Get the dispatched job on a deleting event.

ImageAnnotationObserver::getSavedDispatch() — Method in class ImageAnnotationObserver

Get the dispatched job on a saved event.

ImageAnnotationObserver::getDeletingDispatch() — Method in class ImageAnnotationObserver

Get the dispatched job on a deleting event.

VideoAnnotationObserver::getSavedDispatch() — Method in class VideoAnnotationObserver

Get the dispatched job on a saved event.

VideoAnnotationObserver::getDeletingDispatch() — Method in class VideoAnnotationObserver

Get the dispatched job on a deleting event.

Image::getLaserpointsAttribute() — Method in class Image

Return the dynamic attribute for the laser points information.

Image::getAreaAttribute() — Method in class Image

Get the area attribute from the laser point detection.

Image::getCountAttribute() — Method in class Image

Get the count attribute from the laser point detection.

Image::getMethodAttribute() — Method in class Image

Get the method attribute from the laser point detection.

Image::getDistanceAttribute() — Method in class Image

Get the distance attribute from the laser point detection.

Image::getPointsAttribute() — Method in class Image

Get the points attribute from the laser point detection.

Image::getErrorAttribute() — Method in class Image

Get the error attribute from the laser point detection.

Image::getMessageAttribute() — Method in class Image

Get the message attribute from the lase point detection.

Job::getLaserpointsForVolume() — Method in class Job

Collects all images of a volume that contain laser point annotations.

Job::gather() — Method in class Job

Perform the gather step.

$ ProcessDelphiJob#gatherFileProperty in class ProcessDelphiJob

Path to the output of the Delphi gather script.

ProcessImageManualJob::getLaserpointsForImage() — Method in class ProcessImageManualJob

Collects the laser point annotations of the given image.

DelphiGather::getOutputPath() — Method in class DelphiGather

Get the path to the temporary ouput file of the Delphi gather script.

GenerateEmbeddingClass in namespace Biigle\Modules\MagicSam\Jobs
GenerateEmbedding::generateEmbedding() — Method in class GenerateEmbedding

Generate the embedding.

GenericImageClass in namespace Biigle\Modules\Maia
GenericImage::getId() — Method in class GenericImage

Get the image ID.

MaiaJobConvertingCandidatesController::get() — Method in class MaiaJobConvertingCandidatesController

Check whether a job to convert candidates is running

DeleteAnnotationPatches::getAnnotationsArray() — Method in class DeleteAnnotationPatches

Get the array of annotation IDs and their image ids.

DetectionJob::getGenericImages() — Method in class DetectionJob

Create GenericImage instances for the images of this job.

DetectionJob::getTmpDirPath() — Method in class DetectionJob

Get the path to the temporary directory.

GenerateAnnotationCandidateFeatureVectorsClass in namespace Biigle\Modules\Maia\Jobs
GenerateAnnotationCandidateFeatureVectors::getAnnotations() — Method in class GenerateAnnotationCandidateFeatureVectors

Get the training proposals or annotation candidates of the job.

GenerateAnnotationCandidatePatchesClass in namespace Biigle\Modules\Maia\Jobs
GenerateAnnotationFeatureVectorsClass in namespace Biigle\Modules\Maia\Jobs
GenerateAnnotationFeatureVectors::getAnnotations() — Method in class GenerateAnnotationFeatureVectors

Get the training proposals or annotation candidates of the job.

GenerateTrainingProposalFeatureVectorsClass in namespace Biigle\Modules\Maia\Jobs
GenerateTrainingProposalFeatureVectors::getAnnotations() — Method in class GenerateTrainingProposalFeatureVectors

Get the training proposals or annotation candidates of the job.

GenerateTrainingProposalPatchesClass in namespace Biigle\Modules\Maia\Jobs
NoveltyDetection::getTmpDirPath() — Method in class NoveltyDetection

Get the path to the temporary directory.

ObjectDetection::generateDataset() — Method in class ObjectDetection

Generate the training dataset for the object detection model.

ObjectDetection::getTmpDirPath() — Method in class ObjectDetection

Get the path to the temporary directory.

ObjectDetection::getKnowledgeTransferImages() — Method in class ObjectDetection

Create GenericImage instances for the images of the knowledge transfer volume.

PrepareAnnotationsJob::getAnnotationsQuery() — Method in class PrepareAnnotationsJob

Get the query for the annotations to convert.

PrepareExistingAnnotations::getAnnotationsQuery() — Method in class PrepareExistingAnnotations

Get the query for the annotations to convert.

PrepareKnowledgeTransfer::getDistanceScaleFactors() — Method in class PrepareKnowledgeTransfer

Get the scale factors based on distance to ground.

PrepareKnowledgeTransfer::getAreaScaleFactors() — Method in class PrepareKnowledgeTransfer

Get the scale factors based on image area.

PrepareKnowledgeTransfer::getAnnotationsQuery() — Method in class PrepareKnowledgeTransfer

Get the query for the annotations to convert.

ProcessNoveltyDetectedImage::getAnnotationQuery() — Method in class ProcessNoveltyDetectedImage

Get the query builder for the annotations (maybe filtered by IDs).

ProcessObjectDetectedImage::getAnnotationQuery() — Method in class ProcessObjectDetectedImage

Get the query builder for the annotations (maybe filtered by IDs).

MaiaAnnotation::getPoints() — Method in class MaiaAnnotation

Get the points array of the annotation.

MaiaAnnotation::getShape() — Method in class MaiaAnnotation

Get the shape of an annotation.

MaiaAnnotation::getFile() — Method in class MaiaAnnotation

Get the image/video, the annotation belongs to.

MaiaJob::getParamsAttribute() — Method in class MaiaJob

Get the configured parameters of this job.

MaiaJob::getErrorAttribute() — Method in class MaiaJob

Get the error information on this job (if any).

MaiaJob::getConvertingCandidatesAttribute() — Method in class MaiaJob

Determine whether a job to convert candidates is running.

JobStateChanged::getTitle() — Method in class JobStateChanged

Get the title for the state change.

JobStateChanged::getMessage() — Method in class JobStateChanged

Get the message for the state change.

NoveltyDetectionComplete::getTitle() — Method in class NoveltyDetectionComplete

Get the title for the state change.

NoveltyDetectionComplete::getMessage() — Method in class NoveltyDetectionComplete

Get the message for the state change.

NoveltyDetectionFailed::getTitle() — Method in class NoveltyDetectionFailed

Get the title for the state change.

NoveltyDetectionFailed::getMessage() — Method in class NoveltyDetectionFailed

Get the message for the state change.

ObjectDetectionComplete::getTitle() — Method in class ObjectDetectionComplete

Get the title for the state change.

ObjectDetectionComplete::getMessage() — Method in class ObjectDetectionComplete

Get the message for the state change.

ObjectDetectionFailed::getTitle() — Method in class ObjectDetectionFailed

Get the title for the state change.

ObjectDetectionFailed::getMessage() — Method in class ObjectDetectionFailed

Get the message for the state change.

QueriesExistingAnnotations::getExistingAnnotationsQuery() — Method in class QueriesExistingAnnotations

Get the query for the annotations to convert.

IfdoParser::getKnownMimeTypes() — Method in class IfdoParser

Get the MIME types that files known by this parser can have.

IfdoParser::getName() — Method in class IfdoParser

Get the name of the parser to show it to users selecting files.

IfdoParser::getIfdo() — Method in class IfdoParser
IfdoParser::getMetadata() — Method in class IfdoParser

Get a filled VolumeMetadata object based on the file.

EmailVerificationRequest::getUserResolver() — Method in class EmailVerificationRequest

Get the user resolver callback.

StoreReport::getOptions() — Method in class StoreReport

Get the options for the new report.

StoreVolumeReport::getOptions() — Method in class StoreVolumeReport

Get the options for the new report.

GenerateReportJobClass in namespace Biigle\Modules\Reports\Jobs
Report::getSourceNameAttribute() — Method in class Report

Get the source name dynamically if the source still exists.

Report::getReportGenerator() — Method in class Report

Get the report generator for this report;.

Report::generate() — Method in class Report

Generate the report file for this report.

Report::getSubjectAttribute() — Method in class Report

Get the subject for this report.

Report::getNameAttribute() — Method in class Report

Get the name for this report.

Report::getFilenameAttribute() — Method in class Report

Get the filename for this report.

Report::getUrl() — Method in class Report

Get the URL to download the report.

Report::getStorageFilename() — Method in class Report

Get the filename of the report in storage (not the filename for download).

File::getPath() — Method in class File

Returns the path to the file.

AnnotationLocationReportGenerator::getProjectSources() — Method in class AnnotationLocationReportGenerator

Get sources for the sub-reports that should be generated for this project.

AnnotationReportGenerator::getName() — Method in class AnnotationReportGenerator

Get the report name.

AnnotationReportGenerator::getFilename() — Method in class AnnotationReportGenerator

Get the filename.

ImageLocationReportGenerator::getProjectSources() — Method in class ImageLocationReportGenerator

Get sources for the sub-reports that should be generated for this project.

ImageIfdoReportGenerator::getProjectSources() — Method in class ImageIfdoReportGenerator

Get sources for the sub-reports that should be generated for this project.

ImageLocationReportGenerator::getProjectSources() — Method in class ImageLocationReportGenerator

Get sources for the sub-reports that should be generated for this project.

ProjectImageReportGenerator::getProjectSources() — Method in class ProjectImageReportGenerator

Get sources for the sub-reports that should be generated for this project.

ProjectReportGenerator::generateReport() — Method in class ProjectReportGenerator

Generate the report.

ProjectReportGenerator::getProjectSources() — Method in class ProjectReportGenerator

Get sources for the sub-reports that should be generated for this project.

ProjectReportGenerator::getReportGenerator() — Method in class ProjectReportGenerator

Get the report generator.

ProjectVideoReportGenerator::getProjectSources() — Method in class ProjectVideoReportGenerator

Get sources for the sub-reports that should be generated for this project.

CsvReportGenerator::getName() — Method in class CsvReportGenerator

Get the report name.

CsvReportGenerator::getFilename() — Method in class CsvReportGenerator

Get the filename.

VideoIfdoReportGenerator::getProjectSources() — Method in class VideoIfdoReportGenerator

Get sources for the sub-reports that should be generated for this project.

ReportGenerator::get() — Method in class ReportGenerator

Get the report generator for the given type.

ReportGenerator::generate() — Method in class ReportGenerator

Generate the report.

ReportGenerator::generateReport() — Method in class ReportGenerator

Internal function to generate the report.

ReportGenerator::getName() — Method in class ReportGenerator

Get the report name.

ReportGenerator::getFilename() — Method in class ReportGenerator

Get the report filename.

ReportGenerator::getFullFilename() — Method in class ReportGenerator

Get the filename with extension.

ReportGenerator::getSiblingLabels() — Method in class ReportGenerator

Get all labels that belong to the label tree of the given label.

ReportGenerator::getOnlyLabels() — Method in class ReportGenerator

Returns the array of label ids to which this report should be restricted.

IfdoReportGenerator::generateReport() — Method in class IfdoReportGenerator

Generate the report.

IfdoReportGenerator::getUsers() — Method in class IfdoReportGenerator

Get all users who annotated in the volume.

IfdoReportGenerator::getLabels() — Method in class IfdoReportGenerator

Get all labels that were used in the volume.

IfdoReportGenerator::getIfdo() — Method in class IfdoReportGenerator

Get the iFDO object of the volume if it has any.

IfdoReportGenerator::getWormsUrn() — Method in class IfdoReportGenerator

Get the WoRMS URN for a label (if it has one).

IfdoReportGenerator::getGeometryName() — Method in class IfdoReportGenerator

Get an iFDO geometry name string for an annotation.

AbundanceReportGenerator::generateReport() — Method in class AbundanceReportGenerator

Generate the report.

AnnotationLocationReportGenerator::generateReport() — Method in class AnnotationLocationReportGenerator

Generate the report.

AnnotationReportGenerator::getName() — Method in class AnnotationReportGenerator

Get the report name.

AnnotationReportGenerator::getFilename() — Method in class AnnotationReportGenerator

Get the filename.

AreaReportGenerator::generateReport() — Method in class AreaReportGenerator

Generate the report.

BasicReportGenerator::generateReport() — Method in class BasicReportGenerator

Generate the report.

CocoReportGenerator::generateReport() — Method in class CocoReportGenerator

Generate the report.

CsvReportGenerator::generateReport() — Method in class CsvReportGenerator

Generate the report.

ExtendedReportGenerator::generateReport() — Method in class ExtendedReportGenerator

Generate the report.

FullReportGenerator::generateReport() — Method in class FullReportGenerator

Generate the report.

FullReportGenerator::getArea() — Method in class FullReportGenerator

Parses the image attrs JSON object to retrieve the computed area of the laserpoint detection.

ImageLocationReportGenerator::generateReport() — Method in class ImageLocationReportGenerator

Generate the report.

ImageIfdoReportGenerator::getUsers() — Method in class ImageIfdoReportGenerator

Get all users who annotated in the volume.

ImageIfdoReportGenerator::getLabels() — Method in class ImageIfdoReportGenerator

Get all labels that were used in the volume.

BasicReportGenerator::generateReport() — Method in class BasicReportGenerator

Generate the report.

CsvReportGenerator::generateReport() — Method in class CsvReportGenerator

Generate the report.

ImageLocationReportGenerator::generateReport() — Method in class ImageLocationReportGenerator

Generate the report.

CsvReportGenerator::getName() — Method in class CsvReportGenerator

Get the report name.

CsvReportGenerator::getFilename() — Method in class CsvReportGenerator

Get the filename.

CsvReportGenerator::generateReport() — Method in class CsvReportGenerator

Generate the report.

VideoIfdoReportGenerator::getUsers() — Method in class VideoIfdoReportGenerator

Get all users who annotated in the volume.

VideoIfdoReportGenerator::getLabels() — Method in class VideoIfdoReportGenerator

Get all labels that were used in the volume.

CsvReportGenerator::generateReport() — Method in class CsvReportGenerator

Generate the report.

VolumeReportGenerator::getVolumeLabels() — Method in class VolumeReportGenerator

Get all labels that are attached to the volume of this report (through project label trees).

VolumeReportGenerator::getAnnotationSession() — Method in class VolumeReportGenerator

Returns the annotation session this report should be restricted to.

VolumeReportGenerator::getAnnotationSessionName() — Method in class VolumeReportGenerator

Get the name of the annotation session if it exists.

RestrictsToExportArea::getSkipIds() — Method in class RestrictsToExportArea

Returns the annotation IDs to skip as outside of the volume export area.

Volume::getExportAreaAttribute() — Method in class Volume

Return the dynamic attribute for the export area.

Uuids::generateOutput() — Method in class Uuids

Generate the output that can be used as file to synchronize user UUIDs.

Controller::getQuery() — Method in class Controller

Get the query for the model to export.

Controller::getExport() — Method in class Controller

Get the new export instance.

Controller::getExportFilename() — Method in class Controller

Get the filename of the export archive.

LabelTreeExportController::getQuery() — Method in class LabelTreeExportController

Get the query for the model to export.

LabelTreeExportController::getExport() — Method in class LabelTreeExportController

Get the new export instance.

LabelTreeExportController::getExportFilename() — Method in class LabelTreeExportController

Get the filename of the export archive.

UserExportController::getQuery() — Method in class UserExportController

Get the query for the model to export.

UserExportController::getExport() — Method in class UserExportController

Get the new export instance.

UserExportController::getExportFilename() — Method in class UserExportController

Get the filename of the export archive.

VolumeExportController::getQuery() — Method in class VolumeExportController

Get the query for the model to export.

VolumeExportController::getExport() — Method in class VolumeExportController

Get the new export instance.

VolumeExportController::getExportFilename() — Method in class VolumeExportController

Get the filename of the export archive.

Export::getArchive() — Method in class Export

Generate the export archive file and return the temporary file path.

Export::getContent() — Method in class Export

Get the content of the export file. If a string, it is the path to the temporary file containing the content (like a CSV).

Export::getFileName() — Method in class Export

Get the name of the export file.

Export::getAdditionalExports() — Method in class Export

Get additional exports that should be included in the export archive.

ImageAnnotationExport::getContent() — Method in class ImageAnnotationExport

Get the content of the export file. If a string, it is the path to the temporary file containing the content (like a CSV).

ImageAnnotationExport::getFileName() — Method in class ImageAnnotationExport

Get the name of the export file.

ImageAnnotationLabelExport::getContent() — Method in class ImageAnnotationLabelExport

Get the content of the export file. If a string, it is the path to the temporary file containing the content (like a CSV).

ImageAnnotationLabelExport::getFileName() — Method in class ImageAnnotationLabelExport

Get the name of the export file.

ImageExport::getContent() — Method in class ImageExport

Get the content of the export file. If a string, it is the path to the temporary file containing the content (like a CSV).

ImageExport::getFileName() — Method in class ImageExport

Get the name of the export file.

ImageLabelExport::getContent() — Method in class ImageLabelExport

Get the content of the export file. If a string, it is the path to the temporary file containing the content (like a CSV).

ImageLabelExport::getFileName() — Method in class ImageLabelExport

Get the name of the export file.

LabelTreeExport::getContent() — Method in class LabelTreeExport

Get the content of the export file. If a string, it is the path to the temporary file containing the content (like a CSV).

LabelTreeExport::getFileName() — Method in class LabelTreeExport

Get the name of the export file.

LabelTreeExport::getAdditionalExports() — Method in class LabelTreeExport

Get additional exports that should be included in the export archive.

PublicLabelExport::getContent() — Method in class PublicLabelExport

Get the content of the export file. If a string, it is the path to the temporary file containing the content (like a CSV).

PublicLabelExport::getFileName() — Method in class PublicLabelExport

Get the name of the export file.

PublicLabelTreeExport::getContent() — Method in class PublicLabelTreeExport

Get the content of the export file. If a string, it is the path to the temporary file containing the content (like a CSV).

PublicLabelTreeExport::getFileName() — Method in class PublicLabelTreeExport

Get the name of the export file.

PublicLabelTreeExport::getAdditionalExports() — Method in class PublicLabelTreeExport

Get additional exports that should be included in the export archive.

UserExport::getContent() — Method in class UserExport

Get the content of the export file. If a string, it is the path to the temporary file containing the content (like a CSV).

UserExport::getFileName() — Method in class UserExport

Get the name of the export file.

VideoAnnotationExport::getContent() — Method in class VideoAnnotationExport

Get the content of the export file. If a string, it is the path to the temporary file containing the content (like a CSV).

VideoAnnotationExport::getFileName() — Method in class VideoAnnotationExport

Get the name of the export file.

VideoAnnotationLabelExport::getContent() — Method in class VideoAnnotationLabelExport

Get the content of the export file. If a string, it is the path to the temporary file containing the content (like a CSV).

VideoAnnotationLabelExport::getFileName() — Method in class VideoAnnotationLabelExport

Get the name of the export file.

VideoExport::getContent() — Method in class VideoExport

Get the content of the export file. If a string, it is the path to the temporary file containing the content (like a CSV).

VideoExport::getFileName() — Method in class VideoExport

Get the name of the export file.

VideoLabelExport::getContent() — Method in class VideoLabelExport

Get the content of the export file. If a string, it is the path to the temporary file containing the content (like a CSV).

VideoLabelExport::getFileName() — Method in class VideoLabelExport

Get the name of the export file.

VolumeExport::getContent() — Method in class VolumeExport

Get the content of the export file. If a string, it is the path to the temporary file containing the content (like a CSV).

VolumeExport::getFileName() — Method in class VolumeExport

Get the name of the export file.

VolumeExport::getAdditionalExports() — Method in class VolumeExport

Get additional exports that should be included in the export archive.

VolumeExport::getLabelTreeIds() — Method in class VolumeExport

Get the label tree IDs that are associated with the volumes of this export.

VolumeExport::getUserIds() — Method in class VolumeExport

Get the user IDs that are associated with the volumes of this export.

ArchiveManager::get() — Method in class ArchiveManager

Get the correct import instance for the import with the given token.

ArchiveManager::generateToken() — Method in class ArchiveManager

Generates a new token for an import.

LabelTreeImport::getImportLabelTrees() — Method in class LabelTreeImport

Get the contents of the label tree import file.

LabelTreeImport::getLabelTreeImportCandidates() — Method in class LabelTreeImport

Get label trees that can be imported and don't already exist.

LabelTreeImport::getLabelImportCandidates() — Method in class LabelTreeImport

Get labels of existing label trees that can be imported.

LabelTreeImport::getUserImportCandidates() — Method in class LabelTreeImport

Get users who might be implicitly imported along with a label tree.

LabelTreeImport::getUserImport() — Method in class LabelTreeImport

Get the user import instance that belongs to this import.

LabelTreeImport::getInsertLabelTrees() — Method in class LabelTreeImport

Get the array that can be used to insert the label trees that should be imported.

LabelTreeImport::getInsertUserIds() — Method in class LabelTreeImport

Get IDs of label tree admins that should be imported.

LabelTreeImport::getInsertLabels() — Method in class LabelTreeImport

Get the array that can be used to insert the labels that should be imported.

PublicLabelTreeImport::getImportLabelTree() — Method in class PublicLabelTreeImport

Get the contents of the label tree import file.

UserImport::getImportUsers() — Method in class UserImport

Get the contents of the user import file.

UserImport::getUserImportCandidates() — Method in class UserImport

Get users that can be imported.

UserImport::getConflicts() — Method in class UserImport

Get import users whose email address matches with an existing user but the UUID doesn't.

VolumeImport::getImportVolumes() — Method in class VolumeImport

Get the contents of the volume import file.

VolumeImport::getImportLabelTrees() — Method in class VolumeImport

Get the contents of the label tree import file.

VolumeImport::getVolumeImportCandidates() — Method in class VolumeImport

Get all volumes of this import augmented by the IDs of the users, label trees and labels that they require.

VolumeImport::getLabelTreeImportCandidates() — Method in class VolumeImport

Get all label trees that might have to be imported for the volumes.

VolumeImport::getLabelImportCandidates() — Method in class VolumeImport

Get all labels that might have to be imported for the volumes.

VolumeImport::getUserImportCandidates() — Method in class VolumeImport

Get the users who might have to be imported for the volumes.

VolumeImport::getUserImport() — Method in class VolumeImport

Get the user import instance that belongs to this import.

VolumeImport::getLabelTreeImport() — Method in class VolumeImport

Get the label tree import instance that belongs to this import.

VolumeImport::getCsvIdMap() — Method in class VolumeImport

Get a map of one CSV ID column to another.

VolumeImport::getRequiredEntities() — Method in class VolumeImport

Get the list of labels and users that whould need to be imported for each volume.

StoreUserDisk::getTypeValidationRules() — Method in class StoreUserDisk

Get additional validation rules for a storage disk type.

StoreUserDisk::getDiskOptions() — Method in class StoreUserDisk

Get the storage disk options from the input of this request.

UpdateUserDisk::getTypeValidationRules() — Method in class UpdateUserDisk

Get additional validation rules for a storage disk type.

UpdateUserDisk::getDiskOptions() — Method in class UpdateUserDisk

Get the storage disk options from the input of this request.

UserDisk::getConfigTemplate() — Method in class UserDisk

Return the storage disk config template associated with the disk type,

UserDisk::getStoreValidationRules() — Method in class UserDisk

Return the validation rules to create a disk with a specific type.

UserDisk::getUpdateValidationRules() — Method in class UserDisk

Return the validation rules to update a disk with a specific type.

UserDisk::getConfig() — Method in class UserDisk

Get the filesystem disk configuration array of this user disk.

StoreStorageRequestFile::getFilePath() — Method in class StoreStorageRequestFile

Get the full path where the file should be stored.

StorageRequest::getCreatedAtForHumansAttribute() — Method in class StorageRequest

Get the created_at_for_humans attribute

StorageRequest::getExpiresAtForHumansAttribute() — Method in class StorageRequest

Get the expires_at_for_humans attribute

StorageRequest::getFilesCountAttribute() — Method in class StorageRequest

Get the files_count attribute

StorageRequest::getSizeAttribute() — Method in class StorageRequest

Get the size attribute

StorageRequest::getPendingPath() — Method in class StorageRequest

Get the path to the directory or file of this request in the pending storage disk.

StorageRequest::getStoragePath() — Method in class StorageRequest

Get the path to the directory or file of this request in the storage disk.

User::getStorageQuotaAvailableAttribute() — Method in class User

Get the available storage quota of the user in bytes.

User::getStorageQuotaUsedAttribute() — Method in class User

Get the used storage quota of the user in bytes.

User::getStorageQuotaRemainingAttribute() — Method in class User

Get the remaining storage quota of the user in bytes.

RegistrationConfirmation::getDuplicateUsers() — Method in class RegistrationConfirmation

Determine possible duplicate users.

AnnotationPolicy::getFileModelTableName() — Method in class AnnotationPolicy

Get the file model table name of the annotation.

ProjectPolicy::getBaseQuery() — Method in class ProjectPolicy

Get the base query for all policy methods.

VolumePolicy::getBaseQuery() — Method in class VolumePolicy

Get the base query for all policy methods.

Project::guests() — Method in class Project

All members of this project with the guest role.

Project::getThumbnailUrlAttribute() — Method in class Project

URL to a unique thumbnail image for this project.

ProjectInvitation::getExpiresAtForHumansAttribute() — Method in class ProjectInvitation

The expires_at_for_humans.

CheckQueues::getLastReportCacheKey() — Method in class CheckQueues

Get the cache key for the stored time of the last notification for a queue and connection.

CheckQueues::getFirstAlertCacheKey() — Method in class CheckQueues

Get the cache key for the stored time of the first alert registered for a queue and connection.

Role::guest() — Method in class Role
Role::guestId() — Method in class Role
GreaterThanClass in namespace Biigle\Rules
ApiGuard::getTokenForRequest() — Method in class ApiGuard

Get the token for the current request.

WormsAdapter::getSoapClient() — Method in class WormsAdapter

Get the SOAP client instance to use for requests.

Annotation::getInsertData() — Method in class Annotation

Get the array of metadata that can be used for Model::insert();

CsvParser::getKnownMimeTypes() — Method in class CsvParser

Get the MIME types that files known by this parser can have.

CsvParser::getName() — Method in class CsvParser

Get the name of the parser to show it to users selecting files.

CsvParser::getMetadata() — Method in class CsvParser

Get a filled VolumeMetadata object based on the file.

CsvParser::getCsvIterator() — Method in class CsvParser
CsvParser::getKeyMap() — Method in class CsvParser
FileMetadata::getInsertData() — Method in class FileMetadata

Get the array of metadata that can be used for Model::insert();

FileMetadata::getAnnotations() — Method in class FileMetadata
FileMetadata::getFileLabels() — Method in class FileMetadata
FileMetadata::getFileLabelLabels() — Method in class FileMetadata
FileMetadata::getAnnotationLabels() — Method in class FileMetadata
FileMetadata::getUsers() — Method in class FileMetadata
FileMetadata::getAnnotationLabelAndUsers() — Method in class FileMetadata
FileMetadata::getFileLabelLabelAndUsers() — Method in class FileMetadata
ImageAnnotation::getInsertData() — Method in class ImageAnnotation

Get the array of metadata that can be used for Model::insert();

ImageCsvParser::getMetadata() — Method in class ImageCsvParser

Get a filled VolumeMetadata object based on the file.

ImageMetadata::getInsertData() — Method in class ImageMetadata

Get the array of metadata that can be used for Model::insert();

MetadataParser::getKnownMimeTypes() — Method in class MetadataParser

Get the MIME types that files known by this parser can have.

MetadataParser::getName() — Method in class MetadataParser

Get the name of the parser to show it to users selecting files.

MetadataParser::getMetadata() — Method in class MetadataParser

Get a filled VolumeMetadata object based on the file.

MetadataParser::getFileObject() — Method in class MetadataParser
VideoAnnotation::getInsertData() — Method in class VideoAnnotation

Get the array of metadata that can be used for Model::insert();

VideoCsvParser::getMetadata() — Method in class VideoCsvParser

Get a filled VolumeMetadata object based on the file.

VideoMetadata::getFrames() — Method in class VideoMetadata
VideoMetadata::getInsertData() — Method in class VideoMetadata

Get the array of metadata that can be used for Model::insert();

VideoMetadata::getInsertDataPlain() — Method in class VideoMetadata

Get the metadata insert array if no frames are present.

VideoMetadata::getInsertDataFrames() — Method in class VideoMetadata

Get the metadata insert array from all frames, sorted by taken_at.

VolumeMetadata::getFiles() — Method in class VolumeMetadata
VolumeMetadata::getFile() — Method in class VolumeMetadata
VolumeMetadata::getAnnotationLabels() — Method in class VolumeMetadata

The returned array is indexed by label IDs.

VolumeMetadata::getFileLabels() — Method in class VolumeMetadata

The returned array is indexed by label IDs.

VolumeMetadata::getUsers() — Method in class VolumeMetadata

Get all users associated with annotations and/or file labels.

VolumeMetadata::getMatchingUsers() — Method in class VolumeMetadata
VolumeMetadata::getMatchingLabels() — Method in class VolumeMetadata
Modules::getViewMixins() — Method in class Modules

Returns all mixins for a view that were registered by modules.

Modules::getMixins() — Method in class Modules
Modules::getControllerMixins() — Method in class Modules

Returns all mixins for a controller that were registered by modules.

Modules::getInstalledModules() — Method in class Modules

Returns information about all installed BIIGLE modules

Modules::getApidocPaths() — Method in class Modules

Get the registered apidoc paths of the modules.

FilesystemManager::getConfig() — Method in class FilesystemManager
{@inheritdoc}
HasJsonAttributes::getJsonAttr() — Method in class HasJsonAttributes

Get a dynamic JSON attribute.

HasMetadataFile::getMetadata() — Method in class HasMetadataFile
User::getIsGlobalAdminAttribute() — Method in class User

Determines if the user has the global admin role.

User::getSettings() — Method in class User

Get settings of a specific key.

User::getSettingsAttribute() — Method in class User

Get the settings array.

User::getIsInSuperUserModeAttribute() — Method in class User

Determines if the user is currently in Super User Mode.

User::getCanReviewAttribute() — Method in class User

Determines if the user can review e.g. new user registrations (without being super user).

Video::getThumbnailAttribute() — Method in class Video

Thumbnail string of this video. Use with the thumbnail_url helper function.

Video::getThumbnailUrlAttribute() — Method in class Video

URL to the thumbnail of this video.

Video::getThumbnailsAttribute() — Method in class Video

Thumbnails array of this video. Use with the thumbnail_url helper function.

Video::getThumbnailsUrlAttribute() — Method in class Video

URLs to the thumbnails of this video.

Video::getErrorAttribute() — Method in class Video

Get the error attribute.

Video::getTakenAtAttribute() — Method in class Video

Get the taken_at timestamps.

VideoAnnotation::getFileIdAttribute() — Method in class VideoAnnotation

Get the file_id attribute

VideoAnnotation::getInterpolationPoints() — Method in class VideoAnnotation

Get the points of this annotation prepared for interpolation.

VideoLabel::getFileIdAttribute() — Method in class VideoLabel

Get the file ID attribute.

Volume::getActiveAnnotationSession() — Method in class Volume

Returns the active annotation session of this volume for the given user.

Volume::getThumbnailAttribute() — Method in class Volume

An image that can be used as unique thumbnail for this volume.

Volume::getThumbnailUrlAttribute() — Method in class Volume

URL to the thumbnail image of this volume.

Volume::getThumbnailsAttribute() — Method in class Volume

Several images or videos that can be used for the preview thumbnail of a volume.

Volume::getThumbnailsUrlAttribute() — Method in class Volume

URLs to the thumbnail images of this volume.

Volume::getCreatingAsyncAttribute() — Method in class Volume

Get the creating_async attribute of this volume.

Volume::getThumbnailsCacheKey() — Method in class Volume

Get the cache key for volume thumbnails.

Volume::getGeoInfoCacheKey() — Method in class Volume

Get the cache key for volume geo info.

VolumeFile::getUrlAttribute() — Method in class VolumeFile

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

VolumeFile::getUrl() — Method in class VolumeFile

Get the file URL.

VolumeFile::getMetadataAttribute() — Method in class VolumeFile

Get the metadata attribute.

VolumeFile::getWidthAttribute() — Method in class VolumeFile

Get the width attribute.

VolumeFile::getHeightAttribute() — Method in class VolumeFile

Get the height attribute.

VolumeFile::getSizeAttribute() — Method in class VolumeFile

Get the size attribute.

VolumeFile::getMimeTypeAttribute() — Method in class VolumeFile

Get the mimeType attribute.

VolumeFile::getThumbnailUrlAttribute() — Method in class VolumeFile

URL to the thumbnail of this file.

VolumeFileLabel::getFileIdAttribute() — Method in class VolumeFileLabel

Get the file ID attribute.

H

$ Annotation#hiddenProperty in class Annotation

The attributes excluded from the model's JSON form.

$ ApiToken#hiddenProperty in class ApiToken

The attributes excluded from the model's JSON form.

Apidoc::handle() — Method in class Apidoc

Handle the command.

MigrateTiledImages::handle() — Method in class MigrateTiledImages

Handle the command.

NewUser::handle() — Method in class NewUser

Handle the command.

PruneNotifications::handle() — Method in class PruneNotifications

Execute the console command.

UpdateVideoMetadata::handle() — Method in class UpdateVideoMetadata

Handle the command.

UpdateVolumeUrls::handle() — Method in class UpdateVolumeUrls

Handle the command.

HandlerClass in namespace Biigle\Exceptions
$ FederatedSearchInstance#hiddenProperty in class FederatedSearchInstance

The attributes excluded from the model's JSON form.

PruneFileCache::handle() — Method in class PruneFileCache

Execute the console command.

ClearFileCache::handle() — Method in class ClearFileCache

Handle the event.

HeartbeatControllerClass in namespace Biigle\Http\Controllers\Views
RedirectIfAuthenticated::handle() — Method in class RedirectIfAuthenticated

Handle an incoming request.

SessionOnly::handle() — Method in class SessionOnly

Handle an incoming request.

TrustHosts::hosts() — Method in class TrustHosts

Get the host patterns that should be trusted.

$ TrustProxies#headersProperty in class TrustProxies

The headers that should be used to detect proxies.

UpdateUserActivity::handle() — Method in class UpdateUserActivity

Handle an outgoing response.

$ Image#hiddenProperty in class Image

The attributes hidden in the model's JSON form.

$ ImageAnnotationLabel#hiddenProperty in class ImageAnnotationLabel

The attributes excluded from the model's JSON form.

CloneImagesOrVideos::handle() — Method in class CloneImagesOrVideos
CreateNewImagesOrVideos::handle() — Method in class CreateNewImagesOrVideos

Execute the job.

DeleteVolume::handle() — Method in class DeleteVolume

Execute the job.

GenerateFederatedSearchIndex::handle() — Method in class GenerateFederatedSearchIndex

Execute the job.

ImportVolumeMetadata::handle() — Method in class ImportVolumeMetadata
MigrateTiledImage::handle() — Method in class MigrateTiledImage

Execute the job.

$ ProcessNewImage#heightProperty in class ProcessNewImage

The desired thumbnail height.

ProcessNewImage::handle() — Method in class ProcessNewImage

Execute the job.

ProcessNewImage::hasTakenAtInfo() — Method in class ProcessNewImage

Check if an exif array contains a creation date.

ProcessNewImage::hasGpsInfo() — Method in class ProcessNewImage

Check if an exif array contains GPS information.

ProcessNewImage::hasExtendedGpsInfo() — Method in class ProcessNewImage

Check if an exif array contains even more GPS information.

ProcessNewImage::hasGpsImgDirInfo() — Method in class ProcessNewImage

Check if an exif array contains GPSImgDirection information.

ProcessNewImage::hasSubjectAreaInfo() — Method in class ProcessNewImage

Check if an exif array contains SubjectArea information.

ProcessNewVideo::handle() — Method in class ProcessNewVideo

Execute the job.

ProcessNewVideo::handleFile() — Method in class ProcessNewVideo

Process a cached video file.

ProcessNewVolumeFiles::handle() — Method in class ProcessNewVolumeFiles

Execute the job.

TileSingleImage::handle() — Method in class TileSingleImage

Execute the job.

TrackObject::handle() — Method in class TrackObject

Execute the job.

UpdateFederatedSearchIndex::handle() — Method in class UpdateFederatedSearchIndex

Execute the job.

UpdateVolumeMetadata::handle() — Method in class UpdateVolumeMetadata
$ Label#hiddenProperty in class Label

The attributes hidden from the model's JSON form.

$ LabelTree#hiddenProperty in class LabelTree

The attributes hidden from the model's JSON form.

CleanupImageThumbnails::handle() — Method in class CleanupImageThumbnails

Handle the event.

CleanupImageTiles::handle() — Method in class CleanupImageTiles

Handle the event.

CleanupVideoThumbnails::handle() — Method in class CleanupVideoThumbnails

Handle the event.

Publish::handle() — Method in class Publish

Execute the command.

Publish::handle() — Method in class Publish

Execute the command.

ComputeNewSequence::handle() — Method in class ComputeNewSequence

Execute the job.

ImagesCreatedListener::handle() — Method in class ImagesCreatedListener

Handle the event.

Config::handle() — Method in class Config

Execute the command.

Publish::handle() — Method in class Publish

Execute the command.

CountUniqueUser::handle() — Method in class CountUniqueUser

Execute the command.

CountUser::handle() — Method in class CountUser

Execute the command.

DetermineStorageUsage::handle() — Method in class DetermineStorageUsage

Execute the command.

EnsureTokenIsValid::handle() — Method in class EnsureTokenIsValid

Handle an incoming request.

Config::handle() — Method in class Config

Execute the command.

GenerateMissing::handle() — Method in class GenerateMissing

Execute the command.

GenerateMissing::handleImageAnnotations() — Method in class GenerateMissing

Check image annnotation patches

GenerateMissing::handleVideoAnnotations() — Method in class GenerateMissing

Check video annnotation patches

GenerateMissing::handleAnnotations() — Method in class GenerateMissing
InitializeFeatureVectors::handle() — Method in class InitializeFeatureVectors

Execute the command.

MigratePatchStorage::handle() — Method in class MigratePatchStorage

Execute the command.

Publish::handle() — Method in class Publish

Execute the command.

ApplyLargoSession::handle() — Method in class ApplyLargoSession

Execute the job.

ApplyLargoSession::handleImageAnnotations() — Method in class ApplyLargoSession

Process the image annotations.

ApplyLargoSession::handleVideoAnnotations() — Method in class ApplyLargoSession

Process the video annotations.

CopyAnnotationFeatureVector::handle() — Method in class CopyAnnotationFeatureVector

Execute the job.

InitializeFeatureVectorChunk::handle() — Method in class InitializeFeatureVectorChunk
ProcessAnnotatedFile::handle() — Method in class ProcessAnnotatedFile

Execute the job.

ProcessAnnotatedFile::handleFile() — Method in class ProcessAnnotatedFile

Handle a single file.

ProcessAnnotatedImage::handleFile() — Method in class ProcessAnnotatedImage

Handle a single file.

ProcessAnnotatedVideo::handleFile() — Method in class ProcessAnnotatedVideo

Handle a single file.

RemoveAnnotationPatches::handle() — Method in class RemoveAnnotationPatches

Execute the job.

AttachLabelListener::handle() — Method in class AttachLabelListener
ImagesCleanupListener::handle() — Method in class ImagesCleanupListener

Handle the event.

VideosCleanupListener::handle() — Method in class VideosCleanupListener

Handle the event.

VolumeClonedListener::handle() — Method in class VolumeClonedListener
Config::handle() — Method in class Config

Execute the command.

Publish::handle() — Method in class Publish

Execute the command.

Job::handle() — Method in class Job

Execute the job.

ProcessDelphiJob::handle() — Method in class ProcessDelphiJob

Execute the job.

ProcessImageDelphiJob::handle() — Method in class ProcessImageDelphiJob

Execute the job.

ProcessImageManualJob::handle() — Method in class ProcessImageManualJob

Execute the job.

ProcessManualJob::handle() — Method in class ProcessManualJob

Execute the job.

ProcessVolumeDelphiJob::handle() — Method in class ProcessVolumeDelphiJob

Execute the job.

Volume::hasDetectedLaserpoints() — Method in class Volume

Determines whether there are images with automatically detected laser points in this volume.

PruneOldEmbeddings::handle() — Method in class PruneOldEmbeddings

Execute the command.

GenerateEmbedding::handle() — Method in class GenerateEmbedding

Handle the job.

MigratePatchStorage::handle() — Method in class MigratePatchStorage

Execute the command.

Publish::handle() — Method in class Publish

Execute the command.

StoreMaiaJob::hasNoExistingAnnotations() — Method in class StoreMaiaJob

Determine if there are existing annotations that can be used as training data.

StoreMaiaJob::hasNoKnowledgeTransferAnnotations() — Method in class StoreMaiaJob

Determine if there are existing annotations in the volume chosen for knowledge transfer.

StoreMaiaJob::hasSmallImages() — Method in class StoreMaiaJob

Determine whether the volume contains images smaller than 512px.

ConvertAnnotationCandidates::handle() — Method in class ConvertAnnotationCandidates

Handle the job.

DeleteAnnotationPatchChunk::handle() — Method in class DeleteAnnotationPatchChunk

Handle the event.

DeleteAnnotationPatches::handle() — Method in class DeleteAnnotationPatches

Handle the event.

GenerateAnnotationCandidatePatches::handle() — Method in class GenerateAnnotationCandidatePatches
GenerateAnnotationFeatureVectors::handle() — Method in class GenerateAnnotationFeatureVectors

Handle the job.

GenerateTrainingProposalPatches::handle() — Method in class GenerateTrainingProposalPatches
JobFailure::handle() — Method in class JobFailure

Execute the job

NotifyNoveltyDetectionComplete::handle() — Method in class NotifyNoveltyDetectionComplete

Handle the job.

NotifyObjectDetectionComplete::handle() — Method in class NotifyObjectDetectionComplete

Handle the job.

NoveltyDetection::handle() — Method in class NoveltyDetection

Execute the job

ObjectDetection::handle() — Method in class ObjectDetection

Execute the job

PrepareAnnotationsJob::hasAnnotations() — Method in class PrepareAnnotationsJob

Determine if there are any annotations to convert.

PrepareExistingAnnotations::handle() — Method in class PrepareExistingAnnotations

Execute the job.

PrepareKnowledgeTransfer::handle() — Method in class PrepareKnowledgeTransfer

Execute the job.

DispatchMaiaJob::handle() — Method in class DispatchMaiaJob

Handle the event.

DispatchObjectDetection::handle() — Method in class DispatchObjectDetection

Handle the event.

PrepareDeleteAnnotationPatches::handle() — Method in class PrepareDeleteAnnotationPatches

Handle the event.

PruneTrainingProposalFeatureVectors::handle() — Method in class PruneTrainingProposalFeatureVectors

Handle the event.

PruneTrainingProposalPatches::handle() — Method in class PruneTrainingProposalPatches

Handle the event.

MaiaJob::hasFailed() — Method in class MaiaJob

Determine if the job failed during novelty detection or object detection.

PruneStaleSubscribers::handle() — Method in class PruneStaleSubscribers

Execute the command.

Publish::handle() — Method in class Publish

Execute the command.

GenerateReportJob::handle() — Method in class GenerateReportJob

Execute the job.

$ File#handleProperty in class File

File handle.

IfdoReportGenerator::hasIfdo() — Method in class IfdoReportGenerator

Determine if the volume has a iFDO metadata file.

Prune::handle() — Method in class Prune

Execute the command.

Publish::handle() — Method in class Publish

Execute the command.

Uuids::handle() — Method in class Uuids

Execute the command.

Uuids::handleSync() — Method in class Uuids

Read the input file and perform interactive synchronization of user UUIDs.

ImportAdminController::hideUserCredentials() — Method in class ImportAdminController

Hides sensitive user credentials that should not be returned to the frontend.

PostprocessVolumeImport::handle() — Method in class PostprocessVolumeImport

Execute the job.

ArchiveManager::has() — Method in class ArchiveManager

Determine if the files of an import with tthe given token exist.

CheckExpiredUserDisks::handle() — Method in class CheckExpiredUserDisks

Execute the command.

PruneExpiredUserDisks::handle() — Method in class PruneExpiredUserDisks

Execute the command.

CheckExpiredStorageRequests::handle() — Method in class CheckExpiredStorageRequests

Execute the command.

PruneExpiredStorageRequests::handle() — Method in class PruneExpiredStorageRequests

Execute the command.

PruneStaleStorageRequests::handle() — Method in class PruneStaleStorageRequests

Execute the command.

ApproveStorageRequest::handle() — Method in class ApproveStorageRequest

Execute the job.

AssembleChunkedFile::handle() — Method in class AssembleChunkedFile

Execute the job.

DeleteStorageRequestDirectory::handle() — Method in class DeleteStorageRequestDirectory

Execute the job.

DeleteStorageRequestFile::handle() — Method in class DeleteStorageRequestFile

Execute the job.

$ StorageRequestFile#hiddenProperty in class StorageRequestFile

The attributes that should be hidden for arrays.

$ PendingVolume#hiddenProperty in class PendingVolume

The attributes that should be hidden for arrays.

$ Project#hiddenProperty in class Project

The attributes hidden from the model's JSON form.

Project::hasGeoInfo() — Method in class Project

Check if the project has volumes which have some images with GPS coordinates.

HandleClass in namespace Biigle\Rules
FileMetadata::hasAnnotations() — Method in class FileMetadata
FileMetadata::hasFileLabels() — Method in class FileMetadata
ParserFactory::has() — Method in class ParserFactory

Check if the metadata parser exists for the given type.

VolumeMetadata::hasAnnotations() — Method in class VolumeMetadata
VolumeMetadata::hasFileLabels() — Method in class VolumeMetadata
HasConstantInstancesClass in namespace Biigle\Traits

Some models have fixed, "constant" instances. An example is the Role model, which may have e.g. the roles "admin" and "user". These are always the same and do not change.

HasJsonAttributesClass in namespace Biigle\Traits
HasMetadataFileClass in namespace Biigle\Traits
HasMetadataFile::hasMetadata() — Method in class HasMetadataFile
HasPointsAttributeClass in namespace Biigle\Traits
$ User#hiddenProperty in class User

The attributes hidden from the model's JSON form.

$ Video#hiddenProperty in class Video

The attributes hidden from the model's JSON form.

Video::hasBeenProcessed() — Method in class Video

Determine whether the (new) video has been processed.

$ Volume#hiddenProperty in class Volume

The attributes hidden from the model's JSON form.

Volume::hasConflictingAnnotationSession() — Method in class Volume

Check if the given annotation session is in conflict with existing ones.

Volume::hasGeoInfo() — Method in class Volume

Check if the volume has some images with GPS coordinates.

Volume::hasTiledImages() — Method in class Volume

Check if the there are tiled images in this volume.

I

$ Annotation#idProperty in class Annotation
$ AnnotationLabel#idProperty in class AnnotationLabel
AnnotationSession::imageAnnotations() — Method in class AnnotationSession

Get a query for all image annotations that belong to this session.

ImagesDeletedClass in namespace Biigle\Events
FederatedSearchModel::instance() — Method in class FederatedSearchModel

The instance, this model belongs to.

FileCache::isRemote() — Method in class FileCache

Determine if an file is remote, i.e. served by a public webserver.

AnnotationController::index() — Method in class AnnotationController

List the IDs of files having one or more annotations.

AnnotationUserController::index() — Method in class AnnotationUserController

List the IDs of images having one or more annotations of the specified user.

VolumeAnnotationLabelController::index() — Method in class VolumeAnnotationLabelController

Get all annotation labels that were used in a volume.

VolumeImageAreaController::index() — Method in class VolumeImageAreaController

Get the area of the images of a volume in m².

ApiTokenController::index() — Method in class ApiTokenController

Shows a list of all API tokens belonging to the authenticated user.

FederatedSearchIndexController::index() — Method in class FederatedSearchIndexController

Show the federated search index.

ImageAnnotationBulkControllerClass in namespace Biigle\Http\Controllers\Api
ImageAnnotationControllerClass in namespace Biigle\Http\Controllers\Api
ImageAnnotationController::index() — Method in class ImageAnnotationController

Shows a list of all annotations of the specified image.

ImageAnnotationLabelControllerClass in namespace Biigle\Http\Controllers\Api
ImageAnnotationLabelController::index() — Method in class ImageAnnotationLabelController

Shows all labels of the specified annotation.

ImageControllerClass in namespace Biigle\Http\Controllers\Api
ImageLabelControllerClass in namespace Biigle\Http\Controllers\Api
LabelTreeController::index() — Method in class LabelTreeController

Shows all label trees the user has access to.

MediaTypeController::index() — Method in class MediaTypeController

Shows all media types.

ProjectController::index() — Method in class ProjectController

Shows all projects that are accessible by the requesting user.

ProjectLabelTreeController::index() — Method in class ProjectLabelTreeController

Display all label trees used by the specified project.

ProjectUserController::index() — Method in class ProjectUserController

Displays the users belonging to the specified project.

ProjectVolumeController::index() — Method in class ProjectVolumeController

Shows a list of all volumes belonging to the specified project.

ProjectsAttachableVolumesController::index() — Method in class ProjectsAttachableVolumesController

Shows all volumes that can be attached to the project by the requesting user.

RoleController::index() — Method in class RoleController

Shows all roles.

ShapeController::index() — Method in class ShapeController

Shows all shapes.

UserController::index() — Method in class UserController

Shows a list of all users.

UserPinnedProjectController::index() — Method in class UserPinnedProjectController

Shows all pinned projects of the user.

UserRegistrationController::isAdminConfirmationEnabled() — Method in class UserRegistrationController

Determines if the user registration confirmation by admins is enabled.

VideoAnnotationController::index() — Method in class VideoAnnotationController

Shows a list of all annotations of the specified video.

VisibilityController::index() — Method in class VisibilityController

Shows all visibilities.

VolumeAnnotationSessionController::index() — Method in class VolumeAnnotationSessionController

Shows a list of all annotation sessions of the specified volume.

VolumeController::index() — Method in class VolumeController

Shows all volumes the user has access to.

VolumeFileController::index() — Method in class VolumeFileController

List the image/video IDs of the specified volume.

VolumeFileLabelController::index() — Method in class VolumeFileLabelController

Shows all labels of the specified file.

BrowserController::indexDirectories() — Method in class BrowserController

List directories in a storage disk.

BrowserController::indexImages() — Method in class BrowserController

List images in a storage disk.

BrowserController::indexVideos() — Method in class BrowserController

List videos in a storage disk.

BrowserController::indexFiles() — Method in class BrowserController

List files filtered by a regex in a storage disk.

FileLabelsController::index() — Method in class FileLabelsController

Get the labels for each image/video

FilenamesController::index() — Method in class FilenamesController

Get all filenames of a volume.

AnnotationLabelController::index() — Method in class AnnotationLabelController

List the IDs of files having one or more annotations with the specified label.

AnyFileLabelController::index() — Method in class AnyFileLabelController

List the IDs of images/videos having one or more labels attached.

FileLabelController::index() — Method in class FileLabelController

List the IDs of images/videos having the specified label attached.

FileLabelUserController::index() — Method in class FileLabelUserController

List the IDs of images/videos having one or more labels attached by the specified user.

FilenameController::index() — Method in class FilenameController

List the IDs of files with a filename matching the given pattern.

StatisticsController::index() — Method in class StatisticsController

Provides the statistics-data for a specific Volume.

UsedFileLabelsController::index() — Method in class UsedFileLabelsController

Get all file labels that were used in a volume.

UserController::index() — Method in class UserController

List the users of a volume.

RegisterController::isRegistrationDisabled() — Method in class RegisterController

Determines if the user registration mechansim is disabled.

RegisterController::isAdminConfirmationEnabled() — Method in class RegisterController

Determines if the user registration confirmation by admins is enabled.

Controller::isAutomatedRequest() — Method in class Controller

Determines if the request was done by an automated script (with API token or ajax).

AnnouncementsController::index() — Method in class AnnouncementsController

Shows the admin announcements page.

FederatedSearchController::index() — Method in class FederatedSearchController

Show the federated search admin page.

IndexControllerClass in namespace Biigle\Http\Controllers\Views\Admin
LabelTreesController::index() — Method in class LabelTreesController

Show the label tree admin page.

LogsController::index() — Method in class LogsController

Shows the available logfiles.

ImageAnnotationControllerClass in namespace Biigle\Http\Controllers\Views\Annotations
DashboardController::index() — Method in class DashboardController

Show the application dashboard to the user.

DashboardController::indexDashboard() — Method in class DashboardController

Show the dashboard for a logged in user.

DashboardController::indexLandingPage() — Method in class DashboardController

Show the landing page if no user is authenticated.

ImprintControllerClass in namespace Biigle\Http\Controllers\Views
LabelTreeMergeController::index() — Method in class LabelTreeMergeController

Show the label tree merge index page.

LabelTreesController::index() — Method in class LabelTreesController

Show the label tree list.

ManualController::index() — Method in class ManualController

Show the application manual to the user.

NotificationsController::index() — Method in class NotificationsController

Shows the notification center.

ProjectsController::index() — Method in class ProjectsController

Shows the project index page.

SearchController::index() — Method in class SearchController

Shows the search page.

SettingsController::index() — Method in class SettingsController

Redirects to the profile settings.

ImageControllerClass in namespace Biigle\Http\Controllers\Views\Volumes
ImageController::index() — Method in class ImageController

Shows the image index page.

VolumeController::index() — Method in class VolumeController

Shows the volume index page.

UpdateUserActivity::inExceptArray() — Method in class UpdateUserActivity

Determine if the request has a URI that should not update the user activity.

$ StoreImageAnnotation#imageProperty in class StoreImageAnnotation

The image on which the annotation should be created.

$ StoreImageAnnotations#imageIdsProperty in class StoreImageAnnotations

Unique image IDs of this request.

$ StoreImageAnnotations#imagesProperty in class StoreImageAnnotations

The images on which the annotations should be created.

$ StoreLabelTreeUser#isGlobalGuestProperty in class StoreLabelTreeUser

Determines whether the user to be attached is a global guest.

$ UpdateFederatedSearchInstance#instanceProperty in class UpdateFederatedSearchInstance

The instance that should be updated.

$ UpdateLabelTreeUser#isGlobalGuestProperty in class UpdateLabelTreeUser

Determines whether the user to be attached is a global guest.

IfdoClass in namespace Biigle\Ifdo
Ifdo::isValid() — Method in class Ifdo
ImageClass in namespace Biigle

This model stores information on an image file in the file system.

ImageAnnotationClass in namespace Biigle

An image annotation is a region of an image that can be labeled by the users.

ImageAnnotation::image() — Method in class ImageAnnotation

The image, this annotation belongs to.

ImageAnnotationLabelClass in namespace Biigle

Pivot object for the connection between ImageAnnotation and Label.

ImageLabelClass in namespace Biigle
ImageLabel::image() — Method in class ImageLabel

The image, this image label belongs to.

ImportVolumeMetadataClass in namespace Biigle\Jobs
$ ImportVolumeMetadata#insertChunkSizeProperty in class ImportVolumeMetadata

The number of annotation (label) rows to insert in one chunk.

ImportVolumeMetadata::insertAnnotations() — Method in class ImportVolumeMetadata

Insert metadata annotations of a file into the database.

ImportVolumeMetadata::insertAnnotationChunk() — Method in class ImportVolumeMetadata
ImportVolumeMetadata::insertFileLabels() — Method in class ImportVolumeMetadata

Insert metadata file labels of a file into the database.

$ ProcessNewImage#imageProperty in class ProcessNewImage

The image to process

$ TileSingleImage#imageProperty in class TileSingleImage

The image to generate tiles for.

$ UpdateFederatedSearchIndex#instanceProperty in class UpdateFederatedSearchIndex

The instance from which the index should be updated.

$ Label#idProperty in class Label
Label::isUsed() — Method in class Label

Determines if the label is used anywhere (e.g. attached to an annotation).

LogManager::isFile() — Method in class LogManager

Determine whether logs are written to files.

LogManager::isRedis() — Method in class LogManager

Determine whether logs are written to files.

MediaType::image() — Method in class MediaType
MediaType::imageId() — Method in class MediaType
ImageControllerClass in namespace Biigle\Modules\Ananas\Http\Controllers\Api
AnnotationAssistanceRequestController::index() — Method in class AnnotationAssistanceRequestController

Show the list of all assistance requests of the user.

StoreAnnotationAssistanceRequest::invalidLabels() — Method in class StoreAnnotationAssistanceRequest

Check if the user attempts to use invalid labels for the request.

$ LsloginId#incrementingProperty in class LsloginId

Indicates if the model's ID is auto-incrementing.

VolumeColorSortSequenceController::index() — Method in class VolumeColorSortSequenceController

List all color sort sequence colors of the specified volume.

ImagesCreatedListenerClass in namespace Biigle\Modules\ColorSort\Listeners
ImageObserverClass in namespace Biigle\Modules\ColorSort\Observers
FileCoordinatesController::index() — Method in class FileCoordinatesController

Get all files of a volume together with coordinate-values.

ProjectImageAnnotationLabelController::index() — Method in class ProjectImageAnnotationLabelController

List the IDs of images of a project having one or more annotations with the specified label.

InitializeFeatureVectorsClass in namespace Biigle\Modules\Largo\Console\Commands
ImageAnnotationLabelFeatureVectorFactoryClass in namespace Biigle\Modules\Largo\Database\Factories
$ LargoSessionFailed#idProperty in class LargoSessionFailed

The ID of the Largo session

$ LargoSessionSaved#idProperty in class LargoSessionSaved

The ID of the Largo session

ImageAnnotationsControllerClass in namespace Biigle\Modules\Largo\Http\Controllers\Api\Labels
ImageAnnotationsController::index() — Method in class ImageAnnotationsController

Show image annotations of a label.

VideoAnnotationsController::index() — Method in class VideoAnnotationsController

Show video annotations of a label.

FilterImageAnnotationsByLabelController::index() — Method in class FilterImageAnnotationsByLabelController

Show all image annotations of the project that have a specific label attached.

FilterVideoAnnotationsByLabelController::index() — Method in class FilterVideoAnnotationsByLabelController

Show all video annotations of the project that have a specific label attached.

SortAnnotationsByOutliersController::index() — Method in class SortAnnotationsByOutliersController

Sort annotations with specific label by outliers.

SortAnnotationsBySimilarityController::index() — Method in class SortAnnotationsBySimilarityController

Sort annotations with specific label by similarity.

FilterImageAnnotationsByLabelController::index() — Method in class FilterImageAnnotationsByLabelController

Show all image annotations of the volume that have a specific label attached.

FilterVideoAnnotationsByLabelController::index() — Method in class FilterVideoAnnotationsByLabelController

Show all video annotations of the volume that have a specific label attached.

ImageAnnotationExamplesControllerClass in namespace Biigle\Modules\Largo\Http\Controllers\Api\Volumes
ImageAnnotationExamplesController::index() — Method in class ImageAnnotationExamplesController

Show example image annotations of a label or of a similar label if no annotation exists.

SortAnnotationsByOutliersController::index() — Method in class SortAnnotationsByOutliersController

Sort annotations with specific label by outliers.

SortAnnotationsBySimilarityController::index() — Method in class SortAnnotationsBySimilarityController

Sort annotations with specific label by similarity.

LargoController::index() — Method in class LargoController

Show the Largo view for a project.

LargoController::index() — Method in class LargoController

Show the the Largo view for a volume.

IndexProjectAnnotationsSimilarityClass in namespace Biigle\Modules\Largo\Http\Requests
IndexVolumeAnnotationsSimilarityClass in namespace Biigle\Modules\Largo\Http\Requests
StoreLargoSession::imageAnotationsBelongToVolumes() — Method in class StoreLargoSession

Check if all given image annotations belong to the given volumes.

ImageAnnotationLabelFeatureVectorClass in namespace Biigle\Modules\Largo
$ ApplyLargoSession#idProperty in class ApplyLargoSession

The job ID.

ApplyLargoSession::ignoreDeletedLabels() — Method in class ApplyLargoSession

Removes changes to annotations that should get a new label which no longer exists.

ApplyLargoSession::ignoreNullChanges() — Method in class ApplyLargoSession

Removes changes to annotations where the same label was dismissed than should be attached again later.

InitializeFeatureVectorChunkClass in namespace Biigle\Modules\Largo\Jobs
ImagesCleanupListenerClass in namespace Biigle\Modules\Largo\Listeners
ImageAnnotationObserverClass in namespace Biigle\Modules\Largo\Observers
ImagesControllerClass in namespace Biigle\Modules\Laserpoints\Http\Controllers\Api
VolumeImageController::index() — Method in class VolumeImageController

List the IDs of images having automatically detected laser points.

$ ComputeImage#imageProperty in class ComputeImage

The image that should be processed with laser point detection.

ImageClass in namespace Biigle\Modules\Laserpoints

Extends the base Biigle image.

$ Image#infoParamsProperty in class Image

Properties of the laser points object.

$ ProcessDelphiJob#imageProperty in class ProcessDelphiJob

The image to process.

$ ProcessImageDelphiJob#imageProperty in class ProcessImageDelphiJob

The image to compute the area for.

$ ProcessImageManualJob#imageProperty in class ProcessImageManualJob

The image to compute the area for.

$ ProcessManualJob#imageProperty in class ProcessManualJob

The image to process.

ImageEmbeddingControllerClass in namespace Biigle\Modules\MagicSam\Http\Controllers
$ GenerateEmbedding#imageProperty in class GenerateEmbedding

The image to generate an embedding of.

$ GenericImage#idProperty in class GenericImage

The image ID.

AnnotationCandidateController::index() — Method in class AnnotationCandidateController

Get all annotation candidates of a MAIA job.

AnnotationCandidateController::indexSimilar() — Method in class AnnotationCandidateController

Get annotation candidates ordered by similarity to a specific proposal.

AreaKnowledgeTransferVolumeController::index() — Method in class AreaKnowledgeTransferVolumeController

List all volumes that can be accessed and used for knowledge transfer (using image area).

KnowledgeTransferVolumeController::index() — Method in class KnowledgeTransferVolumeController

List all volumes that can be accessed and used for knowledge transfer.

MaiaJobImagesController::indexTrainingProposals() — Method in class MaiaJobImagesController

Get training proposal coordinates for an image.

MaiaJobImagesController::indexAnnotationCandidates() — Method in class MaiaJobImagesController

Get annotationcandidate coordinates for an image.

TrainingProposalController::index() — Method in class TrainingProposalController

Get all training proposals of a MAIA job.

TrainingProposalController::indexSimilar() — Method in class TrainingProposalController

Get training proposals ordered by similarity to a specific proposal.

MaiaJobController::index() — Method in class MaiaJobController

Show the overview of MAIA jobs for a volume

DetectionJob::insertAnnotationChunk() — Method in class DetectionJob

Insert one chunk of the MAIA annotations that should be created into the database.

GenerateAnnotationCandidateFeatureVectors::insertFeatureVectorModelChunk() — Method in class GenerateAnnotationCandidateFeatureVectors

Insert a chunk of new feature vector models.

GenerateAnnotationFeatureVectors::insertFeatureVectorModelChunk() — Method in class GenerateAnnotationFeatureVectors

Insert a chunk of new feature vector models.

GenerateTrainingProposalFeatureVectors::insertFeatureVectorModelChunk() — Method in class GenerateTrainingProposalFeatureVectors

Insert a chunk of new feature vector models.

NoveltyDetection::insertAnnotationChunk() — Method in class NoveltyDetection

Insert one chunk of the MAIA annotations that should be created into the database.

ObjectDetection::insertAnnotationChunk() — Method in class ObjectDetection

Insert one chunk of the MAIA annotations that should be created into the database.

MaiaAnnotation::image() — Method in class MaiaAnnotation

The image, this MAIA annotation belongs to.

MaiaJob::isRunning() — Method in class MaiaJob

Determine if the job is currently running novelty detection or object detection.

Converter::ifdoToBiigleAnnotation() — Method in class Converter
Converter::ifdoLabelsToBiigleLabelAndUsers() — Method in class Converter
Converter::ifdoLabelToBiigleLabelAndUser() — Method in class Converter
Converter::ifdoShapeToBiigleShape() — Method in class Converter
Converter::ifdoParseCoordinates() — Method in class Converter
IfdoParserClass in namespace Biigle\Modules\MetadataIfdo
$ IfdoParser#ifdoProperty in class IfdoParser
AdminController::index() — Method in class AdminController

Shows the list of subscribers page.

NewsletterArchiveController::index() — Method in class NewsletterArchiveController

Shows the sign up page.

NewsletterController::index() — Method in class NewsletterController

Shows the sign up page.

SearchControllerMixin::index() — Method in class SearchControllerMixin

Add report results to the search view.

ReportsController::index() — Method in class ReportsController

Show the reports list of the user.

StoreReport::isType() — Method in class StoreReport

Check if the requested reporty type ID is in the supplied array.

StoreReport::isAllowedForExportArea() — Method in class StoreReport

Check if export_area may be configured for the requested report type.

StoreReport::isAllowedForAggregateChildLabels() — Method in class StoreReport

Check if aggregate_child_labels may be configured for the requested report type.

StoreReport::isAllowedForStripIfdo() — Method in class StoreReport

Check if strip_ifdo may be configured for the requested report type.

AnnotationReportGenerator::isRestrictedToExportArea() — Method in class AnnotationReportGenerator

Should this report be restricted to the export area?

ImageLocationReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Projects\ImageAnnotations
ImageIfdoReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Projects
ImageLocationReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Projects\ImageLabels
ProjectReportGenerator::isRestrictedToNewestLabel() — Method in class ProjectReportGenerator

Determines if this report should take only the newest label for each annotation.

CsvReportGenerator::isRestrictedToNewestLabel() — Method in class CsvReportGenerator

Determines if this report should take only the newest label for each annotation.

ReportGenerator::isRestrictedToLabels() — Method in class ReportGenerator

Determines if this report is restricted to a subset of labels.

IfdoReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Volumes
$ IfdoReportGenerator#imageAnnotationLabelsProperty in class IfdoReportGenerator

All labels that should be contained in the iFDO.

$ IfdoReportGenerator#imageAnnotationCreatorsProperty in class IfdoReportGenerator

All users that should be contained in the iFDO.

$ IfdoReportGenerator#imageSetItemsProperty in class IfdoReportGenerator

iFDO image-annotation arrays for each image of the volume.

IfdoReportGenerator::isArrayItem() — Method in class IfdoReportGenerator

Determine if an iFDO item is a single object or an array of objects.

AnnotationReportGenerator::initQuery() — Method in class AnnotationReportGenerator

Assembles the part of the DB query that is the same for all annotation reports.

$ AreaReportGenerator#imagesProperty in class AreaReportGenerator

All images that contain annotations which are included in this report.

ImageLocationReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Volumes\ImageAnnotations
ImageIfdoReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Volumes
ImageLocationReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Volumes\ImageLabels
CsvReportGenerator::initQuery() — Method in class CsvReportGenerator

Assembles the part of the DB query that is the same for all annotation reports.

VolumeReportGenerator::isRestrictedToAnnotationSession() — Method in class VolumeReportGenerator

Should this report be restricted an annotation session?

VolumeReportGenerator::isRestrictedToNewestLabel() — Method in class VolumeReportGenerator

Determines if this report should take only the newest label of each annotation.

RestrictsToExportArea::isRestrictedToExportArea() — Method in class RestrictsToExportArea

Should this report be restricted to the export area?

Controller::isAllowed() — Method in class Controller

Determine if this kind of export is allowed by the config.

LabelTreeExportController::isAllowed() — Method in class LabelTreeExportController

Determine if this kind of export is allowed by the config.

UserExportController::isAllowed() — Method in class UserExportController

Determine if this kind of export is allowed by the config.

VolumeExportController::isAllowed() — Method in class VolumeExportController

Determine if this kind of export is allowed by the config.

ImportControllerClass in namespace Biigle\Modules\Sync\Http\Controllers\Api\Import
ExportAdminController::index() — Method in class ExportAdminController

Shows the export admin page.

ImportAdminControllerClass in namespace Biigle\Modules\Sync\Http\Controllers\Views
ImportAdminController::index() — Method in class ImportAdminController

Shows the import admin page.

PublicLabelTreeImportController::index() — Method in class PublicLabelTreeImportController

Shows the import admin page.

$ PostprocessVolumeImport#idsProperty in class PostprocessVolumeImport

IDs of the imported volumes.

$ Export#idsProperty in class Export

IDs of the models of this export.

ImageAnnotationExportClass in namespace Biigle\Modules\Sync\Support\Export
ImageAnnotationLabelExportClass in namespace Biigle\Modules\Sync\Support\Export
ImageExportClass in namespace Biigle\Modules\Sync\Support\Export
ImageLabelExportClass in namespace Biigle\Modules\Sync\Support\Export
$ ArchiveManager#importTypesProperty in class ArchiveManager

Class names of available imports.

ImportClass in namespace Biigle\Modules\Sync\Support\Import
$ LabelTreeImport#importLabelTreesProperty in class LabelTreeImport

Caches the decoded label tree import file.

LabelTreeImport::insertLabelTrees() — Method in class LabelTreeImport

Insert label trees that should be imported in the database.

LabelTreeImport::insertLabelTreeVersions() — Method in class LabelTreeImport

Create label tree versions for imported versioned label trees.

LabelTreeImport::insertLabels() — Method in class LabelTreeImport

Insert labels that should be imported in the database.

$ PublicLabelTreeImport#importLabelTreeProperty in class PublicLabelTreeImport

Caches the decoded label tree import file.

PublicLabelTreeImport::importLabels() — Method in class PublicLabelTreeImport

Import the labels of this import.

$ UserImport#importUsersProperty in class UserImport

Caches the decoded user import file.

$ VolumeImport#importVolumesProperty in class VolumeImport

Caches the decoded volume import file.

VolumeImport::insertVolumes() — Method in class VolumeImport

Insert import volumes into the database.

VolumeImport::insertUsers() — Method in class VolumeImport

Insert import users into the database.

VolumeImport::insertLabelTreesAndLabels() — Method in class VolumeImport

Insert import label trees and labels into the database.

VolumeImport::insertFiles() — Method in class VolumeImport

Insert import files into the database.

VolumeImport::insertImages() — Method in class VolumeImport

Insert import images into the database.

VolumeImport::insertVideos() — Method in class VolumeImport

Insert import videos into the database.

VolumeImport::insertImageLabels() — Method in class VolumeImport

Insert import image labels into the database.

VolumeImport::insertVideoLabels() — Method in class VolumeImport

Insert import video labels into the database.

VolumeImport::insertImageAnnotations() — Method in class VolumeImport

Insert import image annotations into the database.

VolumeImport::insertVideoAnnotations() — Method in class VolumeImport

Insert import video annotations into the database.

UserDiskController::index() — Method in class UserDiskController

Shows the user disks settings.

UserDisk::isAboutToExpire() — Method in class UserDisk

Check whether the disk is about to expire.

StorageRequestController::index() — Method in class StorageRequestController

Show the view to index storage requests of the user.

StoreStorageRequestFile::isChunked() — Method in class StoreStorageRequestFile

Determine if the file is a chunked upload.

InAppNotificationClass in namespace Biigle\Notifications

A notification that is displayed through the in-app notification system.

ImageObserverClass in namespace Biigle\Observers
UserPolicy::index() — Method in class UserPolicy

Determine if the given user can see other users.

Project::invitations() — Method in class Project

The project invitations of this project.

Project::imageVolumes() — Method in class Project

The image volumes of this project.

ProjectInvitation::isOpen() — Method in class ProjectInvitation

Check if the invitation is still open.

ImageMetadataClass in namespace Biigle\Rules
VolumeUrl::isDeniedProvider() — Method in class VolumeUrl

Determine if the new remote volume URL is from a denied provider.

FileMetadata::isEmpty() — Method in class FileMetadata
ImageAnnotationClass in namespace Biigle\Services\MetadataParsing
ImageCsvParserClass in namespace Biigle\Services\MetadataParsing
ImageMetadataClass in namespace Biigle\Services\MetadataParsing
ImageMetadata::isEmpty() — Method in class ImageMetadata

Determines if any metadata field other than the name is filled.

VideoMetadata::isEmpty() — Method in class VideoMetadata

Determines if any metadata field other than the name is filled.

VolumeMetadata::isEmpty() — Method in class VolumeMetadata

Determine if there is any file metadata.

VideoAnnotation::interpolatePoints() — Method in class VideoAnnotation

Get the interpolated points at a specific point of time.

VideoAnnotation::interpolateBetweenFrames() — Method in class VideoAnnotation

Get the interpolated points of this annotation between the specified frames.

VideoAnnotation::interpolateNaive() — Method in class VideoAnnotation

Interpolate between two points arrays.

VideoAnnotation::interpolationPointsToRectangle() — Method in class VideoAnnotation

Convert points that can be interpolated back to the points of a rectangle (frame).

Volume::images() — Method in class Volume

The images belonging to this volume.

Volume::isRemote() — Method in class Volume

Check if the images of this volume come from a remote URL.

Volume::isImageVolume() — Method in class Volume

Specifies whether the volume is an image volume.

Volume::isVideoVolume() — Method in class Volume

Specifies whether the volume is a video volume.

$ VolumeFile#idProperty in class VolumeFile
$ VolumeFileLabel#idProperty in class VolumeFileLabel
InitializeMaiaTablesClass in namespace [Global Namespace]

J

UserChannel::join() — Method in class UserChannel

Authenticate the user's access to the channel.

ProjectInvitationController::join() — Method in class ProjectInvitationController

Join a project through an invitation.

JoinProjectInvitationClass in namespace Biigle\Http\Requests
$ Ifdo#jsonArrProperty in class Ifdo
JobClass in namespace Biigle\Jobs
JobClass in namespace Biigle\Modules\Laserpoints\Jobs
$ MaiaJobContinued#jobProperty in class MaiaJobContinued

The job that caused this event.

$ MaiaJobCreated#jobProperty in class MaiaJobCreated

The job that caused this event.

$ MaiaJobDeleting#jobProperty in class MaiaJobDeleting

The job that caused this event.

$ ContinueMaiaJob#jobProperty in class ContinueMaiaJob

The job to update

$ DestroyMaiaJob#jobProperty in class DestroyMaiaJob

The job to destroy

$ SubmitAnnotationCandidates#jobProperty in class SubmitAnnotationCandidates

The job to submit candidates of

$ ConvertAnnotationCandidates#jobProperty in class ConvertAnnotationCandidates

The job to convert candidates of.

JobFailureClass in namespace Biigle\Modules\Maia\Jobs

This job is executed on the machine running BIIGLE to store the error state of a failed novelty detection or object detection.

$ JobFailure#jobIdProperty in class JobFailure

ID of the MAIA job.

MaiaAnnotation::job() — Method in class MaiaAnnotation

The MAIA job, this MAIA anotation belongs to.

JobStateChangedClass in namespace Biigle\Modules\Maia\Notifications
$ JobStateChanged#jobProperty in class JobStateChanged

The job which changed state.

Label::jsonSerialize() — Method in class Label
User::jsonSerialize() — Method in class User

K

KernelClass in namespace Biigle\Console
KernelClass in namespace Biigle\Http
$ LsloginId#keyTypeProperty in class LsloginId

The data type of the auto-incrementing ID.

KpiControllerClass in namespace Biigle\Modules\Kpis\Http\Controllers\Views
KpisServiceProviderClass in namespace Biigle\Modules\Kpis
KnowledgeTransferVolumeControllerClass in namespace Biigle\Modules\Maia\Http\Controllers\Api
$ ObjectDetection#knowledgeTransferVolumeUrlProperty in class ObjectDetection

URL of the volume for knowledge transfer (if any).

$ ObjectDetection#knowledgeTransferImagesProperty in class ObjectDetection

Filenames of the images of the knowledge transfer volume, indexed by their IDs.

KnowledgeTransferVolumeClass in namespace Biigle\Modules\Maia\Rules

L

Annotation::labels() — Method in class Annotation

The labels, this annotation got assigned by the users.

$ AnnotationLabel#label_idProperty in class AnnotationLabel
AnnotationLabel::label() — Method in class AnnotationLabel

The label, this annotation label belongs to.

LabelSourceAdapterContractClass in namespace Biigle\Contracts

A label source adapter.

LabelControllerClass in namespace Biigle\Http\Controllers\Api
LabelSourceControllerClass in namespace Biigle\Http\Controllers\Api
LabelTreeAuthorizedProjectControllerClass in namespace Biigle\Http\Controllers\Api
LabelTreeControllerClass in namespace Biigle\Http\Controllers\Api
LabelTreeLabelControllerClass in namespace Biigle\Http\Controllers\Api
LabelTreeMergeControllerClass in namespace Biigle\Http\Controllers\Api
LabelTreeUserControllerClass in namespace Biigle\Http\Controllers\Api
LabelTreeVersionControllerClass in namespace Biigle\Http\Controllers\Api
LinkVideoAnnotationControllerClass in namespace Biigle\Http\Controllers\Api
LoginControllerClass in namespace Biigle\Http\Controllers\Auth
LabelTreesControllerClass in namespace Biigle\Http\Controllers\Views\Admin
LogsControllerClass in namespace Biigle\Http\Controllers\Views\Admin
LabelTreeMembersControllerClass in namespace Biigle\Http\Controllers\Views\LabelTrees
LabelTreeMergeControllerClass in namespace Biigle\Http\Controllers\Views\LabelTrees
LabelTreeProjectsControllerClass in namespace Biigle\Http\Controllers\Views\LabelTrees
LabelTreeVersionsControllerClass in namespace Biigle\Http\Controllers\Views\LabelTrees
LabelTreesControllerClass in namespace Biigle\Http\Controllers\Views\LabelTrees
$ DestroyLabel#labelProperty in class DestroyLabel

The label to destroy.

LinkVideoAnnotationClass in namespace Biigle\Http\Requests
$ StoreImageAnnotationLabel#labelProperty in class StoreImageAnnotationLabel

The label that should be attached.

$ StoreImageAnnotations#labelsProperty in class StoreImageAnnotations

The labels that should be attached to the new annotations.

$ StoreVideoAnnotationLabel#labelProperty in class StoreVideoAnnotationLabel

The label that should be attached.

$ StoreVolumeFileLabel#labelProperty in class StoreVolumeFileLabel

The label that should be attached to the file.

$ UpdateLabel#labelProperty in class UpdateLabel

The label to update.

Image::labels() — Method in class Image

The labels, this image got attached by the users.

ImageAnnotation::labels() — Method in class ImageAnnotation

The labels, this annotation got assigned by the users.

LabelClass in namespace Biigle

Annotations on an image can have multiple labels. A label is e.g. the type of the object visible in the region of the annotation. So if you put a circle annotation around a rock, you would label the annotation with rock.

LabelSourceClass in namespace Biigle

The source (database) of a label.

LabelTreeClass in namespace Biigle

A label tree is a group of labels. Projects can choose to used different label trees, which are then offered for labeling things in the project.

LabelTree::labels() — Method in class LabelTree

The labels that belong to this tree.

LabelTreeVersionClass in namespace Biigle
LabelTreeVersion::labelTree() — Method in class LabelTreeVersion

The "master" label tree of this version.

LogManagerClass in namespace Biigle\Logging
LsloginIdFactoryClass in namespace Biigle\Modules\AuthLSLogin\Database\Factories
LSLoginControllerClass in namespace Biigle\Modules\AuthLSLogin\Http\Controllers
LSLoginServiceProviderClass in namespace Biigle\Modules\AuthLSLogin
LsloginIdClass in namespace Biigle\Modules\AuthLSLogin
LargoSessionFailedClass in namespace Biigle\Modules\Largo\Events
LargoSessionSavedClass in namespace Biigle\Modules\Largo\Events
LargoControllerClass in namespace Biigle\Modules\Largo\Http\Controllers\Api\Projects
LargoControllerClass in namespace Biigle\Modules\Largo\Http\Controllers\Api\Volumes
LargoControllerClass in namespace Biigle\Modules\Largo\Http\Controllers\Views\Projects
LargoControllerClass in namespace Biigle\Modules\Largo\Http\Controllers\Views\Volumes
LargoServiceProviderClass in namespace Biigle\Modules\Largo
LaserpointsControllerClass in namespace Biigle\Modules\Laserpoints\Http\Controllers\Api
$ Job#labelIdProperty in class Job

ID of the laser point label.

LaserpointsServiceProviderClass in namespace Biigle\Modules\Laserpoints
LaserpointsScriptClass in namespace Biigle\Modules\Laserpoints\Support
AnnotationCandidate::label() — Method in class AnnotationCandidate

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

$ Converter#labelsProperty in class Converter
Converter::labelForId() — Method in class Converter
$ ReportGenerator#labelsProperty in class ReportGenerator

Cache for labels of all label trees that are used for this report.

$ IfdoReportGenerator#labelsProperty in class IfdoReportGenerator

Labels that have been used in this volume.

$ PythonScriptRunner#linesProperty in class PythonScriptRunner

Array of output lines of the exec call.

LabelTreeExportControllerClass in namespace Biigle\Modules\Sync\Http\Controllers\Api\Export
LabelTreeExportClass in namespace Biigle\Modules\Sync\Support\Export
LabelTreeImportClass in namespace Biigle\Modules\Sync\Support\Import
$ VolumeImport#labelTreeImportProperty in class VolumeImport

The label tree import instance that belongs to this import.

LabelPolicyClass in namespace Biigle\Policies
LabelTreePolicyClass in namespace Biigle\Policies
LabelTreeVersionPolicyClass in namespace Biigle\Policies
Project::labelTrees() — Method in class Project

The label trees, this project is using.

$ EventServiceProvider#listenProperty in class EventServiceProvider

The event listener mappings for the application.

LessThanClass in namespace Biigle\Rules
$ FileMetadata#labelsProperty in class FileMetadata

The labels directly attached to the file.

LabelClass in namespace Biigle\Services\MetadataParsing
LabelAndUserClass in namespace Biigle\Services\MetadataParsing
Shape::line() — Method in class Shape
Shape::lineId() — Method in class Shape
User::labelTrees() — Method in class User

The label trees, this user is a member of.

Video::labels() — Method in class Video

The labels, this video got attached by the users.

VideoAnnotation::labels() — Method in class VideoAnnotation

The labels, this annotation got assigned by the users.

VolumeFile::labels() — Method in class VolumeFile

The labels, this volume file got attached by the users.

$ VolumeFileLabel#label_idProperty in class VolumeFileLabel
VolumeFileLabel::label() — Method in class VolumeFileLabel

The label, this video label belongs to.

M

MigrateTiledImagesClass in namespace Biigle\Console\Commands
ModulesClass in namespace Biigle\Facades
FederatedSearchInstance::models() — Method in class FederatedSearchInstance

The models that belong to this instance.

FileCache::makeHttpClient() — Method in class FileCache

Create a new Guzzle HTTP client.

LinkVideoAnnotationController::mergeAnnotationLabels() — Method in class LinkVideoAnnotationController

Update annotation labels of the second annotation to point to the first annotation unless there already are equivalent annotation labels there.

MediaTypeControllerClass in namespace Biigle\Http\Controllers\Api
MetadataControllerClass in namespace Biigle\Http\Controllers\Api\Volumes
ManualControllerClass in namespace Biigle\Http\Controllers\Views
$ Kernel#middlewareProperty in class Kernel

The application's global HTTP middleware stack.

$ Kernel#middlewareGroupsProperty in class Kernel

The application's route middleware groups.

$ Kernel#middlewareAliasesProperty in class Kernel

The application's middleware aliases.

AttachProjectUser::messages() — Method in class AttachProjectUser

Get the error messages for the defined validation rules.

$ DestroyLabelTreeUser#memberProperty in class DestroyLabelTreeUser

The label tree member to update.

StoreLabelTreeUser::messages() — Method in class StoreLabelTreeUser

Get the error messages for the defined validation rules.

StoreProjectInvitation::messages() — Method in class StoreProjectInvitation

Get the error messages for the defined validation rules.

$ StoreVolume#metadataParserProperty in class StoreVolume

Class name of the metadata parser that should be used.

$ StoreVolume#metadataPathProperty in class StoreVolume

Filled if an uploaded metadata text was stored in a file.

$ UpdateLabelTreeUser#memberProperty in class UpdateLabelTreeUser

The label tree member to update.

UpdateLabelTreeUser::messages() — Method in class UpdateLabelTreeUser

Get the error messages for the defined validation rules.

UpdateProjectUser::messages() — Method in class UpdateProjectUser

Get the error messages for the defined validation rules.

$ CreateNewImagesOrVideos#metadataProperty in class CreateNewImagesOrVideos

Metadata of the files to add during creation.

MigrateTiledImageClass in namespace Biigle\Jobs
ProcessNewImage::makeThumbnail() — Method in class ProcessNewImage

Makes a thumbnail for a single image.

TrackObject::maybeDeleteFile() — Method in class TrackObject

Delete a file if it exists.

LabelTree::memberCanLooseAdminStatus() — Method in class LabelTree

Check if a member can loose their admin status.

LabelTree::members() — Method in class LabelTree

The members of this label tree. Every member has a tree-specific role.

LabelTree::memberCanBeRemoved() — Method in class LabelTree

Determines if a member can be removed.

MediaTypeClass in namespace Biigle

Volumes can contain either images or videos as media type.

$ AnnotationAssistanceRequestFactory#modelProperty in class AnnotationAssistanceRequestFactory

The name of the factory's corresponding model.

$ LsloginIdFactory#modelProperty in class LsloginIdFactory

The name of the factory's corresponding model.

StoreColorSortSequence::messages() — Method in class StoreColorSortSequence

Get the error messages for the defined validation rules.

MigratePatchStorageClass in namespace Biigle\Modules\Largo\Console\Commands
$ ImageAnnotationLabelFeatureVectorFactory#modelProperty in class ImageAnnotationLabelFeatureVectorFactory

The name of the factory's corresponding model.

$ VideoAnnotationLabelFeatureVectorFactory#modelProperty in class VideoAnnotationLabelFeatureVectorFactory

The name of the factory's corresponding model.

GenerateFeatureVectors::makeBoxContained() — Method in class GenerateFeatureVectors

Adjust the position and size of the box so it is contained in a box with the given dimensions.

GenerateFeatureVectors::makeBoxIntegers() — Method in class GenerateFeatureVectors

Round and cast box values to int.

GenerateEmbedding::maybeDownloadCheckpoint() — Method in class GenerateEmbedding

Downloads the model checkpoint if they weren't downloaded yet.

MagicSamServiceProviderClass in namespace Biigle\Modules\MagicSam
MigratePatchStorageClass in namespace Biigle\Modules\Maia\Console\Commands
MigratePatchStorage::migrate() — Method in class MigratePatchStorage
$ AnnotationCandidateFactory#modelProperty in class AnnotationCandidateFactory

The name of the factory's corresponding model.

$ AnnotationCandidateFeatureVectorFactory#modelProperty in class AnnotationCandidateFeatureVectorFactory

The name of the factory's corresponding model.

MaiaJobFactoryClass in namespace Biigle\Modules\Maia\Database\Factories
$ MaiaJobFactory#modelProperty in class MaiaJobFactory

The name of the factory's corresponding model.

MaiaJobStateFactoryClass in namespace Biigle\Modules\Maia\Database\Factories
$ MaiaJobStateFactory#modelProperty in class MaiaJobStateFactory

The name of the factory's corresponding model.

$ TrainingProposalFactory#modelProperty in class TrainingProposalFactory

The name of the factory's corresponding model.

$ TrainingProposalFeatureVectorFactory#modelProperty in class TrainingProposalFeatureVectorFactory

The name of the factory's corresponding model.

MaiaJobContinuedClass in namespace Biigle\Modules\Maia\Events
MaiaJobCreatedClass in namespace Biigle\Modules\Maia\Events
MaiaJobDeletingClass in namespace Biigle\Modules\Maia\Events
MaiaJobControllerClass in namespace Biigle\Modules\Maia\Http\Controllers\Api
MaiaJobConvertingCandidatesControllerClass in namespace Biigle\Modules\Maia\Http\Controllers\Api
MaiaJobImagesControllerClass in namespace Biigle\Modules\Maia\Http\Controllers\Api
MaiaJobControllerClass in namespace Biigle\Modules\Maia\Http\Controllers\Views
UpdateAnnotationCandidate::maybeValidatePoints() — Method in class UpdateAnnotationCandidate

Check if the points array is correct if it is present.

UpdateAnnotationCandidate::maybeRestrictUpdating() — Method in class UpdateAnnotationCandidate

Do not allow updating of candidate candidate if it already has been selected.

UpdateTrainingProposal::maybeValidatePoints() — Method in class UpdateTrainingProposal

Check if the points array is correct if it is present.

UpdateTrainingProposal::maybeRestrictUpdating() — Method in class UpdateTrainingProposal

Do not allow updating of training proposals if the MAIA job is running object detection or is finished.

$ JobFailure#messageProperty in class JobFailure

Error message.

NoveltyDetection::maybeLimitAnnotations() — Method in class NoveltyDetection

Apply the limit for the maximum number of annotations.

ObjectDetection::maybeDownloadWeights() — Method in class ObjectDetection

Downloads the model pretrained weights if they weren't downloaded yet.

MaiaAnnotationClass in namespace Biigle\Modules\Maia
MaiaJobClass in namespace Biigle\Modules\Maia
MaiaJobStateClass in namespace Biigle\Modules\Maia
MaiaServiceProviderClass in namespace Biigle\Modules\Maia
MaiaJobPolicyClass in namespace Biigle\Modules\Maia\Policies
AreaKnowledgeTransferVolume::message() — Method in class AreaKnowledgeTransferVolume

Get the validation error message.

KnowledgeTransferVolume::message() — Method in class KnowledgeTransferVolume

Get the validation error message.

OddNumber::message() — Method in class OddNumber

Get the validation error message.

Converter::maybeCastToFloat() — Method in class Converter

Cast the value to float if it is not null or an empty string.

Converter::mediaType() — Method in class Converter
Converter::metadataClass() — Method in class Converter
MetadataIfdoServiceProviderClass in namespace Biigle\Modules\MetadataIfdo
$ NewsletterFactory#modelProperty in class NewsletterFactory

The name of the factory's corresponding model.

$ NewsletterSubscriberFactory#modelProperty in class NewsletterSubscriberFactory

The name of the factory's corresponding model.

$ ReportFactory#modelProperty in class ReportFactory

The name of the factory's corresponding model.

$ ReportTypeFactory#modelProperty in class ReportTypeFactory

The name of the factory's corresponding model.

File::makeTmp() — Method in class File

Creates a new temporary file.

MakesZipArchivesClass in namespace Biigle\Modules\Reports\Support\Reports
MakesZipArchives::makeZip() — Method in class MakesZipArchives

Create a ZIP archive as a report.

IfdoReportGenerator::mergeImageSetItem() — Method in class IfdoReportGenerator

Merge an image-set-items item of the original iFDO with the item generated by this report.

LabelTreeImport::mergeLabels() — Method in class LabelTreeImport

Merge conflicts between import labels and existing labels.

$ UserDiskFactory#modelProperty in class UserDiskFactory

The name of the factory's corresponding model.

$ StorageRequestFactory#modelProperty in class StorageRequestFactory

The name of the factory's corresponding model.

$ StorageRequestFileFactory#modelProperty in class StorageRequestFileFactory

The name of the factory's corresponding model.

FilePrefix::message() — Method in class FilePrefix

Get the validation error message.

$ InAppNotification#messageProperty in class InAppNotification

Message (body) of the notification.

GreaterThan::message() — Method in class GreaterThan

Get the validation error message.

Handle::message() — Method in class Handle

Get the validation error message.

$ ImageMetadata#messageProperty in class ImageMetadata

The validation error message.

ImageMetadata::message() — Method in class ImageMetadata

Get the validation error message.

LessThan::message() — Method in class LessThan

Get the validation error message.

Uuid4::message() — Method in class Uuid4

Get the validation error message.

VideoMetadata::message() — Method in class VideoMetadata

Get the validation error message.

VolumeFileUnique::message() — Method in class VolumeFileUnique

Get the validation error message.

$ VolumeFiles#messageProperty in class VolumeFiles

The validation message to display.

VolumeFiles::message() — Method in class VolumeFiles

Get the validation error message.

$ VolumeUrl#messageProperty in class VolumeUrl

The validation message to display.

VolumeUrl::message() — Method in class VolumeUrl

Get the validation error message.

CsvParser::maybeCastToFloat() — Method in class CsvParser

Cast the value to float if it is not null or an empty string.

MetadataParserClass in namespace Biigle\Services\MetadataParsing
ModulesClass in namespace Biigle\Services

The module registry service.

$ HasMetadataFile#metadataFileDiskProperty in class HasMetadataFile

Name of the storage disk where the metadata files are stored.

Volume::mediaType() — Method in class Volume

The media type of this volume.

N

$ Apidoc#nameProperty in class Apidoc

The console command name.

NewUserClass in namespace Biigle\Console\Commands
$ NewUser#nameProperty in class NewUser

The console command name.

NotificationControllerClass in namespace Biigle\Http\Controllers\Api
UsersController::newUser() — Method in class UsersController

Shows the admin new user page.

NotificationsControllerClass in namespace Biigle\Http\Controllers\Views\Notifications
SettingsController::notifications() — Method in class SettingsController

Shows the notification settings.

AnnotationAssistanceRequest::newFactory() — Method in class AnnotationAssistanceRequest

Create a new factory instance for the model.

$ Publish#nameProperty in class Publish

The console command name.

LsloginId::newFactory() — Method in class LsloginId

Create a new factory instance for the model.

$ Publish#nameProperty in class Publish

The console command name.

$ Config#nameProperty in class Config

The console command name.

$ Publish#nameProperty in class Publish

The console command name.

$ CountUniqueUser#nameProperty in class CountUniqueUser

The console command name.

$ CountUser#nameProperty in class CountUser

The console command name.

$ DetermineStorageUsage#nameProperty in class DetermineStorageUsage

The console command name.

$ Config#nameProperty in class Config

The console command name.

$ Publish#nameProperty in class Publish

The console command name.

ImageAnnotationLabelFeatureVector::newFactory() — Method in class ImageAnnotationLabelFeatureVector

Create a new factory instance for the model.

VideoAnnotationLabelFeatureVector::newFactory() — Method in class VideoAnnotationLabelFeatureVector

Create a new factory instance for the model.

$ Config#nameProperty in class Config

The console command name.

$ Publish#nameProperty in class Publish

The console command name.

$ PruneOldEmbeddings#nameProperty in class PruneOldEmbeddings

The console command name.

AnnotationCandidate::newFactory() — Method in class AnnotationCandidate

Create a new factory instance for the model.

AnnotationCandidateFeatureVector::newFactory() — Method in class AnnotationCandidateFeatureVector

Create a new factory instance for the model.

$ Publish#nameProperty in class Publish

The console command name.

$ ConvertAnnotationCandidates#newAnnotationsProperty in class ConvertAnnotationCandidates

Newly created annotations.

NotifyNoveltyDetectionCompleteClass in namespace Biigle\Modules\Maia\Jobs
NotifyObjectDetectionCompleteClass in namespace Biigle\Modules\Maia\Jobs
NoveltyDetectionClass in namespace Biigle\Modules\Maia\Jobs
NoveltyDetectionFailureClass in namespace Biigle\Modules\Maia\Jobs
MaiaJob::newFactory() — Method in class MaiaJob

Create a new factory instance for the model.

MaiaJobState::newFactory() — Method in class MaiaJobState

Create a new factory instance for the model.

NoveltyDetectionCompleteClass in namespace Biigle\Modules\Maia\Notifications
NoveltyDetectionFailedClass in namespace Biigle\Modules\Maia\Notifications
TrainingProposal::newFactory() — Method in class TrainingProposal

Create a new factory instance for the model.

TrainingProposalFeatureVector::newFactory() — Method in class TrainingProposalFeatureVector

Create a new factory instance for the model.

$ PruneStaleSubscribers#nameProperty in class PruneStaleSubscribers

The console command name.

NewsletterFactoryClass in namespace Biigle\Modules\Newsletter\Database\Factories
NewsletterSubscriberFactoryClass in namespace Biigle\Modules\Newsletter\Database\Factories
NewsletterControllerClass in namespace Biigle\Modules\Newsletter\Http\Controllers\Api
NewsletterSubscriberControllerClass in namespace Biigle\Modules\Newsletter\Http\Controllers\Api
NewsletterArchiveControllerClass in namespace Biigle\Modules\Newsletter\Http\Controllers\Views
NewsletterControllerClass in namespace Biigle\Modules\Newsletter\Http\Controllers\Views
$ UpdateNewsletter#newsletterProperty in class UpdateNewsletter
NewsletterClass in namespace Biigle\Modules\Newsletter
Newsletter::newFactory() — Method in class Newsletter

Create a new factory instance for the model.

NewsletterServiceProviderClass in namespace Biigle\Modules\Newsletter
NewsletterSubscriberClass in namespace Biigle\Modules\Newsletter
NewsletterSubscriber::newFactory() — Method in class NewsletterSubscriber

Create a new factory instance for the model.

NewNewsletterClass in namespace Biigle\Modules\Newsletter\Notifications
$ NewNewsletter#newsletterProperty in class NewNewsletter
NewsletterPolicyClass in namespace Biigle\Modules\Newsletter\Policies
NewsletterSubscriberPolicyClass in namespace Biigle\Modules\Newsletter\Policies
$ Publish#nameProperty in class Publish

The console command name.

Report::newFactory() — Method in class Report

Create a new factory instance for the model.

ReportType::newFactory() — Method in class ReportType

Create a new factory instance for the model.

$ AbundanceReportGenerator#nameProperty in class AbundanceReportGenerator

Name of the report for use in text.

$ AnnotationLocationReportGenerator#nameProperty in class AnnotationLocationReportGenerator

Name of the report for use in text.

$ AreaReportGenerator#nameProperty in class AreaReportGenerator

Name of the report for use in text.

$ BasicReportGenerator#nameProperty in class BasicReportGenerator

Name of the report for use in text.

$ CocoReportGenerator#nameProperty in class CocoReportGenerator

Name of the report for use in text.

$ CsvReportGenerator#nameProperty in class CsvReportGenerator

Name of the report for use in text.

$ ExtendedReportGenerator#nameProperty in class ExtendedReportGenerator

Name of the report for use in text.

$ FullReportGenerator#nameProperty in class FullReportGenerator

Name of the report for use in text.

$ ImageLocationReportGenerator#nameProperty in class ImageLocationReportGenerator

Name of the report for use in text.

$ ImageIfdoReportGenerator#nameProperty in class ImageIfdoReportGenerator

Name of the report for use in text.

$ BasicReportGenerator#nameProperty in class BasicReportGenerator

Name of the report for use in text.

$ CsvReportGenerator#nameProperty in class CsvReportGenerator

Name of the report for use in text.

$ ImageLocationReportGenerator#nameProperty in class ImageLocationReportGenerator

Name of the report for use in text.

$ CsvReportGenerator#nameProperty in class CsvReportGenerator

Name of the report for use in text.

$ VideoIfdoReportGenerator#nameProperty in class VideoIfdoReportGenerator

Name of the report for use in text.

$ CsvReportGenerator#nameProperty in class CsvReportGenerator

Name of the report for use in text.

$ ReportGenerator#nameProperty in class ReportGenerator

Name of the report for use in text.

$ AbundanceReportGenerator#nameProperty in class AbundanceReportGenerator

Name of the report for use in text.

$ AnnotationLocationReportGenerator#nameProperty in class AnnotationLocationReportGenerator

Name of the report for use in text.

$ AreaReportGenerator#nameProperty in class AreaReportGenerator

Name of the report for use in text.

$ BasicReportGenerator#nameProperty in class BasicReportGenerator

Name of the report for use in text.

$ CocoReportGenerator#nameProperty in class CocoReportGenerator

Name of the report for use in text.

$ CsvReportGenerator#nameProperty in class CsvReportGenerator

Name of the report for use in text.

$ ExtendedReportGenerator#nameProperty in class ExtendedReportGenerator

Name of the report for use in text.

$ FullReportGenerator#nameProperty in class FullReportGenerator

Name of the report for use in text.

$ ImageLocationReportGenerator#nameProperty in class ImageLocationReportGenerator

Name of the report for use in text.

$ ImageIfdoReportGenerator#nameProperty in class ImageIfdoReportGenerator

Name of the report for use in text.

$ BasicReportGenerator#nameProperty in class BasicReportGenerator

Name of the report for use in text.

$ CsvReportGenerator#nameProperty in class CsvReportGenerator

Name of the report for use in text.

$ ImageLocationReportGenerator#nameProperty in class ImageLocationReportGenerator

Name of the report for use in text.

$ CsvReportGenerator#nameProperty in class CsvReportGenerator

Name of the report for use in text.

$ VideoIfdoReportGenerator#nameProperty in class VideoIfdoReportGenerator

Name of the report for use in text.

$ CsvReportGenerator#nameProperty in class CsvReportGenerator

Name of the report for use in text.

$ Prune#nameProperty in class Prune

The console command name.

$ Publish#nameProperty in class Publish

The console command name.

$ CheckExpiredUserDisks#nameProperty in class CheckExpiredUserDisks

The console command name.

$ PruneExpiredUserDisks#nameProperty in class PruneExpiredUserDisks

The console command name.

UserDisk::newFactory() — Method in class UserDisk

Create a new factory instance for the model.

$ CheckExpiredStorageRequests#nameProperty in class CheckExpiredStorageRequests

The console command name.

$ PruneExpiredStorageRequests#nameProperty in class PruneExpiredStorageRequests

The console command name.

$ PruneStaleStorageRequests#nameProperty in class PruneStaleStorageRequests

The console command name.

StorageRequest::newFactory() — Method in class StorageRequest

Create a new factory instance for the model.

StorageRequestFile::newFactory() — Method in class StorageRequestFile

Create a new factory instance for the model.

$ RouteServiceProvider#namespaceProperty in class RouteServiceProvider

The controller namespace for the application.

O

ApiToken::owner() — Method in class ApiToken

The user, this token belongs to.

ObjectTrackingFailedClass in namespace Biigle\Events
ObjectTrackingSucceededClass in namespace Biigle\Events
$ CloneImagesOrVideos#onlyFilesProperty in class CloneImagesOrVideos

Array containing file ids.

$ CloneImagesOrVideos#onlyAnnotationLabelsProperty in class CloneImagesOrVideos

Array containing annotation label ids.

$ CloneImagesOrVideos#onlyFileLabelsProperty in class CloneImagesOrVideos

Array containing file label ids.

$ ProcessNewVolumeFiles#onlyProperty in class ProcessNewVolumeFiles

Array of image/video IDs to restrict processing to.

$ DelphiGather#outputPathProperty in class DelphiGather

Path to the temporary ouput file of the Delphi gather script.

ObjectDetectionClass in namespace Biigle\Modules\Maia\Jobs
ObjectDetectionFailureClass in namespace Biigle\Modules\Maia\Jobs
ObjectDetectionCompleteClass in namespace Biigle\Modules\Maia\Notifications
ObjectDetectionFailedClass in namespace Biigle\Modules\Maia\Notifications
OddNumberClass in namespace Biigle\Modules\Maia\Rules
$ ReportGenerator#optionsProperty in class ReportGenerator

Options for this report.

UserDisksServiceProvider::overrideUseDiskGateAbility() — Method in class UserDisksServiceProvider

Add user disks logic to the 'use-disk' ability.

$ DeleteStorageRequestFile#oldRetryCountProperty in class DeleteStorageRequestFile

Count for retry attempts of a chunked file

Volume::orderedImages() — Method in class Volume

The images belonging to this volume ordered by filename (ascending).

Volume::orderedFiles() — Method in class Volume

The images belonging to this volume ordered by filename (ascending).

P

$ Annotation#pointsProperty in class Annotation
PruneNotificationsClass in namespace Biigle\Console\Commands
UpdateVideoMetadata::processVolume() — Method in class UpdateVideoMetadata
UpdateVideoMetadata::processLocalVideo() — Method in class UpdateVideoMetadata
UpdateVideoMetadata::processRemoteVideo() — Method in class UpdateVideoMetadata
Handler::prepareException() — Method in class Handler

Prepare exception for rendering.

PruneFileCacheClass in namespace Biigle\FileCache\Console\Commands
FileCache::prune() — Method in class FileCache

Remove cached files that are too old or exceed the maximum cache size.

FileCache::prune() — Method in class FileCache

Remove cached files that are too old or exceed the maximum cache size.

FileCacheServiceProvider::provides() — Method in class FileCacheServiceProvider

Get the services provided by the provider.

FileCacheFake::prune() — Method in class FileCacheFake

Remove cached files that are too old or exceed the maximum cache size.

PendingVolumeControllerClass in namespace Biigle\Http\Controllers\Api
PendingVolumeImportControllerClass in namespace Biigle\Http\Controllers\Api
ProjectControllerClass in namespace Biigle\Http\Controllers\Api
ProjectInvitationControllerClass in namespace Biigle\Http\Controllers\Api
ProjectLabelTreeControllerClass in namespace Biigle\Http\Controllers\Api
ProjectUserControllerClass in namespace Biigle\Http\Controllers\Api
ProjectVolumeControllerClass in namespace Biigle\Http\Controllers\Api
ProjectsAttachableVolumesControllerClass in namespace Biigle\Http\Controllers\Api
PrivacyControllerClass in namespace Biigle\Http\Controllers\Views
ProjectInvitationControllerClass in namespace Biigle\Http\Controllers\Views\Projects
ProjectLabelTreeControllerClass in namespace Biigle\Http\Controllers\Views\Projects
ProjectStatisticsControllerClass in namespace Biigle\Http\Controllers\Views\Projects
ProjectUserControllerClass in namespace Biigle\Http\Controllers\Views\Projects
ProjectsControllerClass in namespace Biigle\Http\Controllers\Views\Projects
SettingsController::profile() — Method in class SettingsController

Shows the profile settings.

PendingVolumeControllerClass in namespace Biigle\Http\Controllers\Views\Volumes
PreventRequestsDuringMaintenanceClass in namespace Biigle\Http\Middleware
$ TrustProxies#proxiesProperty in class TrustProxies

The trusted proxies for this application.

$ AttachProjectUser#projectProperty in class AttachProjectUser

The project to attach a user to.

$ CloneVolume#projectProperty in class CloneVolume

The project to update.

$ DestroyPinnedProject#projectProperty in class DestroyPinnedProject

The project to unpin.

$ DestroyProjectUser#projectProperty in class DestroyProjectUser

The project to detach the user from.

$ StoreLabelTree#projectProperty in class StoreLabelTree

The project to which the new label tree should be attached (if any).

StorePendingVolume::prepareForValidation() — Method in class StorePendingVolume

Prepare the data for validation.

$ StorePinnedProject#projectProperty in class StorePinnedProject

The project to pin.

$ StoreProjectInvitation#projectProperty in class StoreProjectInvitation

The project to attach a user to.

$ StoreProjectLabelTree#projectProperty in class StoreProjectLabelTree

The project to attach the label tree to.

StoreUser::prepareForValidation() — Method in class StoreUser

Prepare the data for validation.

$ StoreVolume#projectProperty in class StoreVolume

The project to attach the new volume to.

StoreVolume::prepareForValidation() — Method in class StoreVolume

Prepare the data for validation.

StoreVolumeFile::prepareForValidation() — Method in class StoreVolumeFile

Prepare the data for validation.

UpdatePendingVolume::prepareForValidation() — Method in class UpdatePendingVolume

Prepare the data for validation.

$ UpdateProject#projectProperty in class UpdateProject

The project to update.

$ UpdateProjectUser#projectProperty in class UpdateProjectUser

The project to update the user in.

UpdateUser::prepareForValidation() — Method in class UpdateUser

Prepare the data for validation.

UpdateVolume::prepareForValidation() — Method in class UpdateVolume

Prepare the data for validation.

Ifdo::printErrors() — Method in class Ifdo
$ CloneImagesOrVideos#projectProperty in class CloneImagesOrVideos

The target project.

ProcessNewImageClass in namespace Biigle\Jobs
ProcessNewVideoClass in namespace Biigle\Jobs
ProcessNewVolumeFilesClass in namespace Biigle\Jobs
TrackObject::python() — Method in class TrackObject

Execute a Python script.

Label::parent() — Method in class Label

The parent label if the labels are ordered in a tree-like structure.

LabelTree::projects() — Method in class LabelTree

The projects that are using this label tree.

AnanasServiceProvider::provides() — Method in class AnanasServiceProvider

Get the services provided by the provider.

PublishClass in namespace Biigle\Modules\Ananas\Console\Commands
StoreAnnotationAssistanceRequest::prepareForValidation() — Method in class StoreAnnotationAssistanceRequest

Prepare the data for validation.

ColorSortServiceProvider::provides() — Method in class ColorSortServiceProvider

Get the services provided by the provider.

PublishClass in namespace Biigle\Modules\ColorSort\Console\Commands
DemoServiceProvider::provides() — Method in class DemoServiceProvider

Get the services provided by the provider.

PublishClass in namespace Biigle\Modules\Geo\Console\Commands
GeoServiceProvider::provides() — Method in class GeoServiceProvider

Get the services provided by the provider.

ProjectImageAnnotationLabelControllerClass in namespace Biigle\Modules\Geo\Http\Controllers\Api
ProjectControllerClass in namespace Biigle\Modules\Geo\Http\Controllers\Views
InitializeFeatureVectors::processImages() — Method in class InitializeFeatureVectors
InitializeFeatureVectors::processVideos() — Method in class InitializeFeatureVectors
PublishClass in namespace Biigle\Modules\Largo\Console\Commands
ProcessAnnotatedFileExceptionClass in namespace Biigle\Modules\Largo\Exceptions
$ IndexProjectAnnotationsSimilarity#projectProperty in class IndexProjectAnnotationsSimilarity

The project of which to index the annotations.

$ StoreProjectLargoSession#projectProperty in class StoreProjectLargoSession

The project to store the Largo session for.

GenerateFeatureVectors::python() — Method in class GenerateFeatureVectors

Run the Python command.

ProcessAnnotatedFileClass in namespace Biigle\Modules\Largo\Jobs
ProcessAnnotatedImageClass in namespace Biigle\Modules\Largo\Jobs
ProcessAnnotatedVideoClass in namespace Biigle\Modules\Largo\Jobs
ProcessAnnotatedVideo::processAnnotationChunk() — Method in class ProcessAnnotatedVideo

Process a chunk of annotations of this job's file.

LargoServiceProvider::provides() — Method in class LargoServiceProvider

Get the services provided by the provider.

PublishClass in namespace Biigle\Modules\Laserpoints\Console\Commands
ProcessDelphiJobClass in namespace Biigle\Modules\Laserpoints\Jobs
ProcessImageDelphiJobClass in namespace Biigle\Modules\Laserpoints\Jobs
ProcessImageManualJobClass in namespace Biigle\Modules\Laserpoints\Jobs
ProcessManualJobClass in namespace Biigle\Modules\Laserpoints\Jobs
$ ProcessManualJob#pointsProperty in class ProcessManualJob

Laser point coordinates for the image.

ProcessVolumeDelphiJobClass in namespace Biigle\Modules\Laserpoints\Jobs
LaserpointsServiceProvider::provides() — Method in class LaserpointsServiceProvider

Get the services provided by the provider.

DelphiGather::python() — Method in class DelphiGather

Execute a python script.

PruneOldEmbeddingsClass in namespace Biigle\Modules\MagicSam\Console\Commands
GenerateEmbedding::python() — Method in class GenerateEmbedding

Execute a Python command.

PublishClass in namespace Biigle\Modules\Maia\Console\Commands
PrepareKnowledgeTransferExceptionClass in namespace Biigle\Modules\Maia\Exceptions
$ UpdateTrainingProposal#proposalProperty in class UpdateTrainingProposal

The training proposal to update

ConvertAnnotationCandidates::processChunk() — Method in class ConvertAnnotationCandidates

Process a chunk of annotation candidates.

DetectionJob::python() — Method in class DetectionJob

Execute a Python command and return the path to a file containing the output.

DetectionJob::parseAnnotations() — Method in class DetectionJob

Parse the output JSON files to get the array of annotations for each image.

DetectionJob::parseAnnotationsFile() — Method in class DetectionJob

Parse the output JSON file of a single image.

ObjectDetection::performTraining() — Method in class ObjectDetection

Perform training of object detection model.

ObjectDetection::performInference() — Method in class ObjectDetection

Perform inference with the trained object detection model.

PrepareAnnotationsJobClass in namespace Biigle\Modules\Maia\Jobs
PrepareExistingAnnotationsClass in namespace Biigle\Modules\Maia\Jobs
PrepareKnowledgeTransferClass in namespace Biigle\Modules\Maia\Jobs
ProcessNoveltyDetectedImageClass in namespace Biigle\Modules\Maia\Jobs
ProcessObjectDetectedImageClass in namespace Biigle\Modules\Maia\Jobs
PrepareDeleteAnnotationPatchesClass in namespace Biigle\Modules\Maia\Listeners
PruneTrainingProposalFeatureVectorsClass in namespace Biigle\Modules\Maia\Listeners
PruneTrainingProposalPatchesClass in namespace Biigle\Modules\Maia\Listeners
MaiaServiceProvider::provides() — Method in class MaiaServiceProvider

Get the services provided by the provider.

AreaKnowledgeTransferVolume::passes() — Method in class AreaKnowledgeTransferVolume

Determine if the validation rule passes.

KnowledgeTransferVolume::passes() — Method in class KnowledgeTransferVolume

Determine if the validation rule passes.

OddNumber::passes() — Method in class OddNumber

Determine if the validation rule passes.

Converter::parseHandle() — Method in class Converter
PruneStaleSubscribersClass in namespace Biigle\Modules\Newsletter\Console\Commands
NewsletterController::publish() — Method in class NewsletterController

Publish a newsletter

DestroyNewsletterSubscriber::prepareForValidation() — Method in class DestroyNewsletterSubscriber

Prepare the data for validation.

StoreNewsletterSubscriber::prepareForValidation() — Method in class StoreNewsletterSubscriber

Prepare the data for validation.

NewsletterPolicy::publish() — Method in class NewsletterPolicy

Determine if the given user can publish a newsletter.

PublishClass in namespace Biigle\Modules\Reports\Console\Commands
ProjectReportControllerClass in namespace Biigle\Modules\Reports\Http\Controllers\Api\Projects
ProjectReportsControllerClass in namespace Biigle\Modules\Reports\Http\Controllers\Views
$ StoreProjectReport#projectProperty in class StoreProjectReport

The project to generate a new report for.

ProjectObserverClass in namespace Biigle\Modules\Reports\Observers
$ ReportsServiceProvider#policiesProperty in class ReportsServiceProvider

The policy mappings for the application.

ReportsServiceProvider::provides() — Method in class ReportsServiceProvider

Get the services provided by the provider.

CsvFile::put() — Method in class CsvFile

Append a new row to the CSV file.

$ File#pathProperty in class File

File path.

File::put() — Method in class File

Add content to the file.

ProjectImageReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Projects
ProjectReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Projects
ProjectVideoReportGeneratorClass in namespace Biigle\Modules\Reports\Support\Reports\Projects
IfdoReportGenerator::processFile() — Method in class IfdoReportGenerator

Create the image-set-item entry for an image or video.

AreaReportGenerator::parseRows() — Method in class AreaReportGenerator

Creates the array of annotations that is inserted into the CSV file.

ImageIfdoReportGenerator::processFile() — Method in class ImageIfdoReportGenerator

Create the image-set-item entry for an image.

PythonScriptRunnerClass in namespace Biigle\Modules\Reports\Support\Reports\Volumes
VideoIfdoReportGenerator::processFile() — Method in class VideoIfdoReportGenerator

Create the image-set-item entry for a video.

$ VolumeReportGenerator#pythonScriptRunnerProperty in class VolumeReportGenerator

Object that runs the Python script to generate a report.

PruneClass in namespace Biigle\Modules\Sync\Console\Commands
PublishClass in namespace Biigle\Modules\Sync\Console\Commands
PublicLabelTreeExportControllerClass in namespace Biigle\Modules\Sync\Http\Controllers\Api\Export
PublicLabelTreeImportControllerClass in namespace Biigle\Modules\Sync\Http\Controllers\Api\Import
PublicLabelTreeImportControllerClass in namespace Biigle\Modules\Sync\Http\Controllers\Views
PostprocessVolumeImportClass in namespace Biigle\Modules\Sync\Jobs
PublicLabelExportClass in namespace Biigle\Modules\Sync\Support\Export
PublicLabelTreeExportClass in namespace Biigle\Modules\Sync\Support\Export
ArchiveManager::prune() — Method in class ArchiveManager

Delete uploaded import files that are older than one week.

$ Import#pathProperty in class Import

Path to the directory with the import files.

LabelTreeImport::perform() — Method in class LabelTreeImport

Perform the import.

PublicLabelTreeImportClass in namespace Biigle\Modules\Sync\Support\Import
PublicLabelTreeImport::perform() — Method in class PublicLabelTreeImport

Perform the import.

UserImport::perform() — Method in class UserImport

Perform the import.

VolumeImport::perform() — Method in class VolumeImport

Perform the import.

SyncServiceProvider::provides() — Method in class SyncServiceProvider

Get the services provided by the provider.

PruneExpiredUserDisksClass in namespace Biigle\Modules\UserDisks\Console\Commands
UpdateUserDisk::prepareForValidation() — Method in class UpdateUserDisk

Prepare the data for validation.

PruneExpiredStorageRequestsClass in namespace Biigle\Modules\UserStorage\Console\Commands
PruneStaleStorageRequestsClass in namespace Biigle\Modules\UserStorage\Console\Commands
StoreStorageRequestFile::prepareForValidation() — Method in class StoreStorageRequestFile

Prepare the data for validation.

$ DeleteStorageRequestDirectory#pathProperty in class DeleteStorageRequestDirectory

Directory path to be deleted.

$ DeleteStorageRequestDirectory#pendingProperty in class DeleteStorageRequestDirectory

Whether the request of the file was pending or not.

$ DeleteStorageRequestFile#pathProperty in class DeleteStorageRequestFile

Path of the file to be deleted.

$ DeleteStorageRequestFile#pendingProperty in class DeleteStorageRequestFile

Whether the request of the file was pending or not.

$ DeleteStorageRequestFile#prefixProperty in class DeleteStorageRequestFile

Directory prefix of the storage request.

FilePrefix::passes() — Method in class FilePrefix

Determine if the validation rule passes.

$ ChunkedFileStreamPump#pathProperty in class ChunkedFileStreamPump

Base path of the storage request file.

ProjectObserverClass in namespace Biigle\Observers
PendingVolumeClass in namespace Biigle
PendingVolume::project() — Method in class PendingVolume
PendingVolumePolicyClass in namespace Biigle\Policies
ProjectInvitationPolicyClass in namespace Biigle\Policies
ProjectPolicyClass in namespace Biigle\Policies
ProjectClass in namespace Biigle
Project::pendingVolumes() — Method in class Project

The pending volumes of this project.

ProjectInvitationClass in namespace Biigle
ProjectInvitation::project() — Method in class ProjectInvitation

The project to which this invitation belongs.

$ AuthServiceProvider#policiesProperty in class AuthServiceProvider

The policy mappings for the application.

GreaterThan::passes() — Method in class GreaterThan

Determine if the validation rule passes.

Handle::passes() — Method in class Handle

Determine if the validation rule passes.

ImageMetadata::passes() — Method in class ImageMetadata

Determine if the validation rule passes.

LessThan::passes() — Method in class LessThan

Determine if the validation rule passes.

Uuid4::passes() — Method in class Uuid4

Determine if the validation rule passes.

VideoMetadata::passes() — Method in class VideoMetadata

Determine if the validation rule passes.

VolumeFileUnique::passes() — Method in class VolumeFileUnique

Check if the given filenames don't already exist in the volume.

VolumeFiles::passes() — Method in class VolumeFiles

Check if an array of image filenames is valid.

VolumeUrl::passes() — Method in class VolumeUrl

Determine if the validation rule passes.

VolumeUrl::passesRemoteUrl() — Method in class VolumeUrl

Validate a remote volume URL.

VolumeUrl::passesDiskUrl() — Method in class VolumeUrl

Validate a storage disk volume URL.

WormsAdapter::parseItem() — Method in class WormsAdapter

Parse a WoRMS item to the internal representation.

CsvParser::processFirstLine() — Method in class CsvParser
ParserFactoryClass in namespace Biigle\Services\MetadataParsing
$ ParserFactory#parsers