A

AddAnnotationAssistanceRequestsIndex — Class in namespace [Global Namespace]
AnnotationAssistanceRequestsNotification — Class in namespace [Global Namespace]
Annotation — Class in namespace Biigle

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

AnnotationLabel — Class in namespace Biigle
$ AnnotationLabel#annotation_id — Property in class AnnotationLabel
AnnotationLabel::annotation() — Method in class AnnotationLabel

The annotation, this annotation label belongs to.

AnnotationSession — Class in namespace Biigle

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

$ AnnotationSession#appends — Property 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.

Announcement — Class in namespace Biigle

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

ApiToken — Class in namespace Biigle
Apidoc — Class in namespace Biigle\Console\Commands
Annotation — Class in namespace Biigle\Contracts

An annotation model.

AnnotationLabelAttached — Class in namespace Biigle\Events
$ ObjectTrackingFailed#annotation — Property in class ObjectTrackingFailed

The video annotation that finished tracking.

$ ObjectTrackingSucceeded#annotation — Property in class ObjectTrackingSucceeded

The video annotation that finished tracking.

FileCache::assertMimeTypeAllowed() — Method in class FileCache

Throw if the given MIME type is not in the configured allow list.

FileCache::assertSizeAllowed() — Method in class FileCache

Throw if the given file size exceeds the configured max_file_size. A negative max_file_size disables the check.

AnnotationSessionController — Class in namespace Biigle\Http\Controllers\Api
AnnotationController — Class in namespace Biigle\Http\Controllers\Api\Annotations\Filters
AnnotationUserController — Class in namespace Biigle\Http\Controllers\Api\Annotations\Filters
AnnouncementController — Class in namespace Biigle\Http\Controllers\Api
ApiTokenController — Class in namespace Biigle\Http\Controllers\Api
ProjectLabelTreeController::available() — Method in class ProjectLabelTreeController

Display label trees that match the given name and 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.

AnnotationLabelController — Class in namespace Biigle\Http\Controllers\Api\Volumes\Filters
AnyFileLabelController — Class in namespace Biigle\Http\Controllers\Api\Volumes\Filters
LoginController::attemptLogin() — Method in class LoginController

Attempt to log the user into the application.

AnnouncementsController — Class in namespace Biigle\Http\Controllers\Views\Admin
AnnotationToolController — Class in namespace Biigle\Http\Controllers\Views\Annotations
DashboardController::annotationsActivityItems() — Method in class DashboardController

Get the most recently annotated images of a user.

AnnotationCatalogController — Class in namespace Biigle\Http\Controllers\Views\LabelTrees
SettingsController::account() — Method in class SettingsController

Shows the account settings.

SettingsController::authentication() — Method in class SettingsController

Shows the authentication settings.

Authenticate — Class in namespace Biigle\Http\Middleware
AuthenticateRegister — Class in namespace Biigle\Http\Middleware
$ PreventRequestForgery#addHttpCookie — Property in class PreventRequestForgery

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

$ TrustHosts#alwaysTrust — Property in class TrustHosts
AttachProjectUser — Class 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#annotationSession — Property 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#annotationLabel — Property 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.

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.

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.

ShowExport::authorize() — Method in class ShowExport
ShowPublicLabelTreeExport::authorize() — Method in class ShowPublicLabelTreeExport

Determine if the user is authorized to make this request.

$ SplitVideoAnnotation#annotation — Property 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#annotation — Property 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.

StoreLargoSession::authorize() — Method in class StoreLargoSession

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.

StorePendingVolumeFromVolume::authorize() — Method in class StorePendingVolumeFromVolume

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.

StoreProjectLargoSession::authorize() — Method in class StoreProjectLargoSession

Determine if the user is authorized to make this request.

StoreProjectReport::authorize() — Method in class StoreProjectReport

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#annotation — Property 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.

StoreVolumeLargoSession::authorize() — Method in class StoreVolumeLargoSession

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.

StoreVolumeReport::authorize() — Method in class StoreVolumeReport

Determine if the user is authorized to make this request.

$ UpdateAnnotationSession#annotationSession — Property 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.

$ UpdateImageAnnotation#annotation — Property in class UpdateImageAnnotation

The annotation that should be updated.

UpdateImageAnnotation::authorize() — Method in class UpdateImageAnnotation

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#additionalRules — Property 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#annotation — Property 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.

ApplyLargoSession — Class in namespace Biigle\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#annotationIds — Property in class RemoveAnnotationPatches

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

$ TrackObject#annotationId — Property in class TrackObject

The annotation ID 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.

AttachLabelListener — Class in namespace Biigle\Listeners
AnanasServiceProvider — Class in namespace Biigle\Modules\Ananas
AnnotationAssistanceRequest — Class 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.

AnnotationAssistanceRequestFactory — Class in namespace Biigle\Modules\Ananas\Database\Factories
AnnotationAssistanceRequestController — Class in namespace Biigle\Modules\Ananas\Http\Controllers\Api
AnnotationAssistanceRequestController — Class in namespace Biigle\Modules\Ananas\Http\Controllers\Views
$ StoreAnnotationAssistanceRequest#annotation — Property 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#ananas — Property in class UpdateAnnotationAssistanceRequest

The request to update.

UpdateAnnotationAssistanceRequest::authorize() — Method in class UpdateAnnotationAssistanceRequest

Determine if the user is authorized to make this request.

AnnotationAssistanceRequest — Class in namespace Biigle\Modules\Ananas\Notifications
AnnotationAssistanceResponse — Class in namespace Biigle\Modules\Ananas\Notifications
AnnotationAssistanceRequestObserver — Class in namespace Biigle\Modules\Ananas\Observers
AnnotationAssistanceRequestPolicy — Class 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.

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.

StoreImageEmbeddingRequest::authorize() — Method in class StoreImageEmbeddingRequest

Determine if the user is authorized to make this request.

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

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

AnnotationCandidateFeatureVector — Class in namespace Biigle\Modules\Maia
$ MigratePatchStorage#acDisk — Property in class MigratePatchStorage

MAIA annotation candidate patch storage disk.

AnnotationCandidateFactory — Class in namespace Biigle\Modules\Maia\Database\Factories
AnnotationCandidateFeatureVectorFactory — Class in namespace Biigle\Modules\Maia\Database\Factories
AnnotationCandidateController — Class in namespace Biigle\Modules\Maia\Http\Controllers\Api
AreaKnowledgeTransferVolumeController — Class 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#annotationCandidates — Property 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.

AnnotationCandidatePolicy — Class 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.

AreaKnowledgeTransferVolume — Class in namespace Biigle\Modules\Maia\Rules
Annotation — Class in namespace Biigle\Modules\MetadataCoco
$ Coco#annotations — Property in class Coco
$ Converter#acquisitionFormat — Property in class Converter
$ Converter#annotators — Property in class Converter
Converter::addAnnotations() — Method in class Converter
Converter::annotationClass() — Method in class Converter
AdminController — Class in namespace Biigle\Modules\Metrics\Http\Controllers
AdminController — Class 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.

$ PtpJob#annotatedFileColumns — Property in class PtpJob

List of columns of the CSV file

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

ApproveStorageRequest — Class 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.

ApproveStorageRequest — Class in namespace Biigle\Modules\UserStorage\Jobs
AssembleChunkedFile — Class 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#appends — Property in class StorageRequest

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

$ InAppNotification#action — Property in class InAppNotification

Label of the action link.

$ InAppNotification#actionLink — Property in class InAppNotification

Action link (URL).

AnnotationObserver — Class in namespace Biigle\Observers
$ PendingVolume#attributes — Property in class PendingVolume

Default values for attributes.

AnnotationLabelPolicy — Class in namespace Biigle\Policies
AnnotationPolicy — Class 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.

AnnouncementPolicy — Class in namespace Biigle\Policies
ApiTokenPolicy — Class 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.

ReportPolicy::access() — Method in class ReportPolicy

Determine if the given report 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#appends — Property in class ProjectInvitation

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

AppServiceProvider — Class in namespace Biigle\Providers
AuthServiceProvider — Class in namespace Biigle\Providers
Role::admin() — Method in class Role
Role::adminId() — Method in class Role
AnnotationPoints — Class in namespace Biigle\Rules
ApiGuard — Class in namespace Biigle\Services\Auth
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.

ArchiveManager — Class in namespace Biigle\Services\Import
LabelTreeImport::attachLabelTreeMembers() — Method in class LabelTreeImport

Attach members to imported label trees.

Annotation — Class in namespace Biigle\Services\MetadataParsing
$ FileMetadata#annotations — Property 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#apidocPaths — Property in class Modules

Additional source paths to generate the API documentation from.

Modules::addMixin() — Method in class Modules
AbundanceReportGenerator — Class in namespace Biigle\Services\Reports\Projects\ImageAnnotations
AnnotationLocationReportGenerator — Class in namespace Biigle\Services\Reports\Projects\ImageAnnotations
AnnotationReportGenerator — Class in namespace Biigle\Services\Reports\Projects\ImageAnnotations
AreaReportGenerator — Class in namespace Biigle\Services\Reports\Projects\ImageAnnotations
AbundanceReportGenerator — Class in namespace Biigle\Services\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.

AnnotationLocationReportGenerator — Class in namespace Biigle\Services\Reports\Volumes\ImageAnnotations
AnnotationReportGenerator — Class in namespace Biigle\Services\Reports\Volumes\ImageAnnotations
AreaReportGenerator — Class in namespace Biigle\Services\Reports\Volumes\ImageAnnotations
$ VolumeReportGenerator#annotationSession — Property in class VolumeReportGenerator

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

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.

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.

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.

VolumeFilesProcessed::broadcastOn() — Method in class VolumeFilesProcessed

Get the channels the event should broadcast on.

VolumeFilesProcessed::broadcastWith() — Method in class VolumeFilesProcessed

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.

BrowserController — Class in namespace Biigle\Http\Controllers\Api\Volumes
$ UpdateFederatedSearchIndex#backoff — Property 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.

ServiceProvider::boot() — Method in class ServiceProvider

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.

LaserpointsServiceProvider::boot() — Method in class LaserpointsServiceProvider

Bootstrap the application events.

$ EmbeddingAvailable#bbox — Property in class EmbeddingAvailable

The bbox of the image (x, y, width, height) or null for full image.

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.

$ StoreImageEmbeddingRequest#bbox — Property in class StoreImageEmbeddingRequest

The validated bbox.

$ GenerateEmbedding#bbox — Property in class GenerateEmbedding

The bbox of the image to generate an embedding for (x, y, width, height).

GenerateEmbedding::bufferFromVipsImage() — Method in class GenerateEmbedding

Get the byte string of the resized image for the Python worker.

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.

$ Annotation#bbox — Property in class Annotation
MetadataCocoServiceProvider::boot() — Method in class MetadataCocoServiceProvider

Bootstrap the application events.

MetadataIfdoServiceProvider::boot() — Method in class MetadataIfdoServiceProvider

Bootstrap the application events.

MetricsServiceProvider::boot() — Method in class MetricsServiceProvider

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.

PtpServiceProvider::boot() — Method in class PtpServiceProvider

Bootstrap the application events.

UserDiskPolicy::before() — Method in class UserDiskPolicy

Intercept all checks.

UserDisksServiceProvider::boot() — Method in class UserDisksServiceProvider

Bootstrap the application events.

BucketName — Class in namespace Biigle\Modules\UserDisks\Validators
StorageRequestPolicy::before() — Method in class StorageRequestPolicy

Intercept all checks.

StorageRequest::booted() — Method in class StorageRequest

The "booted" method of the model.

$ ChunkedFileStreamPump#buffer — Property 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.

ReportPolicy::before() — Method in class ReportPolicy

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.

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

Bootstrap any application services.

RouteServiceProvider::boot() — Method in class RouteServiceProvider

Define your route model bindings, pattern filters, etc.

PulseQueueSizeCardServiceProvider::boot() — Method in class PulseQueueSizeCardServiceProvider

Bootstrap any application services.

BasicReportGenerator — Class in namespace Biigle\Services\Reports\Projects\ImageAnnotations
BasicReportGenerator — Class in namespace Biigle\Services\Reports\Projects\ImageLabels
BasicReportGenerator — Class in namespace Biigle\Services\Reports\Volumes\ImageAnnotations
BasicReportGenerator — Class in namespace Biigle\Services\Reports\Volumes\ImageLabels
WebDavServiceProvider::boot() — Method in class WebDavServiceProvider

Bootstrap the application services.

C

$ Annotation#created_at — Property in class Annotation
Annotation::casts() — Method in class Annotation

Get the attributes that should be cast.

$ AnnotationLabel#created_at — Property in class AnnotationLabel
AnnotationLabel::casts() — Method in class AnnotationLabel

Get the attributes that should be cast.

AnnotationSession::casts() — Method in class AnnotationSession

Get the attributes that should be cast.

Announcement::casts() — Method in class Announcement

Get the attributes that should be cast.

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::casts() — Method in class FederatedSearchInstance

Get the attributes that should be cast.

FederatedSearchInstance::createLocalToken() — Method in class FederatedSearchInstance

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

FederatedSearchModel::casts() — Method in class FederatedSearchModel

Get the attributes that should be cast.

FileCache::clear() — Method in class FileCache

Delete all unused cached files.

$ FileCache#config — Property in class FileCache

File cache configuration.

$ FileCache#client — Property in class FileCache

Guzzle HTTP client to use

FileCache::clear() — Method in class FileCache

Delete all unused cached files.

FileCache::createReferenceLink() — Method in class FileCache

Create the reference link that signals the cached file is in use and release the lock handle.

FileCache::canonicalFiles() — Method in class FileCache

Get a Finder for the canonical cache files, excluding reference links and lock files.

FileCache::cacheFromResource() — Method in class FileCache

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

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

Delete all unused cached files.

Controller — Class in namespace Biigle\Http\Controllers\Api
Controller — Class in namespace Biigle\Http\Controllers\Api\Export
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.

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

Shows the admin new announcement page.

Controller — Class 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.

CloneVolume — Class in namespace Biigle\Http\Requests
$ StoreLabelTreeMerge#create — Property in class StoreLabelTreeMerge

Flat array of labels to create.

$ StoreLargoSession#changedImageAnnotations — Property in class StoreLargoSession

The changed_image_annotations request attribute.

$ StoreLargoSession#changedVideoAnnotations — Property in class StoreLargoSession

The changed_video_annotations request attribute.

UpdateFederatedSearchInstance::checkRemoteConnection() — Method in class UpdateFederatedSearchInstance

Check the connection to the remote instance.

Image::casts() — Method in class Image

Get the attributes that should be cast.

ImageAnnotation::casts() — Method in class ImageAnnotation

Get the attributes that should be cast.

ImageAnnotationLabel::casts() — Method in class ImageAnnotationLabel

Get the attributes that should be cast.

ImageAnnotationLabelFeatureVector::casts() — Method in class ImageAnnotationLabelFeatureVector

Get the attributes that should be cast.

$ ApplyLargoSession#changedImageAnnotations — Property in class ApplyLargoSession

Array of all changed image annotation IDs for each label.

$ ApplyLargoSession#changedVideoAnnotations — Property in class ApplyLargoSession

Array of all changed video annotation IDs for each label.

ApplyLargoSession::cleanupJobId() — Method in class ApplyLargoSession

Remove the properties that indicate that a save Largo session is in progress.

CloneImageThumbnails — Class in namespace Biigle\Jobs
$ CloneImageThumbnails#copyPrefix — Property in class CloneImageThumbnails

Path of cloned image thumbnails and tiled data

CloneImagesOrVideos — Class in namespace Biigle\Jobs
$ CloneImagesOrVideos#copy — Property in class CloneImagesOrVideos
$ CloneImagesOrVideos#cloneAnnotations — Property in class CloneImagesOrVideos

Boolean for cloning annotation labels.

$ CloneImagesOrVideos#cloneFileLabels — Property 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
CloneVideoThumbnails — Class in namespace Biigle\Jobs
$ CloneVideoThumbnails#copyPrefix — Property in class CloneVideoThumbnails

Path of cloned video thumbnails and sprites

CopyAnnotationFeatureVector — Class in namespace Biigle\Jobs
CopyImageAnnotationFeatureVector — Class in namespace Biigle\Jobs
CopyVideoAnnotationFeatureVector — Class in namespace Biigle\Jobs
CreateNewImagesOrVideos — Class in namespace Biigle\Jobs
CreateNewImagesOrVideos::createFiles() — Method in class CreateNewImagesOrVideos

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

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

ProcessNewImage::collectMetadata() — Method in class ProcessNewImage

Collect image metadata.

$ RemoveAnnotationPatches#chunkSize — Property in class RemoveAnnotationPatches

Number of annotations to start chunking of this job.

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::casts() — Method in class Label

Get the attributes that should be cast.

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::casts() — Method in class LabelTree

Get the attributes that should be cast.

LabelTree::canBeDeleted() — Method in class LabelTree

Determines if the label tree can be safely deleted.

LabelTreeVersion::casts() — Method in class LabelTreeVersion

Get the attributes that should be cast.

CleanupImageAnnotations — Class in namespace Biigle\Listeners
CleanupImageThumbnails — Class in namespace Biigle\Listeners
CleanupImageTiles — Class in namespace Biigle\Listeners
CleanupVideoAnnotations — Class in namespace Biigle\Listeners
CleanupVideoThumbnails — Class in namespace Biigle\Listeners
CreateRedisLogger — Class in namespace Biigle\Logging
$ LogManager#channel — Property in class LogManager

The default logging channel.

$ AnnotationAssistanceRequest#casts — Property 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

NfdiLoginController::callback() — Method in class NfdiLoginController

Handle the authentication response

ColorSortServiceProvider — Class in namespace Biigle\Modules\ColorSort
ComputeNewSequence — Class in namespace Biigle\Modules\ColorSort\Jobs
$ Sequence#casts — Property in class Sequence

The attributes that should be casted to native types.

Config — Class in namespace Biigle\Modules\Demo\Console\Commands
Citations — Class in namespace Biigle\Modules\Kpis
CountCitations — Class in namespace Biigle\Modules\Kpis\Console\Commands
CountUniqueUser — Class in namespace Biigle\Modules\Kpis\Console\Commands
CountUser — Class in namespace Biigle\Modules\Kpis\Console\Commands
Config — Class 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.

ComputeImage — Class in namespace Biigle\Modules\Laserpoints\Http\Requests
ComputeVolume — Class 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#casts — Property in class AnnotationCandidateFeatureVector

The attributes that should be casted to native types.

ContinueMaiaJob — Class in namespace Biigle\Modules\Maia\Http\Requests
$ UpdateAnnotationCandidate#candidate — Property in class UpdateAnnotationCandidate

The annotation candidate to update

ConvertAnnotationCandidates — Class 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#casts — Property in class MaiaAnnotation

The attributes that should be casted to native types.

$ MaiaJob#casts — Property in class MaiaJob

The attributes that should be casted to native types.

$ TrainingProposal#casts — Property in class TrainingProposal

The attributes that should be casted to native types.

$ TrainingProposalFeatureVector#casts — Property in class TrainingProposalFeatureVector

The attributes that should be casted to native types.

$ Annotation#category_id — Property in class Annotation
Annotation::create() — Method in class Annotation
Category — Class in namespace Biigle\Modules\MetadataCoco
Category::create() — Method in class Category
Coco — Class in namespace Biigle\Modules\MetadataCoco
$ Coco#categories — Property in class Coco
Coco::createFromPath() — Method in class Coco
Coco::create() — Method in class Coco
CocoParser — Class in namespace Biigle\Modules\MetadataCoco
$ CocoParser#coco — Property in class CocoParser
$ Image#coco_url — Property in class Image
Image::create() — Method in class Image
$ Info#contributor — Property in class Info
Info::create() — Method in class Info
Converter — Class in namespace Biigle\Modules\MetadataIfdo
Converter::convert() — Method in class Converter
Event::casts() — Method in class Event

Get the attributes that should be cast.

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#casts — Property in class Newsletter

The attributes that should be casted to native types.

$ NewsletterSubscriber#casts — Property 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.

PtpJob::cleanupJob() — Method in class PtpJob

Cleanup the existing job from the Volumes attribute

PtpJob::cleanupFiles() — Method in class PtpJob

Cleanup the files that the job might have created

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

Determine if the given user can create a new disk.

$ UserDisk#casts — Property in class UserDisk

The attributes that should be cast.

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

Show the view to create a new storage request.

$ StoreStorageRequestFile#chunkOrFileExists — Property in class StoreStorageRequestFile
$ UpdateStorageRequest#chunkedFiles — Property in class UpdateStorageRequest

Chunked files of a stroage request.

$ DeleteStorageRequestFile#chunks — Property 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#casts — Property in class StorageRequest

The attributes that should be cast.

$ StorageRequestFile#casts — Property in class StorageRequestFile

The attributes that should be cast.

ChunkedFileStreamPump — Class 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#currentChunk — Property 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.

ReportObserver::creating() — Method in class ReportObserver

Fill the attributes that depend on the source.

VolumeObserver::creating() — Method in class VolumeObserver

A volume must not be created without having a creator.

PendingVolume::casts() — Method in class PendingVolume

Get 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.

CachedPolicy — Class in namespace Biigle\Policies

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

$ CachedPolicy#cache — Property 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::casts() — Method in class ProjectInvitation

Get the attributes that should be cast.

Report::casts() — Method in class Report

Get the attributes that should be cast.

AnnotationPoints::countDistinctPoints() — Method in class AnnotationPoints

Count the number of distinct points.

$ GreaterThan#compare — Property in class GreaterThan

The value to compare.

$ LessThan#compare — Property in class LessThan

The value to compare.

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.

$ WormsAdapter#client — Property 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.

CsvParser — Class in namespace Biigle\Services\MetadataParsing
$ Modules#controllerMixins — Property in class Modules

The controller mixins of every module.

Modules::callControllerMixins() — Method in class Modules

Call all controller mixins registered for a certain controller.

CsvFile — Class in namespace Biigle\Services\Reports
File::close() — Method in class File

Close the file.

CocoReportGenerator — Class in namespace Biigle\Services\Reports\Projects\ImageAnnotations
CsvReportGenerator — Class in namespace Biigle\Services\Reports\Projects\ImageAnnotations
CsvReportGenerator — Class in namespace Biigle\Services\Reports\Projects\ImageLabels
CsvReportGenerator — Class in namespace Biigle\Services\Reports\Projects\VideoAnnotations
CsvReportGenerator — Class in namespace Biigle\Services\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.

CocoReportGenerator — Class in namespace Biigle\Services\Reports\Volumes\ImageAnnotations
CocoReportGenerator::createCsv() — Method in class CocoReportGenerator

Create a CSV file for this report.

CsvReportGenerator — Class in namespace Biigle\Services\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.

CsvReportGenerator — Class in namespace Biigle\Services\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#code — Property in class PythonScriptRunner

Exit code of the exec call.

CsvReportGenerator — Class in namespace Biigle\Services\Reports\Volumes\VideoAnnotations
CsvReportGenerator::createCsv() — Method in class CsvReportGenerator

Create a CSV file for this report.

CsvReportGenerator — Class in namespace Biigle\Services\Reports\Volumes\VideoLabels
CsvReportGenerator::createCsv() — Method in class CsvReportGenerator

Create a CSV file for this report.

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

The registered config resolvers.

CompileFilters — Class in namespace Biigle\Traits
CompileFilters::compileFilterConditions() — Method in class CompileFilters

Compile Largo filter(s) that were requested and add them to the query

User::casts() — Method in class User

Get the attributes that should be cast.

User::checkCanBeDeleted() — Method in class User

Checks if the user can be deleted.

Video::casts() — Method in class Video

Get the attributes that should be cast.

VideoAnnotation::casts() — Method in class VideoAnnotation

Get the attributes that should be cast.

VideoAnnotationLabelFeatureVector::casts() — Method in class VideoAnnotationLabelFeatureVector

Get the attributes that should be cast.

Volume::casts() — Method in class Volume

Get the attributes that should be cast.

Volume::creator() — Method in class Volume

The user that created the volume.

VolumeFileLabel::casts() — Method in class VolumeFileLabel

Get the attributes that should be cast.

CreateAnnotationAssistanceRequestsTable — Class in namespace [Global Namespace]
CreateCopriaColorSortSequencesTable — Class in namespace [Global Namespace]
CreateGeoOverlaysTable — Class in namespace [Global Namespace]
CreateIndices — Class in namespace [Global Namespace]

D

AddAnnotationAssistanceRequestsIndex::down() — Method in class AddAnnotationAssistanceRequestsIndex

Reverse the migrations.

AnnotationAssistanceRequestsNotification::down() — Method in class AnnotationAssistanceRequestsNotification

Reverse the migrations.

$ Apidoc#description — Property in class Apidoc

The console command description.

$ GenerateMissing#description — Property in class GenerateMissing

The console command description.

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

The console command description.

$ LabelbotCreateIndex#description — Property in class LabelbotCreateIndex

The console command description.

$ LabelbotIndexProgress#description — Property in class LabelbotIndexProgress

The console command description.

$ MigrateTiledImages#description — Property in class MigrateTiledImages

The console command description.

$ NewUser#description — Property in class NewUser

The console command description.

$ PruneNotifications#description — Property in class PruneNotifications

The console command description.

$ SyncPrune#description — Property in class SyncPrune

The console command description.

$ SyncUuids#description — Property in class SyncUuids

The console command description.

$ UpdateVideoMetadata#description — Property in class UpdateVideoMetadata

The console command description.

$ UpdateVideoMetadata#dryRun — Property in class UpdateVideoMetadata

Is this a dry run?

$ UpdateVolumeUrls#description — Property in class UpdateVolumeUrls

The console command description.

$ UpdateVolumeUrls#dryRun — Property in class UpdateVolumeUrls

Is this a dry run?

$ UpdateVolumeUrls#disks — Property in class UpdateVolumeUrls

Available storage disks.

$ Handler#dontFlash — Property in class Handler

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

$ PruneFileCache#description — Property 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

Disconnect 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.

ImportController::destroy() — Method in class ImportController
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 from the specified project.

ProjectUserController::destroy() — Method in class ProjectUserController

Removes a user from the specified project.

ProjectVolumeController::destroy() — Method in class ProjectVolumeController

Removes the specified volume from the specified project.

ReportsController::destroy() — Method in class ReportsController

Delete a report.

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.

ExportAreaController::destroy() — Method in class ExportAreaController

Remove the export area.

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.

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

Show a documentation article.

DestroyAnnotationSession — Class in namespace Biigle\Http\Requests
DestroyImage — Class in namespace Biigle\Http\Requests
DestroyLabel — Class in namespace Biigle\Http\Requests
DestroyLabelTree — Class in namespace Biigle\Http\Requests
DestroyLabelTreeUser — Class in namespace Biigle\Http\Requests
DestroyLabelTreeVersion — Class in namespace Biigle\Http\Requests
DestroyOwnUser — Class in namespace Biigle\Http\Requests
DestroyPinnedProject — Class in namespace Biigle\Http\Requests
DestroyProjectUser — Class in namespace Biigle\Http\Requests
DestroyUser — Class in namespace Biigle\Http\Requests
$ DestroyUser#destroyUser — Property in class DestroyUser

The user to delete.

DestroyVideo — Class in namespace Biigle\Http\Requests
DestroyVideoAnnotationLabel — Class in namespace Biigle\Http\Requests
DestroyVolumeFile — Class in namespace Biigle\Http\Requests
$ StoreLargoSession#dismissedImageAnnotations — Property in class StoreLargoSession

The dismissed_image_annotations request attribute.

$ StoreLargoSession#dismissedVideoAnnotations — Property in class StoreLargoSession

The dismissed_video_annotations request attribute.

$ Ifdo#debug — Property in class Ifdo
$ ApplyLargoSession#dismissedImageAnnotations — Property in class ApplyLargoSession

Array of all dismissed image annotation IDs for each label.

$ ApplyLargoSession#dismissedVideoAnnotations — Property 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.

DeleteVolume — Class in namespace Biigle\Jobs
$ MigrateTiledImage#disk — Property in class MigrateTiledImage

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

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.

TrackObject::decrementCacheValue() — Method in class TrackObject

Decrement the count of object tracking jobs.

LabelTree::detachUnauthorizedProjects() — Method in class LabelTree

Detaches all projects that are not among the authorized projects.

$ Publish#description — Property 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.

NfdiLoginIdFactory::definition() — Method in class NfdiLoginIdFactory

Define the model's default state.

$ Publish#description — Property in class Publish

The console command description.

VolumeColorSortSequenceController::destroy() — Method in class VolumeColorSortSequenceController

Delete a color sort sequence.

ImageObserver::deleted() — Method in class ImageObserver

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

$ Config#description — Property in class Config

The console command description.

DemoServiceProvider — Class in namespace Biigle\Modules\Demo
DemoProjectController — Class in namespace Biigle\Modules\Demo\Http\Controllers\Api
DenbiServiceServiceProvider — Class in namespace Biigle\Modules\DenbiService
$ Publish#description — Property in class Publish

The console command description.

$ CountCitations#description — Property in class CountCitations

The console command description.

$ CountUniqueUser#description — Property in class CountUniqueUser

The console command description.

$ CountUser#description — Property in class CountUser

The console command description.

DetermineStorageUsage — Class in namespace Biigle\Modules\Kpis\Console\Commands
$ DetermineStorageUsage#description — Property in class DetermineStorageUsage

The console command description.

$ SubmitToScorpion#description — Property in class SubmitToScorpion

The console command description.

$ Config#description — Property in class Config

The console command description.

$ Publish#description — Property in class Publish

The console command description.

$ Job#distance — Property in class Job

Distance between laser points im cm to use for computation.

$ ProcessDelphiJob#distance — Property in class ProcessDelphiJob

Distance between laser points im cm to use for computation.

$ ProcessManualJob#distance — Property in class ProcessManualJob

Distance between laser points im cm to use for computation.

DelphiApply — Class in namespace Biigle\Modules\Laserpoints\Support

Wrapper for the Delphi laser points detection script.

DelphiGather — Class in namespace Biigle\Modules\Laserpoints\Support

Wrapper for the Delphi gather script.

Detect — Class in namespace Biigle\Modules\Laserpoints\Support

Wrapper for the manual laser points detection script.

$ PruneOldEmbeddings#description — Property in class PruneOldEmbeddings

The console command description.

GenerateEmbedding::decrementPendingJobsCounter() — Method in class GenerateEmbedding

Decrement the pending jobs counter for the user.

$ MigratePatchStorage#description — Property in class MigratePatchStorage

The console command description.

$ MigratePatchStorage#dryRun — Property in class MigratePatchStorage

Specifies if this is a dry run.

$ Publish#description — Property 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.

DestroyMaiaJob — Class in namespace Biigle\Modules\Maia\Http\Requests
DeleteAnnotationPatchChunk — Class in namespace Biigle\Modules\Maia\Jobs
$ DeleteAnnotationPatchChunk#disk — Property in class DeleteAnnotationPatchChunk

Storage disk to delete files in.

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

Delete MAIA annotations form the specified storage disk.

DetectionJob — Class in namespace Biigle\Modules\Maia\Jobs
DetectionJob::dispatchFailure() — Method in class DetectionJob

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

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.

DispatchMaiaJob — Class in namespace Biigle\Modules\Maia\Listeners
DispatchObjectDetection — Class in namespace Biigle\Modules\Maia\Listeners
$ MaiaJob#dispatchesEvents — Property 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.

Annotation::detectShape() — Method in class Annotation
$ Image#date_captured — Property in class Image
$ Info#description — Property in class Info
$ Info#date_created — Property in class Info
EventFactory::definition() — Method in class EventFactory

Define the model's default state.

$ PruneStaleSubscribers#description — Property 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.

DestroyNewsletterSubscriber — Class 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.

$ CheckExpiredUserDisks#description — Property in class CheckExpiredUserDisks

The console command description.

$ PruneExpiredUserDisks#description — Property in class PruneExpiredUserDisks

The console command description.

$ RefreshDCacheTokens#description — Property in class RefreshDCacheTokens

The console command description.

UserDiskFactory::definition() — Method in class UserDiskFactory

Define the model's default state.

UserDiskController::dCacheCallback() — Method in class UserDiskController

Handle the dCache authentication response.

UserDiskController::destroy() — Method in class UserDiskController

Delete a storage disk

UserDiskController::dCacheAuthFlow() — Method in class UserDiskController

Start the authentication flow for dCache.

$ ExtendUserDisk#disk — Property in class ExtendUserDisk

Storage disk that should be approved.

$ UpdateUserDisk#disk — Property in class UpdateUserDisk

The user disk that should be updated.

$ UserDiskExpiresSoon#disk — Property in class UserDiskExpiresSoon

The storage disk that was confirmed

UserDiskPolicy::destroy() — Method in class UserDiskPolicy

Determine if the given user can destroy the storage disk.

$ CheckExpiredStorageRequests#description — Property in class CheckExpiredStorageRequests

The console command description.

$ PruneExpiredStorageRequests#description — Property in class PruneExpiredStorageRequests

The console command description.

$ PruneStaleStorageRequests#description — Property 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

DestroyStorageRequestDirectory — Class in namespace Biigle\Modules\UserStorage\Http\Requests
DestroyStorageRequestFile — Class in namespace Biigle\Modules\UserStorage\Http\Requests
DeleteStorageRequestDirectory — Class in namespace Biigle\Modules\UserStorage\Jobs
DeleteStorageRequestFile — Class in namespace Biigle\Modules\UserStorage\Jobs
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#disk — Property in class ChunkedFileStreamPump

Storage disk to read chunks from.

AnnotationObserver::deleting() — Method in class AnnotationObserver

Handle the event of deleting a single annotation.

ImageObserver::deleting() — Method in class ImageObserver

Handle the event of deleting a single image.

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.

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.

VolumeObserver::deleted() — Method in class VolumeObserver

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

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.

ReportPolicy::destroy() — Method in class ReportPolicy

Determine if the given report can be destroyed 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.

Report::deleteFile() — Method in class Report

Delete the file that belongs to this report.

$ VideoAnnotationFrames#duration — Property in class VideoAnnotationFrames

Duration of the video in seconds. Frame times are not checked against the duration if this is null (e.g. because the duration is not known yet).

$ ArchiveManager#disk — Property in class ArchiveManager

Storage disk for uploaded import archives.

ArchiveManager::delete() — Method in class ArchiveManager

Delete the files of an import.

$ CsvFile#delimiter — Property in class CsvFile

Field delimiter.

File::delete() — Method in class File

Delete the file.

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

Reverse the migrations.

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.

InitializeMaiaTables::down() — Method in class InitializeMaiaTables

Reverse the migrations.

RemoveGeoOverlaysTable::down() — Method in class RemoveGeoOverlaysTable

Reverse the migrations.

RenameTable::down() — Method in class RenameTable

Reverse the migrations.

RenameTransectColumn::down() — Method in class RenameTransectColumn

Reverse the migrations.

UpdateJobParams::down() — Method in class UpdateJobParams

Reverse the migrations.

E

Annotation::estimatedCount() — Method in class Annotation

Get an estimated count of all annotations from pg_class statistics.

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::ensureProcessLock() — Method in class FileCache

Acquire the lock that signals this process is alive, holding it for the lifetime of the process.

FileCache::ensureDirExists() — Method in class FileCache

Creates the directory if it doesn't exist yet.

FileCacheFake::exists() — Method in class FileCacheFake

Check if a file exists.

ExportAreaController — Class in namespace Biigle\Http\Controllers\Api\Volumes
ExportController — Class in namespace Biigle\Http\Controllers\Views\Admin
UsersController::edit() — Method in class UsersController

Shows the admin edit user page.

VolumeController::edit() — Method in class VolumeController

Shows the volume edit page.

EncryptCookies — Class in namespace Biigle\Http\Middleware
$ EncryptCookies#except — Property in class EncryptCookies

The names of the cookies that should not be encrypted.

$ PreventRequestForgery#except — Property in class PreventRequestForgery

The URIs that should be excluded from CSRF verification.

$ PreventRequestsDuringMaintenance#except — Property in class PreventRequestsDuringMaintenance

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

$ TrimStrings#except — Property in class TrimStrings

The names of the attributes that should not be trimmed.

$ UpdateUserActivity#except — Property in class UpdateUserActivity

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

$ ValidateSignature#except — Property in class ValidateSignature

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

$ StoreLargoSession#emptyRequest — Property 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.

ProcessNewVideo::extractImagesfromVideo() — Method in class ProcessNewVideo

Extract images from video.

Sort::execute() — Method in class Sort

Compute a color sort sequence.

EnsureTokenIsValid — Class in namespace Biigle\Modules\Kpis\Http\Middleware
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.

EmbeddingAvailable — Class in namespace Biigle\Modules\MagicSam\Events
EmbeddingFailed — Class in namespace Biigle\Modules\MagicSam\Events
ImageEmbeddingController::expandBbox() — Method in class ImageEmbeddingController

Expand bbox to a square with at least the minimum model input size.

DetectionJob::ensureDirectory() — Method in class DetectionJob

Creates the specified directory if it does not exist.

Annotation::euclidean_distance() — Method in class Annotation
Converter::extractIfdoLabels() — Method in class Converter
Converter::extractIfdoAnnotators() — Method in class Converter
EventFactory — Class in namespace Biigle\Modules\Metrics\Database\Factories
Event — Class in namespace Biigle\Modules\Metrics
EventsController — Class in namespace Biigle\Modules\Metrics\Http\Controllers
AdminController::edit() — Method in class AdminController

Shows the edit newsletter view.

EmailVerificationRequest — Class in namespace Biigle\Modules\Newsletter\Http\Requests
UserDiskController::extend() — Method in class UserDiskController

Extend a storage disk

ExtendUserDisk — Class 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

ExtendStorageRequest — Class 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.

EventServiceProvider — Class 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
Export — Class in namespace Biigle\Services\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.

LabelBotService::enforceRateLimit() — Method in class LabelBotService
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.

$ CsvFile#enclosure — Property in class CsvFile

String enclosure character.

$ CsvFile#escape_char — Property in class CsvFile

Escape character.

ExtendedReportGenerator — Class in namespace Biigle\Services\Reports\Projects\ImageAnnotations
$ ProjectReportGenerator#extension — Property in class ProjectReportGenerator

File extension of the report file.

$ ReportGenerator#extension — Property 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#extension — Property in class IfdoReportGenerator

File extension of the report file.

$ AbundanceReportGenerator#extension — Property in class AbundanceReportGenerator

File extension of the report file.

$ AnnotationLocationReportGenerator#extension — Property 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#extension — Property in class AreaReportGenerator

File extension of the report file.

$ BasicReportGenerator#extension — Property in class BasicReportGenerator

File extension of the report file.

$ CocoReportGenerator#extension — Property in class CocoReportGenerator

File extension of the report file.

$ CsvReportGenerator#extension — Property in class CsvReportGenerator

File extension of the report file.

ExtendedReportGenerator — Class in namespace Biigle\Services\Reports\Volumes\ImageAnnotations
$ ExtendedReportGenerator#extension — Property in class ExtendedReportGenerator

File extension of the report file.

$ FullReportGenerator#extension — Property in class FullReportGenerator

File extension of the report file.

$ ImageLocationReportGenerator#extension — Property in class ImageLocationReportGenerator

File extension of the report file.

$ BasicReportGenerator#extension — Property in class BasicReportGenerator

File extension of the report file.

$ CsvReportGenerator#extension — Property in class CsvReportGenerator

File extension of the report file.

$ ImageLocationReportGenerator#extension — Property in class ImageLocationReportGenerator

File extension of the report file.

$ CsvReportGenerator#extension — Property in class CsvReportGenerator

File extension of the report file.

$ CsvReportGenerator#extension — Property 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.

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.

$ GenerateMissing#force — Property in class GenerateMissing

Regenerate data without checking if it is missing.

$ UpdateVideoMetadata#ffprobe — Property in class UpdateVideoMetadata

The FFProbe video instance.

LabelSourceAdapterContract::find() — Method in class LabelSourceAdapterContract

Find a label in the label source.

FederatedSearchInstance — Class in namespace Biigle
FederatedSearchModel — Class in namespace Biigle
File — Class in namespace Biigle\FileCache\Contracts
FileCache — Class in namespace Biigle\FileCache\Contracts
FileLockedException — Class in namespace Biigle\FileCache\Exceptions
FileCache — Class in namespace Biigle\FileCache\Facades
FileCache::fake() — Method in class FileCache

Use testing instance.

FileCache — Class in namespace Biigle\FileCache

The file cache.

$ FileCache#files — Property in class FileCache

The Filesytem instance to use

FileCacheServiceProvider — Class in namespace Biigle\FileCache
FileCacheFake — Class in namespace Biigle\FileCache\Testing
Controller::fuzzyRedirect() — Method in class Controller

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

FederatedSearchIndexController — Class in namespace Biigle\Http\Controllers\Api
FederatedSearchInstanceController — Class in namespace Biigle\Http\Controllers\Api
LabelSourceController::find() — Method in class LabelSourceController

Find labels from a label source.

FilterImageAnnotationsByLabelController — Class in namespace Biigle\Http\Controllers\Api\Projects
FilterVideoAnnotationsByLabelController — Class in namespace Biigle\Http\Controllers\Api\Projects
UserController::find() — Method in class UserController

Finds all users with firstnames or lastnames like $pattern.

FileLabelsController — Class in namespace Biigle\Http\Controllers\Api\Volumes
FilenamesController — Class in namespace Biigle\Http\Controllers\Api\Volumes
FilterImageAnnotationsByLabelController — Class in namespace Biigle\Http\Controllers\Api\Volumes
FilterVideoAnnotationsByLabelController — Class in namespace Biigle\Http\Controllers\Api\Volumes
FileLabelController — Class in namespace Biigle\Http\Controllers\Api\Volumes\Filters
FileLabelUserController — Class in namespace Biigle\Http\Controllers\Api\Volumes\Filters
FilenameController — Class in namespace Biigle\Http\Controllers\Api\Volumes\Filters
ForgotPasswordController — Class in namespace Biigle\Http\Controllers\Auth
FederatedSearchController — Class in namespace Biigle\Http\Controllers\Views\Admin
$ DestroyVolumeFile#file — Property in class DestroyVolumeFile

The file that should be deleted.

$ LinkVideoAnnotation#firstAnnotation — Property in class LinkVideoAnnotation

The first annotation that should be linked.

$ StoreLargoSession#force — Property in class StoreLargoSession

The force request attribute.

$ StoreVolumeFileLabel#file — Property in class StoreVolumeFileLabel

The file to which the label should be attached.

Ifdo::fromFile() — Method in class Ifdo
Ifdo::fromString() — Method in class Ifdo
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.

$ ApplyLargoSession#force — Property in class ApplyLargoSession

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

ApplyLargoSession::failed() — Method in class ApplyLargoSession

Handle a job failure.

$ CreateNewImagesOrVideos#filenames — Property 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#ffmpegVideo — Property in class ProcessNewVideo

The FFMpeg video instance.

$ ProcessNewVideo#ffprobe — Property in class ProcessNewVideo

The FFProbe instance.

$ LsloginId#fillable — Property in class LsloginId

The attributes that are mass assignable.

$ NfdiLoginId#fillable — Property in class NfdiLoginId

The attributes that are mass assignable.

ComputeNewSequence::failed() — Method in class ComputeNewSequence

Handle a job failure.

FileCoordinatesController — Class in namespace Biigle\Modules\Geo\Http\Controllers\Api
DelphiGather::finish() — Method in class DelphiGather

Finish the Delphi preprocessing after all images have been processed.

FiltersInvalidLaserPoints — Class 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#filename — Property in class EmbeddingAvailable

The embedding filename on the storage disk.

ImageEmbeddingController::findCoveringEmbedding() — Method in class ImageEmbeddingController

Find an existing embedding that covers the requested bbox with resolution similar to the target expanded bbox.

$ AnnotationCandidateFeatureVector#fillable — Property in class AnnotationCandidateFeatureVector

The attributes that are mass assignable.

StoreMaiaJob::failedAuthorization() — Method in class StoreMaiaJob

Handle a failed authorization attempt.

$ DeleteAnnotationPatchChunk#files — Property 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#fillable — Property in class TrainingProposalFeatureVector

The attributes that are mass assignable.

$ Image#file_name — Property in class Image
$ Image#flickr_url — Property in class Image
$ Event#fillable — Property in class Event

The attributes that are mass assignable.

EmailVerificationRequest::fulfill() — Method in class EmailVerificationRequest

Fulfill the email verification request.

$ Newsletter#fillable — Property in class Newsletter

The attributes that are mass assignable.

$ NewsletterSubscriber#fillable — Property in class NewsletterSubscriber

The attributes that are mass assignable.

PtpJob::failed() — Method in class PtpJob

Cleanup the Job if failed

$ UserDisk#fillable — Property in class UserDisk

The attributes that are mass assignable.

$ DestroyStorageRequestFile#file — Property in class DestroyStorageRequestFile

Storage request file that should be deleted.

$ AssembleChunkedFile#file — Property in class AssembleChunkedFile

The file to assemble.

$ DeleteStorageRequestFile#fileId — Property in class DeleteStorageRequestFile

ID of the file that should be deleted

FilePrefix — Class in namespace Biigle\Modules\UserStorage\Rules
$ StorageRequest#fillable — Property in class StorageRequest

The attributes that are mass assignable.

StorageRequest::files() — Method in class StorageRequest

The files belonging to this storage request.

$ StorageRequestFile#fillable — Property in class StorageRequestFile

The attributes that are mass assignable.

FederatedSearchInstancePolicy — Class 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.

ImageMetadata::fileMetadataPasses() — Method in class ImageMetadata
$ VideoAnnotationGaps#frames — Property in class VideoAnnotationGaps

Key frame times of the annotation, one for each entry of the points array. May contain null values to represent gaps in the annotation.

$ VolumeFileUnique#files — Property in class VolumeFileUnique

The filenames that already exist.

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.

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.

FileMetadata — Class in namespace Biigle\Services\MetadataParsing
$ MetadataParser#fileObject — Property in class MetadataParser
$ VideoMetadata#frames — Property in class VideoMetadata
$ VolumeMetadata#files — Property in class VolumeMetadata
File — Class in namespace Biigle\Services\Reports
$ AbundanceReportGenerator#filename — Property in class AbundanceReportGenerator

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

$ AnnotationLocationReportGenerator#filename — Property in class AnnotationLocationReportGenerator

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

$ AreaReportGenerator#filename — Property in class AreaReportGenerator

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

$ BasicReportGenerator#filename — Property in class BasicReportGenerator

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

$ CocoReportGenerator#filename — Property in class CocoReportGenerator

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

$ CsvReportGenerator#filename — Property in class CsvReportGenerator

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

$ ExtendedReportGenerator#filename — Property in class ExtendedReportGenerator

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

FullReportGenerator — Class in namespace Biigle\Services\Reports\Projects\ImageAnnotations
$ FullReportGenerator#filename — Property in class FullReportGenerator

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

$ ImageLocationReportGenerator#filename — Property in class ImageLocationReportGenerator

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

$ ImageIfdoReportGenerator#filename — Property in class ImageIfdoReportGenerator

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

$ BasicReportGenerator#filename — Property in class BasicReportGenerator

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

$ CsvReportGenerator#filename — Property in class CsvReportGenerator

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

$ ImageLocationReportGenerator#filename — Property in class ImageLocationReportGenerator

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

$ CsvReportGenerator#filename — Property in class CsvReportGenerator

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

$ VideoIfdoReportGenerator#filename — Property in class VideoIfdoReportGenerator

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

$ CsvReportGenerator#filename — Property in class CsvReportGenerator

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

$ ReportGenerator#filename — Property in class ReportGenerator

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

$ AbundanceReportGenerator#filename — Property in class AbundanceReportGenerator

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

$ AnnotationLocationReportGenerator#filename — Property in class AnnotationLocationReportGenerator

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

$ AreaReportGenerator#filename — Property in class AreaReportGenerator

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

$ BasicReportGenerator#filename — Property in class BasicReportGenerator

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

$ CocoReportGenerator#filename — Property in class CocoReportGenerator

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

$ CsvReportGenerator#filename — Property in class CsvReportGenerator

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

$ ExtendedReportGenerator#filename — Property in class ExtendedReportGenerator

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

FullReportGenerator — Class in namespace Biigle\Services\Reports\Volumes\ImageAnnotations
$ FullReportGenerator#filename — Property in class FullReportGenerator

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

$ ImageLocationReportGenerator#filename — Property in class ImageLocationReportGenerator

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

$ ImageIfdoReportGenerator#filename — Property in class ImageIfdoReportGenerator

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

$ BasicReportGenerator#filename — Property in class BasicReportGenerator

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

$ CsvReportGenerator#filename — Property in class CsvReportGenerator

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

$ ImageLocationReportGenerator#filename — Property in class ImageLocationReportGenerator

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

$ CsvReportGenerator#filename — Property in class CsvReportGenerator

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

$ VideoIfdoReportGenerator#filename — Property in class VideoIfdoReportGenerator

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

$ CsvReportGenerator#filename — Property in class CsvReportGenerator

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

FilesystemManager — Class in namespace Biigle\Support
User::federatedSearchModels() — Method in class User

The federated search models that the user can access

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::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#filename — Property 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.

Annotation::getId() — Method in class Annotation

Get the ID of the annotation.

Annotation::getLabelBOTLabelsAttribute() — Method in class Annotation

Get the LabelBOT suggested labels.

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.

GenerateMissing — Class in namespace Biigle\Console\Commands
SyncUuids::generateOutput() — Method in class SyncUuids

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

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.

Annotation::getId() — Method in class Annotation

Get the ID of the annotation.

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.

GenericFile — Class 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!

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.

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.

GetUsersWithAnnotations — Class in namespace Biigle\Http\Controllers\Api\Projects
ProjectAnnotationLabels::getProjectAnnotationLabelCounts() — Method in class ProjectAnnotationLabels

Get all image labels and annotation count for a given project

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.

GetUsersWithAnnotations — Class in namespace Biigle\Http\Controllers\Api\Volumes
VolumeAnnotationLabels::getVolumeAnnotationLabels() — Method in class VolumeAnnotationLabels

Get all annotation labels and annotation count for a given volume

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).

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.

StoreReport::getOptions() — Method in class StoreReport

Get the options for the new report.

StoreVideoLabel::getFileModel() — Method in class StoreVideoLabel

Get the file model class;

StoreVolumeFileLabel::getFileModel() — Method in class StoreVolumeFileLabel

Get the file model class;

StoreVolumeLargoSession::getAvailableLabelTrees() — Method in class StoreVolumeLargoSession

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

StoreVolumeReport::getOptions() — Method in class StoreVolumeReport

Get the options for the new report.

UpdateImageAnnotation::getPoints() — Method in class UpdateImageAnnotation

Get the new points of the annotation.

UpdateImageAnnotation::getShapeId() — Method in class UpdateImageAnnotation

Get the new shape ID of the annotation.

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.

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.

GenerateFeatureVectors — Class in namespace Biigle\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::generateAnnotationBoxes() — Method in class GenerateFeatureVectors
GenerateFeatureVectors::getCropBufferForPyworker() — Method in class GenerateFeatureVectors

Get the byte string of the cropped and resized patch for the Python worker.

GenerateFederatedSearchIndex — Class 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.

GenerateReportJob — Class in namespace Biigle\Jobs
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.

InitializeFeatureVectorChunk::getVipsImageForPyworker() — Method in class InitializeFeatureVectorChunk

Get the vips image instance for submission to the Python worker for feature vectors.

ProcessAnnotatedFile::getQueueConfigKey() — Method in class ProcessAnnotatedFile

Get the config key of the queue that should be used to process this job.

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::getBaseAnnotationQuery() — Method in class ProcessAnnotatedFile

Get the query builder for all annotations of the file of this job.

ProcessAnnotatedFile::getAnnotationQuery() — Method in class ProcessAnnotatedFile

Get the query builder for the annotations of the file that should be processed.

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

ProcessAnnotatedFile::getVipsImageForPyworker() — Method in class ProcessAnnotatedFile

Get the vips image instance for submission to the Python worker for feature vectors.

ProcessAnnotatedImage::getVipsImage() — Method in class ProcessAnnotatedImage

Get the vips image instance.

ProcessAnnotatedImage::getBaseAnnotationQuery() — Method in class ProcessAnnotatedImage

Get the query builder for all annotations of the file of this job.

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::getBaseAnnotationQuery() — Method in class ProcessAnnotatedVideo

Get the query builder for all annotations of the file of this job.

ProcessAnnotatedVideo::getQueueConfigKey() — Method in class ProcessAnnotatedVideo

Get the config key of the queue that should be used to process this job.

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::generateVideoThumbnails() — Method in class ProcessNewVideo
ProcessNewVideo::generateSnapshots() — Method in class ProcessNewVideo

Run the actual command to extract snapshots from the video. Separated into its own method for easier testing.

ProcessNewVideo::generateThumbnail() — Method in class ProcessNewVideo

Generate a thumbnail from a video snapshot. Separated into its own method for easier testing.

TileSingleImage::generateTiles() — Method in class TileSingleImage

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

TileSingleImage::getClient() — Method in class TileSingleImage

Returns the S3Client of the s3 storage.

TileSingleImage::getBucket() — Method in class TileSingleImage

Returns the s3 bucket name.

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.

GeoServiceProvider — Class in namespace Biigle\Modules\Geo
Citations::getCitations() — Method in class Citations
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
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#gatherFile — Property 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.

ImageEmbeddingController::getResolutionRange() — Method in class ImageEmbeddingController

Calculate resolution range for matching embeddings within threshold.

StoreImageEmbeddingRequest::getImage() — Method in class StoreImageEmbeddingRequest

Get the image instance.

StoreImageEmbeddingRequest::getBbox() — Method in class StoreImageEmbeddingRequest

Get the validated bbox.

GenerateEmbedding — Class in namespace Biigle\Modules\MagicSam\Jobs
GenerateEmbedding::getPendingJobsCacheKey() — Method in class GenerateEmbedding

Get the cache key for tracking pending jobs for a user.

GenerateEmbedding::getFilename() — Method in class GenerateEmbedding

Get the filename for the embedding.

GenerateEmbedding::generateEmbedding() — Method in class GenerateEmbedding

Generate the embedding.

GenerateEmbedding::getVipsImageFromFullImage() — Method in class GenerateEmbedding

Load the full image, crop to bbox if set, and resize for the Python worker.

GenerateEmbedding::getMaxZoomLevel() — Method in class GenerateEmbedding

Calculate the maximum Zoomify zoom level (full resolution) for this image.

GenerateEmbedding::getVipsImageFromZoomifyTiles() — Method in class GenerateEmbedding

Load and stitch Zoomify tiles for the bbox and resize for the Python worker.

GenericImage — Class 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.

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::getBaseAnnotationQuery() — Method in class ProcessNoveltyDetectedImage

Get the query builder for all annotations of the file of this job.

ProcessObjectDetectedImage::getBaseAnnotationQuery() — Method in class ProcessObjectDetectedImage

Get the query builder for all annotations of the file of this job.

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.

MaiaAnnotation::getId() — Method in class MaiaAnnotation

Get the ID of the annotation.

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.

$ Annotation#groupedPoints — Property in class Annotation
Annotation::getLabel() — Method in class Annotation
Annotation::getLabelAndUsers() — Method in class Annotation
Annotation::getPoints() — Method in class Annotation
Annotation::getGroupedPoints() — Method in class Annotation
Annotation::getCirclePoints() — Method in class Annotation
Annotation::getShape() — Method in class Annotation
Coco::getCocoUser() — Method in class Coco
CocoParser::getKnownMimeTypes() — Method in class CocoParser

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

CocoParser::getName() — Method in class CocoParser

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

CocoParser::getCoco() — Method in class CocoParser
CocoParser::getMetadata() — Method in class CocoParser

Get a filled VolumeMetadata object based on the file.

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.

Event::getUpdatedAtColumn() — Method in class Event

Get the name of the "updated at" column.

EmailVerificationRequest::getUserResolver() — Method in class EmailVerificationRequest

Get the user resolver callback.

PtpJob::generateInputFile() — Method in class PtpJob

Generate the input File containing data for the execution of the job

PtpJob::generateImageInputFile() — Method in class PtpJob

Generate the input file containing image id and path data

PtpJob::getCsvFile() — Method in class PtpJob

Open A CSV file.

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.

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.

PendingVolume::getMetadataFileDisk() — Method in class PendingVolume
{@inheritdoc}
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.

QueueSize::getQueuesToRecord() — Method in class QueueSize

Get the queues (with connections) that should be recoeded.

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).

Role::guest() — Method in class Role
Role::guestId() — Method in class Role
AnnotationPoints::getErrorMessage() — Method in class AnnotationPoints

Get the validation error message for a points array.

GreaterThan — Class in namespace Biigle\Rules
VideoAnnotationFrames::getErrorMessage() — Method in class VideoAnnotationFrames

Get the validation error message for a frames array.

VideoAnnotationGaps::getErrorMessage() — Method in class VideoAnnotationGaps

Get the validation error message for a points array.

VideoAnnotationPoints::getErrorMessage() — Method in class VideoAnnotationPoints

Get the validation error message for a points array.

ApiGuard::getTokenForRequest() — Method in class ApiGuard

Get the token for the current request.

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.

LabelBotService::getLabelsForAnnotation() — Method in class LabelBotService

Get the suggested labels of a new annotation either by using a label_id or a feature_vector from the request.

LabelBotService::getLabelTreeIds() — Method in class LabelBotService

Get all label trees that are used by all projects which are visible to the user.

LabelBotService::getFeatureVectorModelFor() — Method in class LabelBotService

Get the correct model class for the annotation type.

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.

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.

AbundanceReportGenerator::getImageAnnotationLabelQuery() — Method in class AbundanceReportGenerator

Construct a join query for (filtered) images, image annotations, image annotation labels, and labels

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.

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

Get a dynamic JSON attribute.

HasMetadataFile::getMetadataFileDisk() — Method in class HasMetadataFile

Get the name of the disk to store metadata files.

HasMetadataFile::getMetadata() — Method in class HasMetadataFile
RestrictsToExportArea::getSkipIds() — Method in class RestrictsToExportArea

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

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).

User::getHasNoRateLimitAttribute() — Method in class User

Determines if the API rate limit applies to the 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::getExportAreaAttribute() — Method in class Volume

Return the dynamic attribute for the export area.

Volume::getMetadataFileDisk() — Method in class Volume
{@inheritdoc}
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.

WebDAVAdapter::getUrl() — Method in class WebDAVAdapter
WebDavServiceProvider::getWebDavAdapter() — Method in class WebDavServiceProvider

Build and return the WebDAV adapter. This simplifies extension by other packages.

H

Apidoc::handle() — Method in class Apidoc

Handle 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.

LabelbotCreateIndex::handle() — Method in class LabelbotCreateIndex

Execute the console command.

LabelbotIndexProgress::handle() — Method in class LabelbotIndexProgress

Execute the console 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.

SyncPrune::handle() — Method in class SyncPrune

Execute the command.

SyncUuids::handle() — Method in class SyncUuids

Execute the command.

SyncUuids::handleSync() — Method in class SyncUuids

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

UpdateVideoMetadata::handle() — Method in class UpdateVideoMetadata

Handle the command.

UpdateVolumeUrls::handle() — Method in class UpdateVolumeUrls

Handle the command.

Handler — Class in namespace Biigle\Exceptions
PruneFileCache::handle() — Method in class PruneFileCache

Execute the console command.

ClearFileCache::handle() — Method in class ClearFileCache

Handle the event.

ImportController::hideUserCredentials() — Method in class ImportController

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

HeartbeatController — Class 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.

$ TrustProxies#headers — Property in class TrustProxies

The headers that should be used to detect proxies.

UpdateUserActivity::handle() — Method in class UpdateUserActivity

Handle an outgoing response.

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.

CloneImageThumbnails::handle() — Method in class CloneImageThumbnails
CloneImageThumbnails::hasThumbnail() — Method in class CloneImageThumbnails

Determine if original image has thumbnail.

CloneImageThumbnails::hasTiledImages() — Method in class CloneImageThumbnails

Determine if original image has tiled data.

CloneImagesOrVideos::handle() — Method in class CloneImagesOrVideos
CloneVideoThumbnails::handle() — Method in class CloneVideoThumbnails
CloneVideoThumbnails::hasThumbnails() — Method in class CloneVideoThumbnails

Determine if original video has thumbnails.

CloneVideoThumbnails::hasSprites() — Method in class CloneVideoThumbnails

Determine if original video has sprites.

CopyAnnotationFeatureVector::handle() — Method in class CopyAnnotationFeatureVector

Execute the job.

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.

GenerateReportJob::handle() — Method in class GenerateReportJob

Execute the job.

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

Execute the job.

PostprocessVolumeImport::handle() — Method in class PostprocessVolumeImport

Execute the job.

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.

ProcessCloneVolumeFiles::handle() — Method in class ProcessCloneVolumeFiles

Execute the job.

$ ProcessNewImage#height — Property 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.

ProcessNewVideo::hasInvalidMoovAtomPosition() — Method in class ProcessNewVideo
ProcessNewVolumeFiles::handle() — Method in class ProcessNewVolumeFiles

Execute the job.

RemoveAnnotationPatches::handle() — Method in class RemoveAnnotationPatches

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
AttachLabelListener::handle() — Method in class AttachLabelListener
CleanupImageAnnotations::handle() — Method in class CleanupImageAnnotations

Handle the event.

CleanupImageThumbnails::handle() — Method in class CleanupImageThumbnails

Handle the event.

CleanupImageTiles::handle() — Method in class CleanupImageTiles

Handle the event.

CleanupVideoAnnotations::handle() — Method in class CleanupVideoAnnotations

Handle the event.

CleanupVideoThumbnails::handle() — Method in class CleanupVideoThumbnails

Handle the event.

VolumeClonedListener::handle() — Method in class VolumeClonedListener
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.

CountCitations::handle() — Method in class CountCitations

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.

SubmitToScorpion::handle() — Method in class SubmitToScorpion

Execute the command.

EnsureTokenIsValid::handle() — Method in class EnsureTokenIsValid

Handle an incoming request.

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.

StoreImageEmbeddingRequest::hasBbox() — Method in class StoreImageEmbeddingRequest

Determine whether the request includes a bbox.

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.

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.

ProcessNewAnnotationCandidates::handle() — Method in class ProcessNewAnnotationCandidates
ProcessNewTrainingProposals::handle() — Method in class ProcessNewTrainingProposals
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.

$ Image#height — Property in class Image
PruneStaleSubscribers::handle() — Method in class PruneStaleSubscribers

Execute the command.

PtpJob::handle() — Method in class PtpJob

Execute the job.

CheckExpiredUserDisks::handle() — Method in class CheckExpiredUserDisks

Execute the command.

PruneExpiredUserDisks::handle() — Method in class PruneExpiredUserDisks

Execute the command.

RefreshDCacheTokens::handle() — Method in class RefreshDCacheTokens

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#hidden — Property in class StorageRequestFile

The attributes that should be hidden for arrays.

Project::hasGeoInfo() — Method in class Project

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

Handle — Class in namespace Biigle\Rules
ArchiveManager::has() — Method in class ArchiveManager

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

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
$ File#handle — Property in class File

File handle.

IfdoReportGenerator::hasIfdo() — Method in class IfdoReportGenerator

Determine if the volume has a iFDO metadata file.

HasConstantInstances — Class 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.

HasJsonAttributes — Class in namespace Biigle\Traits
HasMetadataFile — Class in namespace Biigle\Traits
HasMetadataFile::hasMetadata() — Method in class HasMetadataFile
Video::hasBeenProcessed() — Method in class Video

Determine whether the (new) video has been processed.

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#id — Property in class Annotation
$ AnnotationLabel#id — Property in class AnnotationLabel
AnnotationSession::imageAnnotations() — Method in class AnnotationSession

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

InitializeFeatureVectors — Class in namespace Biigle\Console\Commands
ImagesDeleted — Class in namespace Biigle\Events
$ LargoSessionFailed#id — Property in class LargoSessionFailed

The ID of the Largo session

$ LargoSessionSaved#id — Property in class LargoSessionSaved

The ID of the Largo session

FederatedSearchModel::instance() — Method in class FederatedSearchModel

The instance, this model belongs to.

FileCache::isProcessAlive() — Method in class FileCache

Determine whether the process owning the given lock token is still alive.

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.

VolumeAnnotationController::index() — Method in class VolumeAnnotationController

Get all annotations of a volume.

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.

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.

FederatedSearchIndexController::index() — Method in class FederatedSearchIndexController

Show the federated search index.

ImageAnnotationBulkController — Class in namespace Biigle\Http\Controllers\Api
ImageAnnotationController — Class in namespace Biigle\Http\Controllers\Api
ImageAnnotationController::index() — Method in class ImageAnnotationController

Shows a list of all annotations of the specified image.

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

Shows all labels of the specified annotation.

ImageController — Class in namespace Biigle\Http\Controllers\Api
ImageLabelController — Class in namespace Biigle\Http\Controllers\Api
ImportController — Class in namespace Biigle\Http\Controllers\Api\Import
LabelTreeController::index() — Method in class LabelTreeController

Shows all label trees the user has access to.

ImageAnnotationsController — Class in namespace Biigle\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.

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 volumes that match the given volume name and can be attached to the project by the requesting user.

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.

GetUsersWithAnnotations::index() — Method in class GetUsersWithAnnotations

Get all users with annotations in the project

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.

ReportsController::index() — Method in class ReportsController

List all available report types.

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.

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.

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.

GetUsersWithAnnotations::index() — Method in class GetUsersWithAnnotations

Get users with at least one annotation in the volume

ImageAnnotationExamplesController — Class in namespace Biigle\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.

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.

ExportController::index() — Method in class ExportController

Shows the export admin page.

FederatedSearchController::index() — Method in class FederatedSearchController

Show the federated search admin page.

ImportController — Class in namespace Biigle\Http\Controllers\Views\Admin
ImportController::index() — Method in class ImportController

Shows the import admin page.

IndexController — Class 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.

ImageAnnotationController — Class 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.

ImprintController — Class 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.

PublicImportController::index() — Method in class PublicImportController

Shows the import admin page.

ManualController::index() — Method in class ManualController

Show the application manual to the user.

NotificationsController::index() — Method in class NotificationsController

Shows the notification center.

LargoController::index() — Method in class LargoController

Show the Largo view for a project.

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.

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

Shows the image index page.

LargoController::index() — Method in class LargoController

Show the the Largo view for a volume.

VideoController::index() — Method in class VideoController

Shows the video 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.

IndexProjectAnnotationsSimilarity — Class in namespace Biigle\Http\Requests
IndexVolumeAnnotationsSimilarity — Class in namespace Biigle\Http\Requests
$ StoreImageAnnotation#image — Property in class StoreImageAnnotation

The image on which the annotation should be created.

$ StoreImageAnnotations#imageIds — Property in class StoreImageAnnotations

Unique image IDs of this request.

$ StoreImageAnnotations#images — Property in class StoreImageAnnotations

The images on which the annotations should be created.

$ StoreLabelTreeUser#isGlobalGuest — Property in class StoreLabelTreeUser

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

StoreLargoSession::imageAnotationsBelongToVolumes() — Method in class StoreLargoSession

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

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::isAllowedForSkipAttributes() — Method in class StoreReport

Check if skip_attributes 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::isAllowedForAllLabels() — Method in class StoreReport

Check if all_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.

$ UpdateFederatedSearchInstance#instance — Property in class UpdateFederatedSearchInstance

The instance that should be updated.

$ UpdateLabelTreeUser#isGlobalGuest — Property in class UpdateLabelTreeUser

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

UpdateVideoAnnotation::isWholeFrame() — Method in class UpdateVideoAnnotation

Determine if the annotation is a whole frame annotation.

Ifdo — Class in namespace Biigle\Ifdo
Ifdo::isValid() — Method in class Ifdo
Image — Class in namespace Biigle

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

ImageAnnotation — Class 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.

ImageAnnotationLabel — Class in namespace Biigle

Pivot object for the connection between ImageAnnotation and Label.

ImageAnnotationLabelFeatureVector — Class in namespace Biigle
ImageLabel — Class in namespace Biigle
ImageLabel::image() — Method in class ImageLabel

The image, this image label belongs to.

$ ApplyLargoSession#id — Property 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.

$ CloneImageThumbnails#image — Property in class CloneImageThumbnails

Cloned image of cloned volume

ImportVolumeMetadata — Class in namespace Biigle\Jobs
$ ImportVolumeMetadata#insertChunkSize — Property 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.

InitializeFeatureVectorChunk — Class in namespace Biigle\Jobs
$ PostprocessVolumeImport#ids — Property in class PostprocessVolumeImport

IDs of the imported volumes.

$ ProcessNewImage#image — Property in class ProcessNewImage

The image to process

$ TileSingleImage#image — Property in class TileSingleImage

The image to generate tiles for.

$ UpdateFederatedSearchIndex#instance — Property in class UpdateFederatedSearchIndex

The instance from which the index should be updated.

$ Label#id — Property 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
ImageController — Class 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#incrementing — Property in class LsloginId

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

$ NfdiLoginId#incrementing — Property in class NfdiLoginId

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.

ImagesCreatedListener — Class in namespace Biigle\Modules\ColorSort\Listeners
ImageObserver — Class 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.

ImagesController — Class 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#image — Property in class ComputeImage

The image that should be processed with laser point detection.

Image — Class in namespace Biigle\Modules\Laserpoints

Extends the base Biigle image.

$ Image#infoParams — Property in class Image

Properties of the laser points object.

$ ProcessDelphiJob#image — Property in class ProcessDelphiJob

The image to process.

$ ProcessImageDelphiJob#image — Property in class ProcessImageDelphiJob

The image to compute the area for.

$ ProcessImageManualJob#image — Property in class ProcessImageManualJob

The image to compute the area for.

$ ProcessManualJob#image — Property in class ProcessManualJob

The image to process.

ImageEmbeddingController — Class in namespace Biigle\Modules\MagicSam\Http\Controllers
$ StoreImageEmbeddingRequest#image — Property in class StoreImageEmbeddingRequest

The image instance.

$ GenerateEmbedding#image — Property in class GenerateEmbedding

The image to generate an embedding of.

$ GenericImage#id — Property 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.

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.

$ Annotation#id — Property in class Annotation
$ Annotation#image_id — Property in class Annotation
Annotation::isPointShape() — Method in class Annotation
Annotation::isLineShape() — Method in class Annotation
Annotation::isCircleShape() — Method in class Annotation
Annotation::isRectangleShape() — Method in class Annotation
$ Category#id — Property in class Category
$ Coco#info — Property in class Coco
$ Coco#images — Property in class Coco
Image — Class in namespace Biigle\Modules\MetadataCoco
$ Image#id — Property in class Image
Info — Class in namespace Biigle\Modules\MetadataCoco
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
IfdoParser — Class in namespace Biigle\Modules\MetadataIfdo
$ IfdoParser#ifdo — Property in class IfdoParser
AdminController::index() — Method in class AdminController

Show the metrics admin page.

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.

$ PtpJob#imageChunkSize — Property in class PtpJob

Number of images to be processed per chunk

$ PtpJob#insertChunkSize — Property in class PtpJob

Number of annotations to be inserted per chunk

PtpJob::insertAnnotationChunk() — Method in class PtpJob

Insert annotation in the DB

PtpJob::iterateOverCsvFile() — Method in class PtpJob

Create a generator that iterates the lines of a CSV file containing annotation results from the PTP conversion.

UserDiskController::index() — Method in class UserDiskController

Lists all storage disks of the authenticated user

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.

UserDisk::isDCacheAccessTokenExpiring() — Method in class UserDisk

Check if the dcache access token is about to expire (within 1 minute) or already expired.

UserDisk::isDCacheRefreshTokenExpiring() — Method in class UserDisk

Check if the dcache refresh token is about to expire (within 2 hours).

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.

InAppNotification — Class in namespace Biigle\Notifications

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

ImageAnnotationObserver — Class in namespace Biigle\Observers
ImageObserver — Class 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.

ReportType::imageAnnotationsAbundance() — Method in class ReportType
ReportType::imageAnnotationsAbundanceId() — Method in class ReportType
ReportType::imageAnnotationsAnnotationLocation() — Method in class ReportType
ReportType::imageAnnotationsAnnotationLocationId() — Method in class ReportType
ReportType::imageAnnotationsArea() — Method in class ReportType
ReportType::imageAnnotationsAreaId() — Method in class ReportType
ReportType::imageAnnotationsBasic() — Method in class ReportType
ReportType::imageAnnotationsBasicId() — Method in class ReportType
ReportType::imageAnnotationsCsv() — Method in class ReportType
ReportType::imageAnnotationsCsvId() — Method in class ReportType
ReportType::imageAnnotationsExtended() — Method in class ReportType
ReportType::imageAnnotationsExtendedId() — Method in class ReportType
ReportType::imageAnnotationsCoco() — Method in class ReportType
ReportType::imageAnnotationsCocoId() — Method in class ReportType
ReportType::imageAnnotationsFull() — Method in class ReportType
ReportType::imageAnnotationsFullId() — Method in class ReportType
ReportType::imageAnnotationsImageLocation() — Method in class ReportType
ReportType::imageAnnotationsImageLocationId() — Method in class ReportType
ReportType::imageIfdo() — Method in class ReportType
ReportType::imageIfdoId() — Method in class ReportType
ReportType::imageLabelsBasic() — Method in class ReportType
ReportType::imageLabelsBasicId() — Method in class ReportType
ReportType::imageLabelsCsv() — Method in class ReportType
ReportType::imageLabelsCsvId() — Method in class ReportType
ReportType::imageLabelsImageLocation() — Method in class ReportType
ReportType::imageLabelsImageLocationId() — Method in class ReportType
ImageMetadata — Class in namespace Biigle\Rules
VolumeUrl::isDeniedProvider() — Method in class VolumeUrl

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

VolumeUrl::isOwnDomain() — Method in class VolumeUrl

Determine if the remote volume URL points to this application.

$ Export#ids — Property in class Export

IDs of the models of this export.

ImageAnnotationExport — Class in namespace Biigle\Services\Export
ImageAnnotationLabelExport — Class in namespace Biigle\Services\Export
ImageExport — Class in namespace Biigle\Services\Export
ImageLabelExport — Class in namespace Biigle\Services\Export
$ ArchiveManager#importTypes — Property in class ArchiveManager

Class names of available imports.

Import — Class in namespace Biigle\Services\Import
$ LabelTreeImport#importLabelTrees — Property 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#importLabelTree — Property in class PublicLabelTreeImport

Caches the decoded label tree import file.

PublicLabelTreeImport::importLabels() — Method in class PublicLabelTreeImport

Import the labels of this import.

$ UserImport#importUsers — Property in class UserImport

Caches the decoded user import file.

$ VolumeImport#importVolumes — Property 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.

FileMetadata::isEmpty() — Method in class FileMetadata
ImageAnnotation — Class in namespace Biigle\Services\MetadataParsing
ImageCsvParser — Class in namespace Biigle\Services\MetadataParsing
ImageMetadata — Class 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.

AnnotationReportGenerator::isRestrictedToExportArea() — Method in class AnnotationReportGenerator

Should this report be restricted to the export area?

ImageLocationReportGenerator — Class in namespace Biigle\Services\Reports\Projects\ImageAnnotations
ImageIfdoReportGenerator — Class in namespace Biigle\Services\Reports\Projects
ImageLocationReportGenerator — Class in namespace Biigle\Services\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.

IfdoReportGenerator — Class in namespace Biigle\Services\Reports\Volumes
$ IfdoReportGenerator#imageAnnotationLabels — Property in class IfdoReportGenerator

All labels that should be contained in the iFDO.

$ IfdoReportGenerator#imageAnnotationCreators — Property in class IfdoReportGenerator

All users that should be contained in the iFDO.

$ IfdoReportGenerator#imageSetItems — Property 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.

AbundanceReportGenerator::initQuery() — Method in class AbundanceReportGenerator

Assembles the part of the DB query that is used for the abundance report.

AnnotationReportGenerator::initQuery() — Method in class AnnotationReportGenerator

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

$ AreaReportGenerator#images — Property in class AreaReportGenerator

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

ImageLocationReportGenerator — Class in namespace Biigle\Services\Reports\Volumes\ImageAnnotations
ImageIfdoReportGenerator — Class in namespace Biigle\Services\Reports\Volumes
ImageLocationReportGenerator — Class in namespace Biigle\Services\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?

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#id — Property in class VolumeFile
$ VolumeFileLabel#id — Property in class VolumeFileLabel
InitializeMaiaTables — Class in namespace [Global Namespace]

J

UserChannel::join() — Method in class UserChannel

Authenticate the user's access to the channel.

VolumeChannel::join() — Method in class VolumeChannel

Authenticate the user's access to the channel.

ProjectInvitationController::join() — Method in class ProjectInvitationController

Join a project through an invitation.

JoinProjectInvitation — Class in namespace Biigle\Http\Requests
$ Ifdo#jsonArr — Property in class Ifdo
Job — Class in namespace Biigle\Jobs
Job — Class in namespace Biigle\Modules\Laserpoints\Jobs
$ MaiaJobContinued#job — Property in class MaiaJobContinued

The job that caused this event.

$ MaiaJobCreated#job — Property in class MaiaJobCreated

The job that caused this event.

$ MaiaJobDeleting#job — Property in class MaiaJobDeleting

The job that caused this event.

$ ContinueMaiaJob#job — Property in class ContinueMaiaJob

The job to update

$ DestroyMaiaJob#job — Property in class DestroyMaiaJob

The job to destroy

$ SubmitAnnotationCandidates#job — Property in class SubmitAnnotationCandidates

The job to submit candidates of

$ ConvertAnnotationCandidates#job — Property in class ConvertAnnotationCandidates

The job to convert candidates of.

JobFailure — Class 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#jobId — Property in class JobFailure

ID of the MAIA job.

MaiaAnnotation::job() — Method in class MaiaAnnotation

The MAIA job, this MAIA anotation belongs to.

JobStateChanged — Class in namespace Biigle\Modules\Maia\Notifications
$ JobStateChanged#job — Property in class JobStateChanged

The job which changed state.

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

K

Kernel — Class in namespace Biigle\Console
Kernel — Class in namespace Biigle\Http
$ LsloginId#keyType — Property in class LsloginId

The data type of the auto-incrementing ID.

$ NfdiLoginId#keyType — Property in class NfdiLoginId

The data type of the auto-incrementing ID.

KpiController — Class in namespace Biigle\Modules\Kpis\Http\Controllers\Views
KpisServiceProvider — Class in namespace Biigle\Modules\Kpis
KnowledgeTransferVolumeController — Class in namespace Biigle\Modules\Maia\Http\Controllers\Api
$ ObjectDetection#knowledgeTransferVolumeUrl — Property in class ObjectDetection

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

$ ObjectDetection#knowledgeTransferImages — Property in class ObjectDetection

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

KnowledgeTransferVolume — Class in namespace Biigle\Modules\Maia\Rules

L

$ Annotation#labelBOTLabels — Property in class Annotation

The additional labels suggested by the LabelBOT.

Annotation::labels() — Method in class Annotation

The labels, this annotation got assigned by the users.

$ AnnotationLabel#label_id — Property in class AnnotationLabel
AnnotationLabel::label() — Method in class AnnotationLabel

The label, this annotation label belongs to.

LabelbotCreateIndex — Class in namespace Biigle\Console\Commands
LabelbotIndexProgress — Class in namespace Biigle\Console\Commands
LabelSourceAdapterContract — Class in namespace Biigle\Contracts

A label source adapter.

LargoSessionFailed — Class in namespace Biigle\Events
LargoSessionSaved — Class in namespace Biigle\Events
$ FileCache#linkCount — Property in class FileCache

Counter for reference links used to generate unique names per instance.

$ FileCache#lockHandle — Property in class FileCache

Open file handle holding the exclusive lock that signals this process is alive. Created lazily and held for the lifetime of the process.

$ FileCache#lockToken — Property in class FileCache

Unique token identifying this process. Embedded in every reference link name and used as the name of this process' lock file.

FileCache::lockDir() — Method in class FileCache

Get the directory in which process lock files are stored.

FileCache::lockPath() — Method in class FileCache

Get the path to the lock file for the given process token.

LabelTreeExportController — Class in namespace Biigle\Http\Controllers\Api\Export
LabelController — Class in namespace Biigle\Http\Controllers\Api
LabelSourceController — Class in namespace Biigle\Http\Controllers\Api
LabelTreeAuthorizedProjectController — Class in namespace Biigle\Http\Controllers\Api
LabelTreeController — Class in namespace Biigle\Http\Controllers\Api
LabelTreeLabelController — Class in namespace Biigle\Http\Controllers\Api
LabelTreeMergeController — Class in namespace Biigle\Http\Controllers\Api
LabelTreeUserController — Class in namespace Biigle\Http\Controllers\Api
LabelTreeVersionController — Class in namespace Biigle\Http\Controllers\Api
LinkVideoAnnotationController — Class in namespace Biigle\Http\Controllers\Api
LargoController — Class in namespace Biigle\Http\Controllers\Api\Projects
LargoController — Class in namespace Biigle\Http\Controllers\Api\Volumes
LoginController — Class in namespace Biigle\Http\Controllers\Auth
LabelTreesController — Class in namespace Biigle\Http\Controllers\Views\Admin
LogsController — Class in namespace Biigle\Http\Controllers\Views\Admin
LabelTreeMembersController — Class in namespace Biigle\Http\Controllers\Views\LabelTrees
LabelTreeMergeController — Class in namespace Biigle\Http\Controllers\Views\LabelTrees
LabelTreeProjectsController — Class in namespace Biigle\Http\Controllers\Views\LabelTrees
LabelTreeVersionsController — Class in namespace Biigle\Http\Controllers\Views\LabelTrees
LabelTreesController — Class in namespace Biigle\Http\Controllers\Views\LabelTrees
LargoController — Class in namespace Biigle\Http\Controllers\Views\Projects
LargoController — Class in namespace Biigle\Http\Controllers\Views\Volumes
$ DestroyLabel#label — Property in class DestroyLabel

The label to destroy.

LinkVideoAnnotation — Class in namespace Biigle\Http\Requests
$ StoreImageAnnotationLabel#label — Property in class StoreImageAnnotationLabel

The label that should be attached.

$ StoreImageAnnotations#labelIds — Property in class StoreImageAnnotations

Unique label IDs of this request.

$ StoreImageAnnotations#labels — Property in class StoreImageAnnotations

The labels that should be attached to the new annotations.

$ StoreVideoAnnotationLabel#label — Property in class StoreVideoAnnotationLabel

The label that should be attached.

$ StoreVolumeFileLabel#label — Property in class StoreVolumeFileLabel

The label that should be attached to the file.

$ UpdateLabel#label — Property 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.

Label — Class 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.

LabelSource — Class in namespace Biigle

The source (database) of a label.

LabelTree — Class 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.

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

The "master" label tree of this version.

LogManager — Class in namespace Biigle\Logging
LsloginIdFactory — Class in namespace Biigle\Modules\AuthLSLogin\Database\Factories
LSLoginController — Class in namespace Biigle\Modules\AuthLSLogin\Http\Controllers
LSLoginServiceProvider — Class in namespace Biigle\Modules\AuthLSLogin
LsloginId — Class in namespace Biigle\Modules\AuthLSLogin
LaserpointsController — Class in namespace Biigle\Modules\Laserpoints\Http\Controllers\Api
$ Job#labelId — Property in class Job

ID of the laser point label.

LaserpointsServiceProvider — Class in namespace Biigle\Modules\Laserpoints
LaserpointsScript — Class in namespace Biigle\Modules\Laserpoints\Support
AnnotationCandidate::label() — Method in class AnnotationCandidate

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

$ Image#license — Property in class Image
$ Converter#labels — Property in class Converter
Converter::labelForId() — Method in class Converter
LabelPolicy — Class in namespace Biigle\Policies
LabelTreePolicy — Class in namespace Biigle\Policies
LabelTreeVersionPolicy — Class in namespace Biigle\Policies
Project::labelTrees() — Method in class Project

The label trees, this project is using.

$ EventServiceProvider#listen — Property in class EventServiceProvider

The event listener mappings for the application.

$ QueueSize#listen — Property in class QueueSize

The events to listen for.

LessThan — Class in namespace Biigle\Rules
LabelTreeExport — Class in namespace Biigle\Services\Export
LabelTreeImport — Class in namespace Biigle\Services\Import
$ VolumeImport#labelTreeImport — Property in class VolumeImport

The label tree import instance that belongs to this import.

LabelBotService — Class in namespace Biigle\Services\LabelBot
$ FileMetadata#labels — Property in class FileMetadata

The labels directly attached to the file.

Label — Class in namespace Biigle\Services\MetadataParsing
LabelAndUser — Class in namespace Biigle\Services\MetadataParsing
$ ReportGenerator#labels — Property in class ReportGenerator

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

$ IfdoReportGenerator#labels — Property in class IfdoReportGenerator

Labels that have been used in this volume.

$ PythonScriptRunner#lines — Property in class PythonScriptRunner

Array of output lines of the exec call.

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_id — Property in class VolumeFileLabel
VolumeFileLabel::label() — Method in class VolumeFileLabel

The label, this video label belongs to.

WebDAVAdapter::listContents() — Method in class WebDAVAdapter

M

MigrateTiledImages — Class in namespace Biigle\Console\Commands
Modules — Class 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.

MediaTypeController — Class in namespace Biigle\Http\Controllers\Api
MetadataController — Class in namespace Biigle\Http\Controllers\Api\Volumes
ManualController — Class in namespace Biigle\Http\Controllers\Views
$ Kernel#middleware — Property in class Kernel

The application's global HTTP middleware stack.

$ Kernel#middlewareGroups — Property in class Kernel

The application's route middleware groups.

$ Kernel#middlewareAliases — Property in class Kernel

The application's middleware aliases.

AttachProjectUser::messages() — Method in class AttachProjectUser

Get the error messages for the defined validation rules.

$ DestroyLabelTreeUser#member — Property 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#metadataParser — Property in class StoreVolume

Class name of the metadata parser that should be used.

$ StoreVolume#metadataPath — Property in class StoreVolume

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

$ StoreVolumeMetadata#metadata — Property in class StoreVolumeMetadata

The volume metadata after validation.

$ UpdateLabelTreeUser#member — Property 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#metadata — Property in class CreateNewImagesOrVideos

Metadata of the files to add during creation.

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.

MigrateTiledImage — Class in namespace Biigle\Jobs
$ ProcessAnnotatedFile#maxRedispatchTries — Property in class ProcessAnnotatedFile

The maximum number of times the job may be redispatched.

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.

MediaType — Class in namespace Biigle

Volumes can contain either images or videos as media type.

$ AnnotationAssistanceRequestFactory#model — Property in class AnnotationAssistanceRequestFactory

The name of the factory's corresponding model.

$ LsloginIdFactory#model — Property in class LsloginIdFactory

The name of the factory's corresponding model.

$ NfdiLoginIdFactory#model — Property in class NfdiLoginIdFactory

The name of the factory's corresponding model.

StoreColorSortSequence::messages() — Method in class StoreColorSortSequence

Get the error messages for the defined validation rules.

MagicSamServiceProvider — Class in namespace Biigle\Modules\MagicSam
MigratePatchStorage — Class in namespace Biigle\Modules\Maia\Console\Commands
MigratePatchStorage::migrate() — Method in class MigratePatchStorage
$ AnnotationCandidateFactory#model — Property in class AnnotationCandidateFactory

The name of the factory's corresponding model.

$ AnnotationCandidateFeatureVectorFactory#model — Property in class AnnotationCandidateFeatureVectorFactory

The name of the factory's corresponding model.

MaiaJobFactory — Class in namespace Biigle\Modules\Maia\Database\Factories
$ MaiaJobFactory#model — Property in class MaiaJobFactory

The name of the factory's corresponding model.

MaiaJobStateFactory — Class in namespace Biigle\Modules\Maia\Database\Factories
$ MaiaJobStateFactory#model — Property in class MaiaJobStateFactory

The name of the factory's corresponding model.

$ TrainingProposalFactory#model — Property in class TrainingProposalFactory

The name of the factory's corresponding model.

$ TrainingProposalFeatureVectorFactory#model — Property in class TrainingProposalFeatureVectorFactory

The name of the factory's corresponding model.

MaiaJobContinued — Class in namespace Biigle\Modules\Maia\Events
MaiaJobCreated — Class in namespace Biigle\Modules\Maia\Events
MaiaJobDeleting — Class in namespace Biigle\Modules\Maia\Events
MaiaJobController — Class in namespace Biigle\Modules\Maia\Http\Controllers\Api
MaiaJobConvertingCandidatesController — Class in namespace Biigle\Modules\Maia\Http\Controllers\Api
MaiaJobImagesController — Class in namespace Biigle\Modules\Maia\Http\Controllers\Api
MaiaJobController — Class in namespace Biigle\Modules\Maia\Http\Controllers\Views
UpdateAnnotationCandidate::maybeRestrictUpdating() — Method in class UpdateAnnotationCandidate

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

UpdateTrainingProposal::maybeRestrictUpdating() — Method in class UpdateTrainingProposal

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

DetectionJob::maybeLimitAnnotations() — Method in class DetectionJob

Apply the limit for the maximum number of annotations.

$ JobFailure#message — Property in class JobFailure

Error message.

MaiaAnnotation — Class in namespace Biigle\Modules\Maia
MaiaJob — Class in namespace Biigle\Modules\Maia
MaiaJobState — Class in namespace Biigle\Modules\Maia
MaiaServiceProvider — Class in namespace Biigle\Modules\Maia
MaiaJobPolicy — Class 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.

MetadataCocoServiceProvider — Class in namespace Biigle\Modules\MetadataCoco
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
MetadataIfdoServiceProvider — Class in namespace Biigle\Modules\MetadataIfdo
$ EventFactory#model — Property in class EventFactory

The name of the factory's corresponding model.

MetricsServiceProvider — Class in namespace Biigle\Modules\Metrics
$ NewsletterFactory#model — Property in class NewsletterFactory

The name of the factory's corresponding model.

$ NewsletterSubscriberFactory#model — Property in class NewsletterSubscriberFactory

The name of the factory's corresponding model.

PtpJob::maybeDownloadCheckpoint() — Method in class PtpJob

Download the checkpoint if not present

$ UserDiskFactory#model — Property in class UserDiskFactory

The name of the factory's corresponding model.

$ StorageRequestFactory#model — Property in class StorageRequestFactory

The name of the factory's corresponding model.

$ StorageRequestFileFactory#model — Property in class StorageRequestFileFactory

The name of the factory's corresponding model.

FilePrefix::message() — Method in class FilePrefix

Get the validation error message.

$ InAppNotification#message — Property 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#message — Property 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#message — Property in class VolumeFiles

The validation message to display.

VolumeFiles::message() — Method in class VolumeFiles

Get the validation error message.

$ VolumeUrl#message — Property in class VolumeUrl

The validation message to display.

VolumeUrl::message() — Method in class VolumeUrl

Get the validation error message.

LabelTreeImport::mergeLabels() — Method in class LabelTreeImport

Merge conflicts between import labels and existing labels.

CsvParser::maybeCastToFloat() — Method in class CsvParser

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

MetadataParser — Class in namespace Biigle\Services\MetadataParsing
Modules — Class in namespace Biigle\Services

The module registry service.

File::makeTmp() — Method in class File

Creates a new temporary file.

MakesZipArchives — Class in namespace Biigle\Services\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.

PatchedQueueWorker::memoryExceeded() — Method in class PatchedQueueWorker

Determine if the memory limit has been exceeded.

Volume::mediaType() — Method in class Volume

The media type of this volume.

N

$ Apidoc#name — Property in class Apidoc

The console command name.

NewUser — Class in namespace Biigle\Console\Commands
$ NewUser#name — Property in class NewUser

The console command name.

$ SyncPrune#name — Property in class SyncPrune

The console command name.

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

Shows the admin new user page.

NotificationsController — Class 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#name — Property in class Publish

The console command name.

LsloginId::newFactory() — Method in class LsloginId

Create a new factory instance for the model.

NfdiLoginIdFactory — Class in namespace Biigle\Modules\AuthNfdi\Database\Factories
NfdiLoginController — Class in namespace Biigle\Modules\AuthNfdi\Http\Controllers
NfdiLoginId — Class in namespace Biigle\Modules\AuthNfdi
NfdiLoginId::newFactory() — Method in class NfdiLoginId

Create a new factory instance for the model.

$ Publish#name — Property in class Publish

The console command name.

$ Config#name — Property in class Config

The console command name.

$ Publish#name — Property in class Publish

The console command name.

$ CountCitations#name — Property in class CountCitations

The console command name.

$ CountUniqueUser#name — Property in class CountUniqueUser

The console command name.

$ CountUser#name — Property in class CountUser

The console command name.

$ DetermineStorageUsage#name — Property in class DetermineStorageUsage

The console command name.

$ SubmitToScorpion#name — Property in class SubmitToScorpion

The console command name.

$ Config#name — Property in class Config

The console command name.

$ Publish#name — Property in class Publish

The console command name.

$ PruneOldEmbeddings#name — Property 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#name — Property in class Publish

The console command name.

$ ConvertAnnotationCandidates#newAnnotations — Property in class ConvertAnnotationCandidates

Newly created annotations.

NotifyNoveltyDetectionComplete — Class in namespace Biigle\Modules\Maia\Jobs
NotifyObjectDetectionComplete — Class in namespace Biigle\Modules\Maia\Jobs
NoveltyDetection — Class in namespace Biigle\Modules\Maia\Jobs
NoveltyDetectionFailure — Class 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.

NoveltyDetectionComplete — Class in namespace Biigle\Modules\Maia\Notifications
NoveltyDetectionFailed — Class 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.

$ Category#name — Property in class Category
Event::newFactory() — Method in class Event

Create a new factory instance for the model.

$ PruneStaleSubscribers#name — Property in class PruneStaleSubscribers

The console command name.

NewsletterFactory — Class in namespace Biigle\Modules\Newsletter\Database\Factories
NewsletterSubscriberFactory — Class in namespace Biigle\Modules\Newsletter\Database\Factories
NewsletterController — Class in namespace Biigle\Modules\Newsletter\Http\Controllers\Api
NewsletterSubscriberController — Class in namespace Biigle\Modules\Newsletter\Http\Controllers\Api
NewsletterArchiveController — Class in namespace Biigle\Modules\Newsletter\Http\Controllers\Views
NewsletterController — Class in namespace Biigle\Modules\Newsletter\Http\Controllers\Views
$ UpdateNewsletter#newsletter — Property in class UpdateNewsletter
Newsletter — Class in namespace Biigle\Modules\Newsletter
Newsletter::newFactory() — Method in class Newsletter

Create a new factory instance for the model.

NewsletterServiceProvider — Class in namespace Biigle\Modules\Newsletter
NewsletterSubscriber — Class in namespace Biigle\Modules\Newsletter
NewsletterSubscriber::newFactory() — Method in class NewsletterSubscriber

Create a new factory instance for the model.

NewNewsletter — Class in namespace Biigle\Modules\Newsletter\Notifications
$ NewNewsletter#newsletter — Property in class NewNewsletter
NewsletterPolicy — Class in namespace Biigle\Modules\Newsletter\Policies
NewsletterSubscriberPolicy — Class in namespace Biigle\Modules\Newsletter\Policies
$ CheckExpiredUserDisks#name — Property in class CheckExpiredUserDisks

The console command name.

$ PruneExpiredUserDisks#name — Property in class PruneExpiredUserDisks

The console command name.

$ RefreshDCacheTokens#name — Property in class RefreshDCacheTokens

The console command name.

UserDisk::newFactory() — Method in class UserDisk

Create a new factory instance for the model.

$ CheckExpiredStorageRequests#name — Property in class CheckExpiredStorageRequests

The console command name.

$ PruneExpiredStorageRequests#name — Property in class PruneExpiredStorageRequests

The console command name.

$ PruneStaleStorageRequests#name — Property 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#namespace — Property in class RouteServiceProvider

The controller namespace for the application.

$ AbundanceReportGenerator#name — Property in class AbundanceReportGenerator

Name of the report for use in text.

$ AnnotationLocationReportGenerator#name — Property in class AnnotationLocationReportGenerator

Name of the report for use in text.

$ AreaReportGenerator#name — Property in class AreaReportGenerator

Name of the report for use in text.

$ BasicReportGenerator#name — Property in class BasicReportGenerator

Name of the report for use in text.

$ CocoReportGenerator#name — Property in class CocoReportGenerator

Name of the report for use in text.

$ CsvReportGenerator#name — Property in class CsvReportGenerator

Name of the report for use in text.

$ ExtendedReportGenerator#name — Property in class ExtendedReportGenerator

Name of the report for use in text.

$ FullReportGenerator#name — Property in class FullReportGenerator

Name of the report for use in text.

$ ImageLocationReportGenerator#name — Property in class ImageLocationReportGenerator

Name of the report for use in text.

$ ImageIfdoReportGenerator#name — Property in class ImageIfdoReportGenerator

Name of the report for use in text.

$ BasicReportGenerator#name — Property in class BasicReportGenerator

Name of the report for use in text.

$ CsvReportGenerator#name — Property in class CsvReportGenerator

Name of the report for use in text.

$ ImageLocationReportGenerator#name — Property in class ImageLocationReportGenerator

Name of the report for use in text.

$ CsvReportGenerator#name — Property in class CsvReportGenerator

Name of the report for use in text.

$ VideoIfdoReportGenerator#name — Property in class VideoIfdoReportGenerator

Name of the report for use in text.

$ CsvReportGenerator#name — Property in class CsvReportGenerator

Name of the report for use in text.

$ ReportGenerator#name — Property in class ReportGenerator

Name of the report for use in text.

$ AbundanceReportGenerator#name — Property in class AbundanceReportGenerator

Name of the report for use in text.

$ AnnotationLocationReportGenerator#name — Property in class AnnotationLocationReportGenerator

Name of the report for use in text.

$ AreaReportGenerator#name — Property in class AreaReportGenerator

Name of the report for use in text.

$ BasicReportGenerator#name — Property in class BasicReportGenerator

Name of the report for use in text.

$ CocoReportGenerator#name — Property in class CocoReportGenerator

Name of the report for use in text.

$ CsvReportGenerator#name — Property in class CsvReportGenerator

Name of the report for use in text.

$ ExtendedReportGenerator#name — Property in class ExtendedReportGenerator

Name of the report for use in text.

$ FullReportGenerator#name — Property in class FullReportGenerator

Name of the report for use in text.

$ ImageLocationReportGenerator#name — Property in class ImageLocationReportGenerator

Name of the report for use in text.

$ ImageIfdoReportGenerator#name — Property in class ImageIfdoReportGenerator

Name of the report for use in text.

$ BasicReportGenerator#name — Property in class BasicReportGenerator

Name of the report for use in text.

$ CsvReportGenerator#name — Property in class CsvReportGenerator

Name of the report for use in text.

$ ImageLocationReportGenerator#name — Property in class ImageLocationReportGenerator

Name of the report for use in text.

$ CsvReportGenerator#name — Property in class CsvReportGenerator

Name of the report for use in text.

$ VideoIfdoReportGenerator#name — Property in class VideoIfdoReportGenerator

Name of the report for use in text.

$ CsvReportGenerator#name — Property in class CsvReportGenerator

Name of the report for use in text.

O

ApiToken::owner() — Method in class ApiToken

The user, this token belongs to.

ObjectTrackingFailed — Class in namespace Biigle\Events
ObjectTrackingSucceeded — Class in namespace Biigle\Events
$ CloneImagesOrVideos#onlyFiles — Property in class CloneImagesOrVideos

Array containing file ids.

$ CloneImagesOrVideos#onlyAnnotationLabels — Property in class CloneImagesOrVideos

Array containing annotation label ids.

$ CloneImagesOrVideos#onlyFileLabels — Property in class CloneImagesOrVideos

Array containing file label ids.

$ ProcessCloneVolumeFiles#only — Property in class ProcessCloneVolumeFiles

Array of image/video IDs to restrict processing to.

$ ProcessNewVolumeFiles#only — Property in class ProcessNewVolumeFiles

Array of image/video IDs to restrict processing to.

$ DelphiGather#outputPath — Property in class DelphiGather

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

ObjectDetection — Class in namespace Biigle\Modules\Maia\Jobs
ObjectDetectionFailure — Class in namespace Biigle\Modules\Maia\Jobs
ObjectDetectionComplete — Class in namespace Biigle\Modules\Maia\Notifications
ObjectDetectionFailed — Class in namespace Biigle\Modules\Maia\Notifications
OddNumber — Class in namespace Biigle\Modules\Maia\Rules
$ PtpJob#outputFile — Property in class PtpJob

File where result data from the Python conversion script will be stored

UserDisksServiceProvider::overrideUseDiskGateAbility() — Method in class UserDisksServiceProvider

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

$ DeleteStorageRequestFile#oldRetryCount — Property in class DeleteStorageRequestFile

Count for retry attempts of a chunked file

$ ReportGenerator#options — Property in class ReportGenerator

Options for this report.

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#points — Property in class Annotation
InitializeFeatureVectors::processImages() — Method in class InitializeFeatureVectors
InitializeFeatureVectors::processVideos() — Method in class InitializeFeatureVectors
PruneNotifications — Class 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.

ProcessAnnotatedFileException — Class in namespace Biigle\Exceptions
PruneFileCache — Class 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.

FileCache::pruneStaleReferences() — Method in class FileCache

Remove reference links left behind by crashed workers.

FileCache::pruneFilesByMaxAge() — Method in class FileCache

Prune canonical files that are older than max_age.

FileCache::pruneFilesByMaxSize() — Method in class FileCache

Prune oldest canonical files that exceed the max_size.

FileCache::pruneOrphanLockFiles() — Method in class FileCache

Remove lock files of processes that have terminated.

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.

PublicLabelTreeExportController — Class in namespace Biigle\Http\Controllers\Api\Export
PublicLabelTreeImportController — Class in namespace Biigle\Http\Controllers\Api\Import
PendingVolumeController — Class in namespace Biigle\Http\Controllers\Api
PendingVolumeImportController — Class in namespace Biigle\Http\Controllers\Api
ProjectController — Class in namespace Biigle\Http\Controllers\Api
ProjectInvitationController — Class in namespace Biigle\Http\Controllers\Api
ProjectLabelTreeController — Class in namespace Biigle\Http\Controllers\Api
ProjectReportController — Class in namespace Biigle\Http\Controllers\Api
ProjectUserController — Class in namespace Biigle\Http\Controllers\Api
ProjectVolumeController — Class in namespace Biigle\Http\Controllers\Api
ProjectsAttachableVolumesController — Class in namespace Biigle\Http\Controllers\Api
ProjectAnnotationLabels — Class in namespace Biigle\Http\Controllers\Api\Projects
PublicImportController — Class in namespace Biigle\Http\Controllers\Views\LabelTrees
PrivacyController — Class in namespace Biigle\Http\Controllers\Views
ProjectInvitationController — Class in namespace Biigle\Http\Controllers\Views\Projects
ProjectLabelTreeController — Class in namespace Biigle\Http\Controllers\Views\Projects
ProjectReportsController — Class in namespace Biigle\Http\Controllers\Views\Projects
ProjectStatisticsController — Class in namespace Biigle\Http\Controllers\Views\Projects
ProjectUserController — Class in namespace Biigle\Http\Controllers\Views\Projects
ProjectsController — Class in namespace Biigle\Http\Controllers\Views\Projects
SettingsController::profile() — Method in class SettingsController

Shows the profile settings.

PendingVolumeController — Class in namespace Biigle\Http\Controllers\Views\Volumes
PreventRequestForgery — Class in namespace Biigle\Http\Middleware
PreventRequestsDuringMaintenance — Class in namespace Biigle\Http\Middleware
$ TrustProxies#proxies — Property in class TrustProxies

The trusted proxies for this application.

$ AttachProjectUser#project — Property in class AttachProjectUser

The project to attach a user to.

$ CloneVolume#project — Property in class CloneVolume

The project to update.

$ DestroyPinnedProject#project — Property in class DestroyPinnedProject

The project to unpin.

$ DestroyProjectUser#project — Property in class DestroyProjectUser

The project to detach the user from.

$ IndexProjectAnnotationsSimilarity#project — Property in class IndexProjectAnnotationsSimilarity

The project of which to index the annotations.

ShowExport::prepareForValidation() — Method in class ShowExport
$ StoreLabelTree#project — Property 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#project — Property in class StorePinnedProject

The project to pin.

$ StoreProjectInvitation#project — Property in class StoreProjectInvitation

The project to attach a user to.

$ StoreProjectLabelTree#project — Property in class StoreProjectLabelTree

The project to attach the label tree to.

$ StoreProjectLargoSession#project — Property in class StoreProjectLargoSession

The project to store the Largo session for.

$ StoreProjectReport#project — Property in class StoreProjectReport

The project to generate a new report for.

StoreUser::prepareForValidation() — Method in class StoreUser

Prepare the data for validation.

$ StoreVolume#project — Property 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#project — Property in class UpdateProject

The project to update.

$ UpdateProjectUser#project — Property 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
$ CloneImageThumbnails#prefix — Property in class CloneImageThumbnails

Path of original image thumbnails and tiled data

$ CloneImagesOrVideos#project — Property in class CloneImagesOrVideos

The target project.

$ CloneVideoThumbnails#prefix — Property in class CloneVideoThumbnails

Path of original video thumbnails and sprites

PostprocessVolumeImport — Class in namespace Biigle\Jobs
ProcessAnnotatedFile — Class in namespace Biigle\Jobs
ProcessAnnotatedImage — Class in namespace Biigle\Jobs
ProcessAnnotatedVideo — Class in namespace Biigle\Jobs
ProcessAnnotatedVideo::processAnnotationChunk() — Method in class ProcessAnnotatedVideo

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

ProcessCloneVolumeFiles — Class in namespace Biigle\Jobs
ProcessNewImage — Class in namespace Biigle\Jobs
ProcessNewVideo — Class in namespace Biigle\Jobs
ProcessNewVolumeFiles — Class 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.

Publish — Class 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.

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

Get the services provided by the provider.

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

Get the services provided by the provider.

ProjectImageAnnotationLabelController — Class in namespace Biigle\Modules\Geo\Http\Controllers\Api
ProjectController — Class in namespace Biigle\Modules\Geo\Http\Controllers\Views
Publish — Class in namespace Biigle\Modules\Laserpoints\Console\Commands
ProcessDelphiJob — Class in namespace Biigle\Modules\Laserpoints\Jobs
ProcessImageDelphiJob — Class in namespace Biigle\Modules\Laserpoints\Jobs
ProcessImageManualJob — Class in namespace Biigle\Modules\Laserpoints\Jobs
ProcessManualJob — Class in namespace Biigle\Modules\Laserpoints\Jobs
$ ProcessManualJob#points — Property in class ProcessManualJob

Laser point coordinates for the image.

ProcessVolumeDelphiJob — Class 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.

PruneOldEmbeddings — Class in namespace Biigle\Modules\MagicSam\Console\Commands
GenerateEmbedding::prepareTileLoadingInfo() — Method in class GenerateEmbedding

Prepare all information needed for loading Zoomify tiles.

Publish — Class in namespace Biigle\Modules\Maia\Console\Commands
PrepareKnowledgeTransferException — Class in namespace Biigle\Modules\Maia\Exceptions
$ UpdateTrainingProposal#proposal — Property 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.

PrepareAnnotationsJob — Class in namespace Biigle\Modules\Maia\Jobs
PrepareExistingAnnotations — Class in namespace Biigle\Modules\Maia\Jobs
PrepareKnowledgeTransfer — Class in namespace Biigle\Modules\Maia\Jobs
ProcessNewAnnotationCandidates — Class in namespace Biigle\Modules\Maia\Jobs
ProcessNewTrainingProposals — Class in namespace Biigle\Modules\Maia\Jobs
ProcessNoveltyDetectedImage — Class in namespace Biigle\Modules\Maia\Jobs
ProcessObjectDetectedImage — Class in namespace Biigle\Modules\Maia\Jobs
PrepareDeleteAnnotationPatches — Class in namespace Biigle\Modules\Maia\Listeners
PruneTrainingProposalFeatureVectors — Class in namespace Biigle\Modules\Maia\Listeners
PruneTrainingProposalPatches — Class 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.

$ Annotation#points — Property in class Annotation
CocoParser::processImageAnnotations() — Method in class CocoParser
Info::parseYear() — Method in class Info

Parse year value to int or null, handling both string and int inputs

Converter::parseHandle() — Method in class Converter
PruneStaleSubscribers — Class 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.

PythonException — Class in namespace Biigle\Modules\Ptp\Exceptions
PtpController — Class in namespace Biigle\Modules\Ptp\Http\Controllers\Api

Controller used for creating a PTP Job Chain

PtpJob — Class in namespace Biigle\Modules\Ptp\Jobs
PtpJob::python() — Method in class PtpJob

Run the python script for Point to Polygon conversion

PtpJob::processNewAnnotations() — Method in class PtpJob

Generate annotation chunks for new annotations

PtpJobConcluded — Class in namespace Biigle\Modules\Ptp\Notifications
PtpJobFailed — Class in namespace Biigle\Modules\Ptp\Notifications
PtpServiceProvider — Class in namespace Biigle\Modules\Ptp
PruneExpiredUserDisks — Class in namespace Biigle\Modules\UserDisks\Console\Commands
StoreUserDisk::prepareForValidation() — Method in class StoreUserDisk

Prepare the data for validation.

UpdateUserDisk::prepareForValidation() — Method in class UpdateUserDisk

Prepare the data for validation.

PruneExpiredStorageRequests — Class in namespace Biigle\Modules\UserStorage\Console\Commands
PruneStaleStorageRequests — Class in namespace Biigle\Modules\UserStorage\Console\Commands
StoreStorageRequestFile::prepareForValidation() — Method in class StoreStorageRequestFile

Prepare the data for validation.

$ DeleteStorageRequestDirectory#path — Property in class DeleteStorageRequestDirectory

Directory path to be deleted.

$ DeleteStorageRequestDirectory#pending — Property in class DeleteStorageRequestDirectory

Whether the request of the file was pending or not.

$ DeleteStorageRequestFile#path — Property in class DeleteStorageRequestFile

Path of the file to be deleted.

$ DeleteStorageRequestFile#pending — Property in class DeleteStorageRequestFile

Whether the request of the file was pending or not.

$ DeleteStorageRequestFile#prefix — Property in class DeleteStorageRequestFile

Directory prefix of the storage request.

FilePrefix::passes() — Method in class FilePrefix

Determine if the validation rule passes.

$ ChunkedFileStreamPump#path — Property in class ChunkedFileStreamPump

Base path of the storage request file.

ProjectObserver — Class in namespace Biigle\Observers
PendingVolume — Class in namespace Biigle
PendingVolume::project() — Method in class PendingVolume
PendingVolumePolicy — Class in namespace Biigle\Policies
ProjectInvitationPolicy — Class in namespace Biigle\Policies
ProjectPolicy — Class in namespace Biigle\Policies
Project — Class in namespace Biigle
Project::pendingVolumes() — Method in class Project

The pending volumes of this project.

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

The project to which this invitation belongs.

$ AuthServiceProvider#policies — Property in class AuthServiceProvider

The policy mappings for the application.

PulseQueueSizeCardServiceProvider — Class in namespace Biigle\PulseQueueSizeCard
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.

VolumeUrl::pathHasDirectoryTraversal() — Method in class VolumeUrl

Determine if the given path has a directory traversal

PublicLabelExport — Class in namespace Biigle\Services\Export
PublicLabelTreeExport — Class in namespace Biigle\Services\Export
ArchiveManager::prune() — Method in class ArchiveManager

Delete uploaded import files that are older than one week.

$ Import#path — Property in class Import

Path to the directory with the import files.

LabelTreeImport::perform() — Method in class LabelTreeImport

Perform the import.

PublicLabelTreeImport — Class in namespace Biigle\Services\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.

LabelBotService::performVectorSearch() — Method in class LabelBotService

Perform vector search using the ANN-Iterative-Fallback technique (ANN-Itr-FB).

LabelBotService::performAnnSearch() — Method in class LabelBotService

Perform Approximate Nearest Neighbor (ANN) search using the HNSW index with Post-Subquery Filtering (PSF).

WormsAdapter::parseItem() — Method in class WormsAdapter

Parse a WoRMS item to the internal representation.

CsvParser::processFirstLine() — Method in class CsvParser
ParserFactory — Class in namespace Biigle\Services\MetadataParsing
$ ParserFactory#parsers — Property in class ParserFactory
CsvFile::putCsv() — Method in class CsvFile

Append a new row to the CSV file.

$ File#path — Property in class File

File path.

File::put() — Method in class File

Add content to the file.

ProjectImageReportGenerator — Class in namespace Biigle\Services\Reports\Projects
ProjectReportGenerator — Class in namespace Biigle\Services\Reports\Projects
ProjectVideoReportGenerator — Class in namespace Biigle\Services\Reports\Projects
IfdoReportGenerator::processFiles() — Method in class IfdoReportGenerator

Create the image-set-item entries for the images or videos.

AreaReportGenerator::parseRows() — Method in class AreaReportGenerator

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

ImageIfdoReportGenerator::processFiles() — Method in class ImageIfdoReportGenerator

Create the image-set-item entries for the images or videos.

ImageIfdoReportGenerator::processFile() — Method in class ImageIfdoReportGenerator

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

PythonScriptRunner — Class in namespace Biigle\Services\Reports\Volumes
VideoIfdoReportGenerator::processFiles() — Method in class VideoIfdoReportGenerator

Create the image-set-item entries for the images or videos.

VideoIfdoReportGenerator::processFile() — Method in class VideoIfdoReportGenerator

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

$ VolumeReportGenerator#pythonScriptRunner — Property in class VolumeReportGenerator

Object that runs the Python script to generate a report.

Shape::point() — Method in class Shape
Shape::pointId() — Method in class Shape
Shape::polygon() — Method in class Shape
Shape::polygonId() — Method in class Shape
PatchedQueueWorker — Class in namespace Biigle\Support
User::projects() — Method in class User

The projects, this user is a member of.

Visibility::public() — Method in class Visibility
Visibility::publicId() — Method in class Visibility
Visibility::private() — Method in class Visibility
Visibility::privateId() — Method in class Visibility
Volume::parseFilesQueryString() — Method in class Volume

Parses a comma separated list of filenames to an array.

Volume::projects() — Method in class Volume

The project(s), this volume belongs to.

$ WebDAVAdapter#prefixer — Property in class WebDAVAdapter

Q

$ GenerateMissing#queue — Property in class GenerateMissing

Queue to push process jobs to. If null, the default queue of each job is used.

$ LargoSessionFailed#queue — Property in class LargoSessionFailed

The name of the queue the job should be sent to.

$ LargoSessionSaved#queue — Property in class LargoSessionSaved

The name of the queue the job should be sent to.

$ ApplyLargoSession#queue — Property in class ApplyLargoSession

The queue to push this job to.

$ EmbeddingAvailable#queue — Property in class EmbeddingAvailable

The name of the queue the job should be sent to.

$ EmbeddingFailed#queue — Property in class EmbeddingFailed

The name of the queue the job should be sent to.

QueriesExistingAnnotations — Class in namespace Biigle\Modules\Maia\Traits
QueueServiceProvider — Class in namespace Biigle\Providers
QueueSize — Class in namespace Biigle\PulseQueueSizeCard\Http\Livewire
QueueSize — Class in namespace Biigle\PulseQueueSizeCard\Recorders
AbundanceReportGenerator::query() — Method in class AbundanceReportGenerator

Assemble a new DB query for the volume of this report.

AnnotationLocationReportGenerator::query() — Method in class AnnotationLocationReportGenerator

Assemble a new DB query for the volume of this report.

AreaReportGenerator::query() — Method in class AreaReportGenerator

Assemble a new DB query for the volume of this report.

BasicReportGenerator::query() — Method in class BasicReportGenerator

Assemble a new DB query for the volume of this report.

CocoReportGenerator::query() — Method in class CocoReportGenerator

Assemble a new DB query for the volume of this report.

CsvReportGenerator::query() — Method in class CsvReportGenerator

Assemble a new DB query for the volume of this report.

ExtendedReportGenerator::query() — Method in class ExtendedReportGenerator

Assemble a new DB query for the volume of this report.

FullReportGenerator::query() — Method in class FullReportGenerator

Assemble a new DB query for the volume of this report.

ImageLocationReportGenerator::query() — Method in class ImageLocationReportGenerator

Assemble a new DB query for the volume of this report.

ImageIfdoReportGenerator::query() — Method in class ImageIfdoReportGenerator

Assemble a new DB query for the volume of this report.

BasicReportGenerator::query() — Method in class BasicReportGenerator

Assemble a new DB query for the volume of this report.

CsvReportGenerator::query() — Method in class CsvReportGenerator

Assemble a new DB query for the volume of this report.

ImageLocationReportGenerator::query() — Method in class ImageLocationReportGenerator

Assemble a new DB query for the volume of this report.

CsvReportGenerator::query() — Method in class CsvReportGenerator

Assemble a new DB query for the video of this report.

VideoIfdoReportGenerator::query() — Method in class VideoIfdoReportGenerator

Assemble a new DB query for the volume of this report.

CsvReportGenerator::query() — Method in class CsvReportGenerator

Assemble a new DB query for the volume of this report.

R

LabelbotIndexProgress::runQuery() — Method in class LabelbotIndexProgress
Handler::register() — Method in class Handler

Register the exception handling callbacks for the application.

FileCache::runBatch() — Method in class FileCache

Retrieve the files, run the callback with their paths and clean up the reference links afterwards.

FileCache::retrieve() — Method in class FileCache

Cache a remote or cloud storage file if it is not cached and get the path to the cached file. If the file is local, nothing will be done and the path to the local file will be returned.

FileCache::retrieveExistingFile() — Method in class FileCache

Get path and reference link for a file that exists in the cache.

FileCache::retrieveNewFile() — Method in class FileCache

Get path and reference link for a file that does not yet exist in the cache.

FileCache::referenceLinkToken() — Method in class FileCache

Extract the owning process' lock token from a reference link filename.

FileCache::refsDir() — Method in class FileCache

Get the directory in which reference links are stored.

FileCacheServiceProvider::register() — Method in class FileCacheServiceProvider

Register the service provider.

FileCacheServiceProvider::registerScheduledPruneCommand() — Method in class FileCacheServiceProvider

Register the scheduled command to prune the file cache.

ReportsController — Class in namespace Biigle\Http\Controllers\Api
RoleController — Class in namespace Biigle\Http\Controllers\Api
UserRegistrationController::reject() — Method in class UserRegistrationController

Reject a user sign up.

BrowserController::removePrefix() — Method in class BrowserController

Removes a prefix from all strings in an array.

$ LoginController#redirectTo — Property in class LoginController

Where to redirect users after login / registration.

RegisterController — Class in namespace Biigle\Http\Controllers\Auth
$ RegisterController#redirectTo — Property in class RegisterController

Where to redirect users after login / registration.

RegisterController::register() — Method in class RegisterController

Handle a registration request for the application.

RegisterController::registered() — Method in class RegisterController

The user has been registered.

ResetPasswordController — Class in namespace Biigle\Http\Controllers\Auth
ResetPasswordController::rules() — Method in class ResetPasswordController

Get the password reset validation rules.

UsersController::roleClassMap() — Method in class UsersController

Determines the Boostrap label class for a role label.

Authenticate::redirectTo() — Method in class Authenticate

Get the path the user should be redirected to when they are not authenticated.

AuthenticateRegister::redirectTo() — Method in class AuthenticateRegister

Get the path the user should be redirected to when they are not authenticated.

RedirectIfAuthenticated — Class in namespace Biigle\Http\Middleware
AttachProjectUser::rules() — Method in class AttachProjectUser

Get the validation rules that apply to the request.

CloneVolume::rules() — Method in class CloneVolume

Get the validation rules that apply to the request.

DestroyAnnotationSession::rules() — Method in class DestroyAnnotationSession

Get the validation rules that apply to the request.

DestroyLabel::rules() — Method in class DestroyLabel

Get the validation rules that apply to the request.

DestroyLabelTree::rules() — Method in class DestroyLabelTree

Get the validation rules that apply to the request.

DestroyLabelTreeUser::rules() — Method in class DestroyLabelTreeUser

Get the validation rules that apply to the request.

DestroyLabelTreeVersion::rules() — Method in class DestroyLabelTreeVersion

Get the validation rules that apply to the request.

DestroyPinnedProject::rules() — Method in class DestroyPinnedProject

Get the validation rules that apply to the request.

DestroyProjectUser::rules() — Method in class DestroyProjectUser

Get the validation rules that apply to the request.

DestroyUser::rules() — Method in class DestroyUser

Get the validation rules that apply to the request.

DestroyVideoAnnotationLabel::rules() — Method in class DestroyVideoAnnotationLabel

Get the validation rules that apply to the request.

DestroyVolumeFile::rules() — Method in class DestroyVolumeFile

Get the validation rules that apply to the request.

$ IndexProjectAnnotationsSimilarity#reference — Property in class IndexProjectAnnotationsSimilarity

The reference annotation for sorting.

IndexProjectAnnotationsSimilarity::rules() — Method in class IndexProjectAnnotationsSimilarity

Get the validation rules that apply to the request.

$ IndexVolumeAnnotationsSimilarity#reference — Property in class IndexVolumeAnnotationsSimilarity

The reference annotation for sorting.

IndexVolumeAnnotationsSimilarity::rules() — Method in class IndexVolumeAnnotationsSimilarity

Get the validation rules that apply to the request.

JoinProjectInvitation::rules() — Method in class JoinProjectInvitation

Get the validation rules that apply to the request.

LinkVideoAnnotation::rules() — Method in class LinkVideoAnnotation

Get the validation rules that apply to the request.

ShowExport::rules() — Method in class ShowExport
ShowPublicLabelTreeExport::rules() — Method in class ShowPublicLabelTreeExport

Get the validation rules that apply to the request.

SplitVideoAnnotation::rules() — Method in class SplitVideoAnnotation

Get the validation rules that apply to the request.

StoreAnnotationSession::rules() — Method in class StoreAnnotationSession

Get the validation rules that apply to the request.

StoreAnnouncement::rules() — Method in class StoreAnnouncement

Get the validation rules that apply to the request.

StoreFederatedSearchInstance::rules() — Method in class StoreFederatedSearchInstance

Get the validation rules that apply to the request.

StoreImageAnnotation::rules() — Method in class StoreImageAnnotation

Get the validation rules that apply to the request.

StoreImageAnnotationLabel::rules() — Method in class StoreImageAnnotationLabel

Get the validation rules that apply to the request.

StoreImageAnnotations::rules() — Method in class StoreImageAnnotations

Get the validation rules that apply to the request.

StoreLabel::rules() — Method in class StoreLabel

Get the validation rules that apply to the request.

StoreLabelTree::rules() — Method in class StoreLabelTree

Get the validation rules that apply to the request.

StoreLabelTreeAuthorizedProject::rules() — Method in class StoreLabelTreeAuthorizedProject

Get the validation rules that apply to the request.

$ StoreLabelTreeMerge#remove — Property in class StoreLabelTreeMerge

Array of label IDs to remove.

StoreLabelTreeMerge::rules() — Method in class StoreLabelTreeMerge

Get the validation rules that apply to the request.

StoreLabelTreeUser::rules() — Method in class StoreLabelTreeUser

Get the validation rules that apply to the request.

StoreLabelTreeVersion::rules() — Method in class StoreLabelTreeVersion

Get the validation rules that apply to the request.

StoreLargoSession::rules() — Method in class StoreLargoSession

Get the validation rules that apply to the request.

StorePendingVolume::rules() — Method in class StorePendingVolume

Get the validation rules that apply to the request.

StorePendingVolumeFromVolume::rules() — Method in class StorePendingVolumeFromVolume

Get the validation rules that apply to the request.

StorePendingVolumeImport::rules() — Method in class StorePendingVolumeImport

Get the validation rules that apply to the request.

StorePinnedProject::rules() — Method in class StorePinnedProject

Get the validation rules that apply to the request.

StoreProject::rules() — Method in class StoreProject

Get the validation rules that apply to the request.

StoreProjectInvitation::rules() — Method in class StoreProjectInvitation

Get the validation rules that apply to the request.

StoreProjectLabelTree::rules() — Method in class StoreProjectLabelTree

Get the validation rules that apply to the request.

StoreProjectReport::rules() — Method in class StoreProjectReport

Get the validation rules that apply to the request.

StoreReport::rules() — Method in class StoreReport

Get the validation rules that apply to the request.

StoreUser::rules() — Method in class StoreUser

Get the validation rules that apply to the request.

StoreVideoAnnotation::rules() — Method in class StoreVideoAnnotation

Get the validation rules that apply to the request.

StoreVideoAnnotationLabel::rules() — Method in class StoreVideoAnnotationLabel

Get the validation rules that apply to the request.

StoreVolume::rules() — Method in class StoreVolume

Get the validation rules that apply to the request.

StoreVolumeFile::rules() — Method in class StoreVolumeFile

Get the validation rules that apply to the request.

StoreVolumeFileLabel::rules() — Method in class StoreVolumeFileLabel

Get the validation rules that apply to the request.

StoreVolumeMetadata::rules() — Method in class StoreVolumeMetadata

Get the validation rules that apply to the request.

StoreVolumeReport::rules() — Method in class StoreVolumeReport

Get the validation rules that apply to the request.

UpdateAnnotationSession::rules() — Method in class UpdateAnnotationSession

Get the validation rules that apply to the request.

UpdateFederatedSearchInstance::rules() — Method in class UpdateFederatedSearchInstance

Get the validation rules that apply to the request.

UpdateImageAnnotation::rules() — Method in class UpdateImageAnnotation

Get the validation rules that apply to the request.

UpdateLabel::rules() — Method in class UpdateLabel

Get the validation rules that apply to the request.

UpdateLabelTree::rules() — Method in class UpdateLabelTree

Get the validation rules that apply to the request.

UpdateLabelTreeUser::rules() — Method in class UpdateLabelTreeUser

Get the validation rules that apply to the request.

UpdateLabelTreeVersion::rules() — Method in class UpdateLabelTreeVersion

Get the validation rules that apply to the request.

UpdateOwnUser::rules() — Method in class UpdateOwnUser

Get the validation rules that apply to the request.

UpdatePendingVolume::rules() — Method in class UpdatePendingVolume

Get the validation rules that apply to the request.

UpdatePendingVolumeAnnotationLabels::rules() — Method in class UpdatePendingVolumeAnnotationLabels

Get the validation rules that apply to the request.

UpdatePendingVolumeFileLabels::rules() — Method in class UpdatePendingVolumeFileLabels

Get the validation rules that apply to the request.

UpdatePendingVolumeLabelMap::rules() — Method in class UpdatePendingVolumeLabelMap

Get the validation rules that apply to the request.

UpdatePendingVolumeUserMap::rules() — Method in class UpdatePendingVolumeUserMap

Get the validation rules that apply to the request.

UpdateProject::rules() — Method in class UpdateProject

Get the validation rules that apply to the request.

UpdateProjectUser::rules() — Method in class UpdateProjectUser

Get the validation rules that apply to the request.

UpdateUser::rules() — Method in class UpdateUser

Get the validation rules that apply to the request.

UpdateUserSettings::rules() — Method in class UpdateUserSettings

Get the validation rules that apply to the request.

UpdateVideoAnnotation::rules() — Method in class UpdateVideoAnnotation

Get the validation rules that apply to the request.

UpdateVolume::rules() — Method in class UpdateVolume

Get the validation rules that apply to the request.

Ifdo::revalidate() — Method in class Ifdo
$ GenerateReportJob#report — Property in class GenerateReportJob

The report that should be generated.

ProcessAnnotatedFile::redispatch() — Method in class ProcessAnnotatedFile

Dispatch a copy of this job with a delay.

RemoveAnnotationPatches — Class in namespace Biigle\Jobs
RemoveImageAnnotationPatches — Class in namespace Biigle\Jobs
RemoveVideoAnnotationPatches — Class in namespace Biigle\Jobs
LabelTree::replicateLabelsOf() — Method in class LabelTree

Replicate all labels of one label tree to this one.

AnanasServiceProvider::register() — Method in class AnanasServiceProvider

Register the service provider.

AnnotationAssistanceRequest::receiver() — Method in class AnnotationAssistanceRequest

The (optional) user that should receive the assistance request.

AnnotationAssistanceRequestController::respond() — Method in class AnnotationAssistanceRequestController

Respond to an assistance request.

StoreAnnotationAssistanceRequest::rules() — Method in class StoreAnnotationAssistanceRequest

Get the validation rules that apply to the request.

StoreAnnotationAssistanceRequest::rateLimitApplies() — Method in class StoreAnnotationAssistanceRequest

Check if the rate limit of creating new requests applies.

UpdateAnnotationAssistanceRequest::rules() — Method in class UpdateAnnotationAssistanceRequest

Get the validation rules that apply to the request.

$ AnnotationAssistanceRequest#request — Property in class AnnotationAssistanceRequest

The annotation assistance request.

LSLoginController::redirect() — Method in class LSLoginController

Redirect to the authentication provider

RegisterController — Class in namespace Biigle\Modules\AuthLSLogin\Http\Controllers
RegisterController::register() — Method in class RegisterController

Handle a registration request for the application.

RegisterController::registered() — Method in class RegisterController

The user has been registered.

LSLoginServiceProvider::register() — Method in class LSLoginServiceProvider

Register the service provider.

NfdiLoginController::redirect() — Method in class NfdiLoginController

Redirect to the authentication provider

RegisterController — Class in namespace Biigle\Modules\AuthNfdi\Http\Controllers
RegisterController::register() — Method in class RegisterController

Handle a registration request for the application.

RegisterController::registered() — Method in class RegisterController

The user has been registered.

ServiceProvider::register() — Method in class ServiceProvider

Register the service provider.

ColorSortServiceProvider::register() — Method in class ColorSortServiceProvider

Register the service provider.

StoreColorSortSequence::rules() — Method in class StoreColorSortSequence

Get the validation rules that apply to the request.

DemoServiceProvider::register() — Method in class DemoServiceProvider

Register the service provider.

DemoProjectController::replicateVolume() — Method in class DemoProjectController

Replicate a volume.

DenbiServiceServiceProvider::register() — Method in class DenbiServiceServiceProvider

Register the service provider.

GeoServiceProvider::register() — Method in class GeoServiceProvider

Register the service provider.

RequestController — Class in namespace Biigle\Modules\Kpis\Http\Controllers\Api
StoreRequest::rules() — Method in class StoreRequest

Get the validation rules that apply to the request.

KpisServiceProvider::register() — Method in class KpisServiceProvider

Register the service provider.

Requests — Class in namespace Biigle\Modules\Kpis
ComputeImage::rules() — Method in class ComputeImage

Get the validation rules that apply to the request.

ComputeVolume::rules() — Method in class ComputeVolume

Get the validation rules that apply to the request.

Image::readyForManualDetection() — Method in class Image

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

LaserpointsServiceProvider::register() — Method in class LaserpointsServiceProvider

Register the service provider.

Volume::readyForDelphiDetection() — Method in class Volume

Determines if the images of this volume can be processed with Delphi.

StoreImageEmbeddingRequest::rules() — Method in class StoreImageEmbeddingRequest

Get the validation rules that apply to the request.

MagicSamServiceProvider::register() — Method in class MagicSamServiceProvider

Register the service provider.

ContinueMaiaJob::rules() — Method in class ContinueMaiaJob

Get the validation rules that apply to the request.

DestroyMaiaJob::rules() — Method in class DestroyMaiaJob

Get the validation rules that apply to the request.

StoreMaiaJob::rules() — Method in class StoreMaiaJob

Get the validation rules that apply to the request.

SubmitAnnotationCandidates::rules() — Method in class SubmitAnnotationCandidates

Get the validation rules that apply to the request.

UpdateAnnotationCandidate::rules() — Method in class UpdateAnnotationCandidate

Get the validation rules that apply to the request.

UpdateTrainingProposal::rules() — Method in class UpdateTrainingProposal

Get the validation rules that apply to the request.

ProcessNoveltyDetectedImage::redispatch() — Method in class ProcessNoveltyDetectedImage

Dispatch a copy of this job with a delay.

ProcessObjectDetectedImage::redispatch() — Method in class ProcessObjectDetectedImage

Dispatch a copy of this job with a delay.

MaiaJob::requiresAction() — Method in class MaiaJob

Determine if the job requires a user action to continue

MaiaServiceProvider::register() — Method in class MaiaServiceProvider

Register the service provider.

CocoParser::recognizesFile() — Method in class CocoParser

Returns true if the file is in the format understood by the parser.

MetadataCocoServiceProvider::register() — Method in class MetadataCocoServiceProvider

Register the service provider.

IfdoParser::recognizesFile() — Method in class IfdoParser

Returns true if the file is in the format understood by the parser.

MetadataIfdoServiceProvider::register() — Method in class MetadataIfdoServiceProvider

Register the service provider.

MetricsServiceProvider::register() — Method in class MetricsServiceProvider

Register the service provider.

RegisterControllerMixin — Class in namespace Biigle\Modules\Newsletter\Http\Controllers\Mixins
DestroyNewsletterSubscriber::rules() — Method in class DestroyNewsletterSubscriber

Get the validation rules that apply to the request.

StoreNewsletter::rules() — Method in class StoreNewsletter

Get the validation rules that apply to the request.

StoreNewsletterSubscriber::rules() — Method in class StoreNewsletterSubscriber

Get the validation rules that apply to the request.

UpdateNewsletter::rules() — Method in class UpdateNewsletter

Get the validation rules that apply to the request.

NewsletterServiceProvider::register() — Method in class NewsletterServiceProvider

Register the service provider.

PtpServiceProvider::register() — Method in class PtpServiceProvider

Register the service provider.

RefreshDCacheTokens — Class in namespace Biigle\Modules\UserDisks\Console\Commands
ExtendUserDisk::rules() — Method in class ExtendUserDisk

Get the validation rules that apply to the request.

StoreUserDisk::rules() — Method in class StoreUserDisk

Get the validation rules that apply to the request.

UpdateUserDisk::rules() — Method in class UpdateUserDisk

Get the validation rules that apply to the request.

UserDisk::refreshDCacheToken() — Method in class UserDisk

Refresh the dcache access and refresh tokens.

UserDisksServiceProvider::register() — Method in class UserDisksServiceProvider

Register the service provider.

StorageRequestController::reject() — Method in class StorageRequestController

Reject a storage request

StorageRequestController::review() — Method in class StorageRequestController

Show the view to review a storage request.

ApproveStorageRequest::rules() — Method in class ApproveStorageRequest

Get the validation rules that apply to the request.

DestroyStorageRequestDirectory::rules() — Method in class DestroyStorageRequestDirectory

Get the validation rules that apply to the request.

DestroyStorageRequestFile::rules() — Method in class DestroyStorageRequestFile

Get the validation rules that apply to the request.

ExtendStorageRequest::rules() — Method in class ExtendStorageRequest

Get the validation rules that apply to the request.

RejectStorageRequest — Class in namespace Biigle\Modules\UserStorage\Http\Requests
RejectStorageRequest::rules() — Method in class RejectStorageRequest

Get the validation rules that apply to the request.

StoreStorageRequest::rules() — Method in class StoreStorageRequest

Get the validation rules that apply to the request.

StoreStorageRequestFile::rules() — Method in class StoreStorageRequestFile

Get the validation rules that apply to the request.

UpdateStorageRequest::rules() — Method in class UpdateStorageRequest

Get the validation rules that apply to the request.

$ ApproveStorageRequest#request — Property in class ApproveStorageRequest

The storage request to confirm

$ StorageRequestApproved#request — Property in class StorageRequestApproved

The storage request that was confirmed

$ StorageRequestExpiresSoon#request — Property in class StorageRequestExpiresSoon

The storage request that was confirmed

$ StorageRequestRejected#reason — Property in class StorageRequestRejected

Reason why the request was rejected.

$ StorageRequestSubmitted#request — Property in class StorageRequestSubmitted

The storage request that was submitted

StorageRequestPolicy::reject() — Method in class StorageRequestPolicy

Determine if the given user can reject the storage request.

StorageRequestFile::request() — Method in class StorageRequestFile

The request to which this file belongs.

UserStorageServiceProvider::register() — Method in class UserStorageServiceProvider

Register the service provider.

RegistrationAccepted — Class in namespace Biigle\Notifications
RegistrationConfirmation — Class in namespace Biigle\Notifications
RegistrationRejected — Class in namespace Biigle\Notifications
ReportReady — Class in namespace Biigle\Notifications
$ ReportReady#report — Property in class ReportReady

The report that is ready.

ReportObserver — Class in namespace Biigle\Observers
CachedPolicy::remember() — Method in class CachedPolicy

Wrapper for the Cache::remember function of the array cache.

LabelTreePolicy::removeMember() — Method in class LabelTreePolicy

Determine if the user can remove the given member from the given label tree.

ProjectPolicy::removeMember() — Method in class ProjectPolicy

Determine if user can remove the given project member from the given project.

ReportPolicy — Class in namespace Biigle\Policies
Project::removeUserId() — Method in class Project

Removes the user by ID from this project.

Project::removeVolume() — Method in class Project

Detaches the volume from this project. Fails if this is the last project, the volume is attached to, unless force is true.

Project::removeAllVolumes() — Method in class Project

Detaches all volumes from this project. Fails if this is the last project, one of the volumes is attached to, unless force is true.

AppServiceProvider::register() — Method in class AppServiceProvider

Register any application services.

QueueServiceProvider::registerWorker() — Method in class QueueServiceProvider

Register the queue worker.

RouteServiceProvider — Class in namespace Biigle\Providers
QueueSize::render() — Method in class QueueSize
PulseQueueSizeCardServiceProvider::register() — Method in class PulseQueueSizeCardServiceProvider

Register any application services.

QueueSize::record() — Method in class QueueSize

Record the job.

Report — Class in namespace Biigle
$ Report#reportGenerator — Property in class Report

The report generator for this report.

ReportType — Class in namespace Biigle
Role — Class in namespace Biigle

A role of a user. Users have one global role and can have many project- specific roles.

CsvParser::recognizesFile() — Method in class CsvParser

Returns true if the file is in the format understood by the parser.

MetadataParser::recognizesFile() — Method in class MetadataParser

Returns true if the file is in the format understood by the parser.

Modules::register() — Method in class Modules

Register module assets in one step.

Modules::registerViewMixin() — Method in class Modules

Registers a new view mixin of a module for a view.

Modules::registerControllerMixin() — Method in class Modules

Registers a new controller mixin of a module.

$ AbundanceReportGenerator#reportClass — Property in class AbundanceReportGenerator

The class of the volume report to use for this project report.

$ AnnotationLocationReportGenerator#reportClass — Property in class AnnotationLocationReportGenerator

The class of the volume report to use for this project report.

$ AreaReportGenerator#reportClass — Property in class AreaReportGenerator

The class of the volume report to use for this project report.

$ BasicReportGenerator#reportClass — Property in class BasicReportGenerator

The class of the volume report to use for this project report.

$ CocoReportGenerator#reportClass — Property in class CocoReportGenerator

The class of the volume report to use for this project report.

$ CsvReportGenerator#reportClass — Property in class CsvReportGenerator

The class of the volume report to use for this project report.

$ ExtendedReportGenerator#reportClass — Property in class ExtendedReportGenerator

The class of the volume report to use for this project report.

$ FullReportGenerator#reportClass — Property in class FullReportGenerator

The class of the volume report to use for this project report.

$ ImageLocationReportGenerator#reportClass — Property in class ImageLocationReportGenerator

The class of the volume report to use for this project report.

$ ImageIfdoReportGenerator#reportClass — Property in class ImageIfdoReportGenerator

The class of the volume report to use for this project report.

$ BasicReportGenerator#reportClass — Property in class BasicReportGenerator

The class of the volume report to use for this project report.

$ CsvReportGenerator#reportClass — Property in class CsvReportGenerator

The class of the volume report to use for this project report.

$ ImageLocationReportGenerator#reportClass — Property in class ImageLocationReportGenerator

The class of the volume report to use for this project report.

$ ProjectReportGenerator#reportClass — Property in class ProjectReportGenerator

The class of the report generator to use for this project report.

$ CsvReportGenerator#reportClass — Property in class CsvReportGenerator

The class of the video report to use for this project report.

$ VideoIfdoReportGenerator#reportClass — Property in class VideoIfdoReportGenerator

The class of the volume report to use for this project report.

$ CsvReportGenerator#reportClass — Property in class CsvReportGenerator

The class of the volume report to use for this project report.

ReportGenerator — Class in namespace Biigle\Services\Reports
AnnotationReportGenerator::restrictToAnnotationSessionQuery() — Method in class AnnotationReportGenerator

Callback to be used in a when query statement that restricts the resulting annotation labels to the annotation session of this report.

PythonScriptRunner::run() — Method in class PythonScriptRunner

Execute the external report parsing Python script.

CsvReportGenerator::restrictToAnnotationSessionQuery() — Method in class CsvReportGenerator

Callback to be used in a when query statement that restricts the resulting annotation labels to the annotation session of this report.

VolumeReportGenerator::restrictToLabelsQuery() — Method in class VolumeReportGenerator

Callback to be used in a when query statement that restricts the results to a specific subset of annotation labels.

Shape::rectangle() — Method in class Shape
Shape::rectangleId() — Method in class Shape
RestrictsToExportArea — Class in namespace Biigle\Traits
RestrictsToExportArea::restrictToExportAreaQuery() — Method in class RestrictsToExportArea

Callback to be used in a when query statement that restricts the resulting annotations to the export area of the reansect of this report (if there is any).

RestrictsToNewestLabels — Class in namespace Biigle\Traits
RestrictsToNewestLabels::restrictToNewestLabelQuery() — Method in class RestrictsToNewestLabels

Callback to be used in a when query statement that restricts the results to the newest annotation labels of each annotation.

User::role() — Method in class User

The global role of this user.

VideoAnnotation::rectangleToInterpolationPoints() — Method in class VideoAnnotation

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

WebDAVAdapter::readStream() — Method in class WebDAVAdapter
RemoveGeoOverlaysTable — Class in namespace [Global Namespace]
RenameTable — Class in namespace [Global Namespace]
RenameTransectColumn — Class in namespace [Global Namespace]

S

$ Annotation#shape_id — Property in class Annotation
Annotation::scopeVisibleFor() — Method in class Annotation

Scope a query to only include annotations that are visible for a certain user.

Annotation::scopeWithLabel() — Method in class Annotation

Scope a query to only include annotations that have a certain label attached.

Annotation::scopeAllowedBySession() — Method in class Annotation

Scope a query to only include annotations allowed by the session for the user.

Annotation::shape() — Method in class Annotation

The shape of this annotation.

AnnotationSession::setStartsAtAttribute() — Method in class AnnotationSession

Set the start date.

AnnotationSession::setEndsAtAttribute() — Method in class AnnotationSession

Set the end date.

Announcement::scopeActive() — Method in class Announcement

Scope a query to the active announcement.

$ GenerateMissing#signature — Property in class GenerateMissing

The name and signature of the console command.

$ GenerateMissing#skipPatches — Property in class GenerateMissing

Whether to skip checking for missing patches.

$ GenerateMissing#skipVectors — Property in class GenerateMissing

Whether to skip checking for missing feature vectors.

$ GenerateMissing#skipSvgs — Property in class GenerateMissing

Whether to skip checking for missing SVGs.

$ InitializeFeatureVectors#signature — Property in class InitializeFeatureVectors

The name and signature of the console command.

$ LabelbotCreateIndex#signature — Property in class LabelbotCreateIndex

The name and signature of the console command.

$ LabelbotIndexProgress#signature — Property in class LabelbotIndexProgress

The name and signature of the console command.

$ MigrateTiledImages#signature — Property in class MigrateTiledImages

The name and signature of the console command.

$ PruneNotifications#signature — Property in class PruneNotifications

The name and signature of the console command.

SyncPrune — Class in namespace Biigle\Console\Commands
SyncUuids — Class in namespace Biigle\Console\Commands
$ SyncUuids#signature — Property in class SyncUuids

The name and signature of the console command.

$ UpdateVideoMetadata#signature — Property in class UpdateVideoMetadata

The name and signature of the console command.

$ UpdateVolumeUrls#signature — Property in class UpdateVolumeUrls

The name and signature of the console command.

Kernel::schedule() — Method in class Kernel

Define the application's command schedule.

FederatedSearchInstance::scopeWithLocalToken() — Method in class FederatedSearchInstance

Scope a query to all instances that are have a local token.

FederatedSearchInstance::scopeWithRemoteToken() — Method in class FederatedSearchInstance

Scope a query to all instances that are have a remote token.

FederatedSearchInstance::setRemoteTokenAttribute() — Method in class FederatedSearchInstance

Set the remote_token attribute.

FederatedSearchModel::scopeLabelTrees() — Method in class FederatedSearchModel

Scope a query to all models that represent label trees.

FederatedSearchModel::scopeProjects() — Method in class FederatedSearchModel

Scope a query to all models that represent projects.

FederatedSearchModel::scopeVolumes() — Method in class FederatedSearchModel

Scope a query to all models that represent volumes.

FederatedSearchModel::setThumbnailUrlAttribute() — Method in class FederatedSearchModel

Set the model thumbnail url attribute.

FederatedSearchModel::setThumbnailUrlsAttribute() — Method in class FederatedSearchModel

Set the model thumbnail urls attribute.

$ PruneFileCache#signature — Property in class PruneFileCache

The name and signature of the console command.

$ FileCache#storage — Property in class FileCache

File FilesystemManager instance to use

AnnouncementController::store() — Method in class AnnouncementController

Creates a new announcement.

ApiTokenController::store() — Method in class ApiTokenController

Creates a new API token.

Controller::show() — Method in class Controller

Handle a generic export request.

PublicLabelTreeExportController::show() — Method in class PublicLabelTreeExportController

Handle a public label tree export request.

FederatedSearchInstanceController::store() — Method in class FederatedSearchInstanceController

Connect a remote federated search instance.

ImageAnnotationBulkController::store() — Method in class ImageAnnotationBulkController

Create new annotations

ImageAnnotationController::show() — Method in class ImageAnnotationController

Displays the annotation.

ImageAnnotationController::store() — Method in class ImageAnnotationController

Creates a new annotation in the specified image.

ImageAnnotationLabelController::store() — Method in class ImageAnnotationLabelController

Creates a new label for the specified annotation.

ImageController::show() — Method in class ImageController

Shows the specified image.

ImageController::showFile() — Method in class ImageController

Shows the specified image file.

ImageLabelController::store() — Method in class ImageLabelController

Creates a new label for the specified image.

ImportController::store() — Method in class ImportController

Initiate a new import.

PublicLabelTreeImportController::store() — Method in class PublicLabelTreeImportController

Perform a public label tree import.

LabelTreeAuthorizedProjectController::store() — Method in class LabelTreeAuthorizedProjectController

Authorize a project to use a private label tree.

LabelTreeController::show() — Method in class LabelTreeController

Shows a label tree.

LabelTreeController::store() — Method in class LabelTreeController

Creates a new label tree.

LabelTreeLabelController::store() — Method in class LabelTreeLabelController

Add labels to a label tree.

LabelTreeMergeController::store() — Method in class LabelTreeMergeController

Add or remove many labels of a tree.

LabelTreeUserController::store() — Method in class LabelTreeUserController

Add a member to a label tree.

LabelTreeVersionController::store() — Method in class LabelTreeVersionController

Creates a new label tree version.

LinkVideoAnnotationController::store() — Method in class LinkVideoAnnotationController

Link two video annotations

MediaTypeController::show() — Method in class MediaTypeController

Displays the specified media type.

PendingVolumeController::store() — Method in class PendingVolumeController

Creates a new pending volume associated to the specified project.

PendingVolumeController::storeVolume() — Method in class PendingVolumeController

Creates a new pending volume based on an existing volume.

PendingVolumeImportController::storeImport() — Method in class PendingVolumeImportController

Perform the metadata annotation and/or file label import.

ProjectController::show() — Method in class ProjectController

Displays the specified project.

ProjectController::store() — Method in class ProjectController

Creates a new project.

ProjectInvitationController::store() — Method in class ProjectInvitationController

Adds a new invitation to the project.

ProjectInvitationController::showQrCode() — Method in class ProjectInvitationController

Get the QR code of an invitation

ProjectLabelTreeController::store() — Method in class ProjectLabelTreeController

Adds a label tree to the specified project.

ProjectReportController::store() — Method in class ProjectReportController

Generate a project report.

ProjectVolumeController::store() — Method in class ProjectVolumeController

Creates a new volume associated to the specified project.

LargoController::save() — Method in class LargoController

Save changes of an Largo session for a project.

SortAnnotationsByOutliersController — Class in namespace Biigle\Http\Controllers\Api\Projects
SortAnnotationsBySimilarityController — Class in namespace Biigle\Http\Controllers\Api\Projects
ReportsController::show() — Method in class ReportsController

Shows the specified report file.

RoleController::show() — Method in class RoleController

Displays the specified role.

ShapeController — Class in namespace Biigle\Http\Controllers\Api
ShapeController::show() — Method in class ShapeController

Displays the specified shape.

SplitVideoAnnotationController — Class in namespace Biigle\Http\Controllers\Api
SplitVideoAnnotationController::store() — Method in class SplitVideoAnnotationController

Split the video annotation

UserController::show() — Method in class UserController

Shows the specified user.

UserController::showOwn() — Method in class UserController

Shows the requesting user.

UserController::store() — Method in class UserController

Creates a new user.

UserPinnedProjectController::store() — Method in class UserPinnedProjectController

Pin a project.

VideoAnnotationController::show() — Method in class VideoAnnotationController

Shows a video annotation.

VideoAnnotationController::store() — Method in class VideoAnnotationController

Creates a new annotation in the specified video.

VideoAnnotationLabelController::store() — Method in class VideoAnnotationLabelController

Attach a label to a video annotation

VideoController::show() — Method in class VideoController

Shows the specified image.

VideoFileController::show() — Method in class VideoFileController

Get a video file.

VideoLabelController::store() — Method in class VideoLabelController

Creates a new label for the specified video.

VisibilityController::show() — Method in class VisibilityController

Displays the specified visibility.

VolumeAnnotationSessionController::store() — Method in class VolumeAnnotationSessionController

Creates a new annotation session for the specified volume.

VolumeController::show() — Method in class VolumeController

Displays the specified volume.

VolumeFileController::store() — Method in class VolumeFileController

Add images/videos to the specified volume.

VolumeReportController::store() — Method in class VolumeReportController

Generate a volume report.

ExportAreaController::show() — Method in class ExportAreaController

Show the export area of the volume.

ExportAreaController::store() — Method in class ExportAreaController

Set the export area.

LargoController::save() — Method in class LargoController

Save changes of an Largo session for a volume.

MetadataController::show() — Method in class MetadataController

Get a metadata file attached to a volume

MetadataController::store() — Method in class MetadataController

Add or update file metadata for a volume.

SortAnnotationsByOutliersController — Class in namespace Biigle\Http\Controllers\Api\Volumes
SortAnnotationsBySimilarityController — Class in namespace Biigle\Http\Controllers\Api\Volumes
StatisticsController — Class in namespace Biigle\Http\Controllers\Api\Volumes
ForgotPasswordController::sendResetLinkEmail() — Method in class ForgotPasswordController

Send a reset link to the given user.

RegisterController::showRegistrationForm() — Method in class RegisterController

Show the application registration form.

ImportController::show() — Method in class ImportController

Shows the import admin page for a specific import which wasn't completed yet.

ImportController::showUserImport() — Method in class ImportController

Show the view for an unfinished user import.

ImportController::showLabelTreeImport() — Method in class ImportController

Show the view for an unfinished label tree import.

ImportController::showVolumeImport() — Method in class ImportController

Show the view for an unfinished volume tree import.

LogsController::show() — Method in class LogsController

Shows a specific logfile.

UsersController::show() — Method in class UsersController

Shows the user information page.

UsersController::showProject() — Method in class UsersController

Add project statistics to the view.

UsersController::showVolume() — Method in class UsersController

Add volume statistics to the view.

UsersController::showAnnotations() — Method in class UsersController

Add annotation statistics to the view.

UsersController::showVideos() — Method in class UsersController

Add project statistics to the view.

AnnotationToolController::show() — Method in class AnnotationToolController

Shows the annotation tool.

ImageAnnotationController::show() — Method in class ImageAnnotationController

Redirect to the annotator link that shows a specified annotation.

HeartbeatController::store() — Method in class HeartbeatController

Do nothing but to keep the CSRF token valid.

ImprintController::show() — Method in class ImprintController

Show the the imprint view.

AnnotationCatalogController::show() — Method in class AnnotationCatalogController

Show the annotation catalog of a label tree.

LabelTreeMembersController::show() — Method in class LabelTreeMembersController

Shows the label tree members.

LabelTreeMergeController::show() — Method in class LabelTreeMergeController

Show the label tree merge page.

LabelTreeProjectsController::show() — Method in class LabelTreeProjectsController

Shows the label tree projects page.

LabelTreeProjectsController::showMasterLabelTree() — Method in class LabelTreeProjectsController

Show the label tree projects page of a master label tree.

LabelTreeProjectsController::showVersionedLabelTree() — Method in class LabelTreeProjectsController

Show the label tree page projects of a versioned label tree.

LabelTreeVersionsController::show() — Method in class LabelTreeVersionsController

Show the label tree version page.

LabelTreesController::show() — Method in class LabelTreesController

Show the label tree page.

LabelTreesController::showMasterLabelTree() — Method in class LabelTreesController

Show the label tree page of a master label tree.

LabelTreesController::showVersionedLabelTree() — Method in class LabelTreesController

Show the label tree page of a versioned label tree.

PrivacyController::show() — Method in class PrivacyController

Show the the privacy view.

ProjectInvitationController::show() — Method in class ProjectInvitationController

Shows the project invitation page.

ProjectLabelTreeController::show() — Method in class ProjectLabelTreeController

Shows the project show page.

ProjectReportsController::show() — Method in class ProjectReportsController

Show the new project reports view.

ProjectStatisticsController::show() — Method in class ProjectStatisticsController

Shows the project statistics page.

ProjectUserController::show() — Method in class ProjectUserController

Shows the project show page.

ProjectsController::show() — Method in class ProjectsController

Shows the project show page v2.

SearchController — Class in namespace Biigle\Http\Controllers\Views
SearchController::searchLabelTrees() — Method in class SearchController

Add label tree results to the search view.

SearchController::searchProjects() — Method in class SearchController

Add project results to the search view.

SearchController::searchVolumes() — Method in class SearchController

Add volume results to the search view.

SearchController::searchAnnotations() — Method in class SearchController

Add image results to the search view.

SearchController::searchVideos() — Method in class SearchController

Add video results to the search view.

SearchController::searchReports() — Method in class SearchController

Add report results to the search view.

SettingsController — Class in namespace Biigle\Http\Controllers\Views
TermsController::show() — Method in class TermsController

Show the the terms view.

VideoAnnotationController::show() — Method in class VideoAnnotationController

Redirect to the annotator link that shows a specified annotation.

VideoController::show() — Method in class VideoController

Show the video annotation tool.

VideoController::showPopup() — Method in class VideoController

Show the popup window of the video annotation tool.

PendingVolumeController::show() — Method in class PendingVolumeController

Shows the pending volume page to continue/finish a new volume.

PendingVolumeController::showAnnotationLabels() — Method in class PendingVolumeController

Show the form to select labels of metadata annotations to import.

PendingVolumeController::showFileLabels() — Method in class PendingVolumeController

Show the form to select labels of metadata file labels to import.

PendingVolumeController::showLabelMap() — Method in class PendingVolumeController

Show the form to select the label map for the metadata import.

PendingVolumeController::showUserMap() — Method in class PendingVolumeController

Show the form to select the user map for the metadata import.

PendingVolumeController::showFinish() — Method in class PendingVolumeController

Show the view to finish the metadata import.

VolumeReportsController::show() — Method in class VolumeReportsController

Show the volumes reports view.

SessionOnly — Class in namespace Biigle\Http\Middleware

Middleware to allow session cookie authentication for the route only.

$ TrustHosts#subdomains — Property in class TrustHosts
$ LinkVideoAnnotation#secondAnnotation — Property in class LinkVideoAnnotation

The second annotation that should be linked.

ShowExport — Class in namespace Biigle\Http\Requests
ShowPublicLabelTreeExport — Class in namespace Biigle\Http\Requests
SplitVideoAnnotation — Class in namespace Biigle\Http\Requests
StoreAnnotationSession — Class in namespace Biigle\Http\Requests
StoreAnnouncement — Class in namespace Biigle\Http\Requests
StoreFederatedSearchInstance — Class in namespace Biigle\Http\Requests
StoreImageAnnotation — Class in namespace Biigle\Http\Requests
StoreImageAnnotationLabel — Class in namespace Biigle\Http\Requests
StoreImageAnnotations — Class in namespace Biigle\Http\Requests
StoreImageLabel — Class in namespace Biigle\Http\Requests
StoreLabel — Class in namespace Biigle\Http\Requests
StoreLabelTree — Class in namespace Biigle\Http\Requests
StoreLabelTreeAuthorizedProject — Class in namespace Biigle\Http\Requests
StoreLabelTreeMerge — Class in namespace Biigle\Http\Requests
StoreLabelTreeUser — Class in namespace Biigle\Http\Requests
StoreLabelTreeVersion — Class in namespace Biigle\Http\Requests
StoreLargoSession — Class in namespace Biigle\Http\Requests
StorePendingVolume — Class in namespace Biigle\Http\Requests
StorePendingVolumeFromVolume — Class in namespace Biigle\Http\Requests
StorePendingVolumeImport — Class in namespace Biigle\Http\Requests
StorePinnedProject — Class in namespace Biigle\Http\Requests
StoreProject — Class in namespace Biigle\Http\Requests
StoreProjectInvitation — Class in namespace Biigle\Http\Requests
StoreProjectLabelTree — Class in namespace Biigle\Http\Requests
StoreProjectLargoSession — Class in namespace Biigle\Http\Requests
StoreProjectReport — Class in namespace Biigle\Http\Requests
StoreReport — Class in namespace Biigle\Http\Requests
StoreUser — Class in namespace Biigle\Http\Requests
StoreVideoAnnotation — Class in namespace Biigle\Http\Requests
StoreVideoAnnotation::shouldTrack() — Method in class StoreVideoAnnotation

Determine if the new annotation should be tracked.

StoreVideoAnnotationLabel — Class in namespace Biigle\Http\Requests
StoreVideoLabel — Class in namespace Biigle\Http\Requests
StoreVolume — Class in namespace Biigle\Http\Requests
StoreVolumeFile — Class in namespace Biigle\Http\Requests
StoreVolumeFileLabel — Class in namespace Biigle\Http\Requests
StoreVolumeLargoSession — Class in namespace Biigle\Http\Requests
StoreVolumeMetadata — Class in namespace Biigle\Http\Requests
StoreVolumeReport — Class in namespace Biigle\Http\Requests
Ifdo::setDebug() — Method in class Ifdo
Image::setTilingInProgressAttribute() — Method in class Image

Set the tilingInProgress attribute.

ImageAnnotation::setPointsAttribute() — Method in class ImageAnnotation

Round the floats of the points array to 2 decimals before saving.

CloneImageThumbnails::shouldBeTiled() — Method in class CloneImageThumbnails

Determine if an image should be tiled.

GenerateFeatureVectors::sendPyworkerRequest() — Method in class GenerateFeatureVectors

Send the PNG image crop to the Python worker and return the feature vector array.

ProcessAnnotatedFile::shouldGiveUpAfterException() — Method in class ProcessAnnotatedFile

Determine if the job should give up trying because the error will likely not be fixed the next time.

ProcessAnnotatedFile::shouldRetryAfterException() — Method in class ProcessAnnotatedFile

Determine if this job should retry instead of fail after an exception

ProcessNewImage::shouldBeTiled() — Method in class ProcessNewImage

Determine if an image should be tiled.

ProcessNewImage::submitTileJob() — Method in class ProcessNewImage

Submit a new tile job if the image needs tiling.

RemoveAnnotationPatches::submitChunkedJobs() — Method in class RemoveAnnotationPatches

Submit more instances of this job that should process smaller chunks.

TileSingleImage::sendRequests() — Method in class TileSingleImage

Upload files to the S3 storage.

Label::scopeUsed() — Method in class Label

Scope a query to used labels.

Label::setColorAttribute() — Method in class Label

Remove the optional '#' from a hexadecimal color.

LabelTree::scopePublicTrees() — Method in class LabelTree

Scope a query to public label trees.

LabelTree::scopePrivateTrees() — Method in class LabelTree

Scope a query to private label trees.

LabelTree::scopeAccessibleBy() — Method in class LabelTree

Scope a query to all trees that are accessible by a user.

LabelTree::scopeWithoutVersions() — Method in class LabelTree

Scope a query to all trees that are not a varsion of another tree.

LabelTree::scopeGlobal() — Method in class LabelTree

Scope a query to all "global" trees.

LabelTreeVersion::setDoiAttribute() — Method in class LabelTreeVersion

Set the doi attribute of this version.

AnnotationAssistanceRequestController::store() — Method in class AnnotationAssistanceRequestController

Create a new annotation assistance request.

ImageController::show() — Method in class ImageController

Shows the image file that belongs to the assistance request.

AnnotationAssistanceRequestController::show() — Method in class AnnotationAssistanceRequestController

Show an assistance request.

StoreAnnotationAssistanceRequest — Class in namespace Biigle\Modules\Ananas\Http\Requests
RegisterController::showRegistrationForm() — Method in class RegisterController

Show the application registration form.

RegisterController::showRegistrationForm() — Method in class RegisterController

Show the application registration form.

ServiceProvider — Class in namespace Biigle\Modules\AuthNfdi
VolumeColorSortSequenceController::show() — Method in class VolumeColorSortSequenceController

Show the sequence of images sorted by a specific color.

VolumeColorSortSequenceController::store() — Method in class VolumeColorSortSequenceController

Request a new color sort sequence.

StoreColorSortSequence — Class in namespace Biigle\Modules\ColorSort\Http\Requests
$ ComputeNewSequence#sequence — Property in class ComputeNewSequence

The color sort sequence that should be computed.

Sequence — Class in namespace Biigle\Modules\ColorSort

This model represents a sequence of volume images sorted by a specific color.

Sort — Class in namespace Biigle\Modules\ColorSort\Support

Wrapper for the color sort script.

DemoProjectController::store() — Method in class DemoProjectController

Creates a new demo project which already has a label tree and volume attached

ProjectController::show() — Method in class ProjectController

Shows the project geo page.

VolumeController::show() — Method in class VolumeController

Shows the volume geo page.

$ CountCitations#semanticScholarApiUrl — Property in class CountCitations

The Semantic Scholar API endpoint. The queries and paper IDs are read from the config.

SubmitToScorpion — Class in namespace Biigle\Modules\Kpis\Console\Commands
$ SubmitToScorpion#scorpionApiUrl — Property in class SubmitToScorpion

The Scorpion API endpoint to submit measurements to.

RequestController::store() — Method in class RequestController

Saves action/visit count from cron job

KpiController::show() — Method in class KpiController

Shows the kpis page.

StoreRequest — Class in namespace Biigle\Modules\Kpis\Http\Requests
Requests::save() — Method in class Requests
Storage — Class in namespace Biigle\Modules\Kpis
ImagesController::showLaserpoints() — Method in class ImagesController

Show laserpoint data for this image.

Image::setLaserpointsAttribute() — Method in class Image

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

ImageEmbeddingController::store() — Method in class ImageEmbeddingController

Request a SAM image embedding.

StoreImageEmbeddingRequest — Class in namespace Biigle\Modules\MagicSam\Http\Requests
GenerateEmbedding::sendPyworkerRequest() — Method in class GenerateEmbedding

Send the scaled-down PNG image to the Python worker and return the embedding npy file as binary blob.

$ MigratePatchStorage#signature — Property in class MigratePatchStorage

The name and signature of the console command.

AnnotationCandidateController::submit() — Method in class AnnotationCandidateController

Convert annotation candidates to annotations.

MaiaJobController::store() — Method in class MaiaJobController

Creates a new MAIA job for the specified volume.

TrainingProposalController::submit() — Method in class TrainingProposalController

Continue a MAIA job from training proposal selection and refinement to object detection.

MaiaJobController::show() — Method in class MaiaJobController

Show a MAIA job

StoreMaiaJob — Class in namespace Biigle\Modules\Maia\Http\Requests
SubmitAnnotationCandidates — Class in namespace Biigle\Modules\Maia\Http\Requests
JobFailure::sendNotification() — Method in class JobFailure

Send the notification about the failure to the creator of the job.

NoveltyDetectionFailure::sendNotification() — Method in class NoveltyDetectionFailure

Send the notification about the failure to the creator of the job.

ObjectDetection::shouldUseKnowledgeTransfer() — Method in class ObjectDetection

Determine whether knowledge transfer should be performed in this job.

ObjectDetectionFailure::sendNotification() — Method in class ObjectDetectionFailure

Send the notification about the failure to the creator of the job.

$ PrepareAnnotationsJob#selectTrainingProposals — Property in class PrepareAnnotationsJob

Set newly converted training proposals as selected.

MaiaAnnotation::setPointsAttribute() — Method in class MaiaAnnotation

Round the floats of the points array to 2 decimals before saving.

MaiaAnnotation::shape() — Method in class MaiaAnnotation

The shape of this MAIA annotation.

MaiaJob::state() — Method in class MaiaJob

The state of this MAIA job.

MaiaJob::setParamsAttribute() — Method in class MaiaJob

Set the configured parameters of this job.

MaiaJob::setErrorAttribute() — Method in class MaiaJob

Set the error information for this job.

MaiaJob::shouldUseExistingAnnotations() — Method in class MaiaJob

Determine if this job should use existing annotations to get training data.

MaiaJob::shouldUseNoveltyDetection() — Method in class MaiaJob

Determine if this job should use novelty detection to get training data.

MaiaJob::shouldUseKnowledgeTransfer() — Method in class MaiaJob

Determine if this job should use knowledge transfer to get training data.

MaiaJob::setConvertingCandidatesAttribute() — Method in class MaiaJob

Set whether a job to convert candidates is running.

MaiaJob::shouldShowTrainingProposals() — Method in class MaiaJob

Determine if this job should show the training porposals tabs.

TrainingProposal::scopeSelected() — Method in class TrainingProposal

Scope the query to all selected annotations

TrainingProposal::scopeUnselected() — Method in class TrainingProposal

Scope the query to all unselected annotations

$ Annotation#segmentation — Property in class Annotation
$ Annotation#shape — Property in class Annotation
EventsController::store() — Method in class EventsController

Report a new event.

NewsletterController::store() — Method in class NewsletterController

Create a new newsletter draft

NewsletterController::subscribed() — Method in class NewsletterController

Shows the subscribed page.

NewsletterController::show() — Method in class NewsletterController

Shows the newsletter.

StoreNewsletter — Class in namespace Biigle\Modules\Newsletter\Http\Requests
StoreNewsletterSubscriber — Class in namespace Biigle\Modules\Newsletter\Http\Requests
Newsletter::scopeDraft() — Method in class Newsletter

Scope a query to all draft newsletters

Newsletter::scopePublished() — Method in class Newsletter

Scope a query to all published newsletters

NewsletterSubscriber::scopeVerified() — Method in class NewsletterSubscriber

Scope a query to all subscribers that are verified.

NewsletterSubscriber::sendEmailVerificationNotification() — Method in class NewsletterSubscriber

Send the email verification notification.

PtpController::store() — Method in class PtpController

Generate Point to Polygon Job for the specified volume

PtpController::setUniquePtpJob() — Method in class PtpController

Assign UUID to a volume for the PTP job so that only one job is run per volume at a time.

UserDiskController::store() — Method in class UserDiskController

Initialize a new user storage disk

UserDiskController::store() — Method in class UserDiskController

Shows the user disks create view.

StoreUserDisk — Class in namespace Biigle\Modules\UserDisks\Http\Requests
StorageRequestFactory — Class in namespace Biigle\Modules\UserStorage\Database\Factories
StorageRequestFileFactory — Class in namespace Biigle\Modules\UserStorage\Database\Factories
StorageRequestController — Class in namespace Biigle\Modules\UserStorage\Http\Controllers\Api
StorageRequestController::store() — Method in class StorageRequestController

Initialize a new storage request

StorageRequestController::show() — Method in class StorageRequestController

Show a storage request

StorageRequestDirectoryController — Class in namespace Biigle\Modules\UserStorage\Http\Controllers\Api
StorageRequestFileController — Class in namespace Biigle\Modules\UserStorage\Http\Controllers\Api
StorageRequestFileController::store() — Method in class StorageRequestFileController

Store a file for a new storage request.

StorageRequestFileController::show() — Method in class StorageRequestFileController

Show a file of a storage request.

StorageRequestUserController — Class in namespace Biigle\Modules\UserStorage\Http\Controllers\Api
StorageRequestUserController::store() — Method in class StorageRequestUserController

Update the storage quota of a user

StorageRequestController — Class in namespace Biigle\Modules\UserStorage\Http\Controllers\Views
$ ApproveStorageRequest#storageRequest — Property in class ApproveStorageRequest

Storage request that should be approved.

$ DestroyStorageRequestDirectory#storageRequest — Property in class DestroyStorageRequestDirectory

Storage request that should be approved.

$ DestroyStorageRequestDirectory#srFiles — Property in class DestroyStorageRequestDirectory

The files that should be deleted.

$ ExtendStorageRequest#storageRequest — Property in class ExtendStorageRequest

Storage request that should be approved.

$ RejectStorageRequest#storageRequest — Property in class RejectStorageRequest

Storage request that should be approved.

StoreStorageRequest — Class in namespace Biigle\Modules\UserStorage\Http\Requests
StoreStorageRequestFile — Class in namespace Biigle\Modules\UserStorage\Http\Requests
$ StoreStorageRequestFile#storageRequest — Property in class StoreStorageRequestFile

Storage request to which the file should be uploaded.

$ StoreStorageRequestFile#storageRequestFile — Property in class StoreStorageRequestFile

The file that belongs to a chunked upload (if any).

StoreStorageRequestFile::sanitizePrefix() — Method in class StoreStorageRequestFile

Sanitize the path prefix.

$ UpdateStorageRequest#storageRequest — Property in class UpdateStorageRequest

Storage request that should be approved.

StorageRequestApproved — Class in namespace Biigle\Modules\UserStorage\Notifications
StorageRequestExpiresSoon — Class in namespace Biigle\Modules\UserStorage\Notifications
StorageRequestRejected — Class in namespace Biigle\Modules\UserStorage\Notifications
StorageRequestSubmitted — Class in namespace Biigle\Modules\UserStorage\Notifications
StorageRequestPolicy — Class in namespace Biigle\Modules\UserStorage\Policies
StorageRequest — Class in namespace Biigle\Modules\UserStorage
StorageRequestFile — Class in namespace Biigle\Modules\UserStorage
User::setStorageQuotaAvailableAttribute() — Method in class User

Set the allowed user storage quota.

AnnotationObserver::saved() — Method in class AnnotationObserver

Handle the event of creating/saving a single annotation.

Project::scopeInCommon() — Method in class Project

Scope a query to all projects that the user and the volume with the given ID have in common.

Project::scopeAccessibleBy() — Method in class Project

Scope a query to all projects that are accessible by a user.

EventServiceProvider::shouldDiscoverEvents() — Method in class EventServiceProvider

Determine if events and listeners should be automatically discovered.

Report::source() — Method in class Report

Source of the report.

Report::setReportGenerator() — Method in class Report

Set the report generator for this model.

$ AnnotationPoints#shapeId — Property in class AnnotationPoints

ID of the shape the points should be valid for.

$ VolumeFiles#sampleCount — Property in class VolumeFiles

Number of sample images to check for existence.

VolumeFiles::sampleFilesExist() — Method in class VolumeFiles

Check a random sample of the files for existence.

ArchiveManager::store() — Method in class ArchiveManager

Stores an uploaded archive file and returns its token.

WormsAdapter::setSoapClient() — Method in class WormsAdapter

Set the SOAP client instance to use for requests.

$ Annotation#shape_id — Property in class Annotation

Shape ID required for point validation.

Annotation::setPointsAttribute() — Method in class Annotation

Round the floats of the points array to 2 decimals.

MakesZipArchives::sanitizeFilename() — Method in class MakesZipArchives

Sanitizes a filename.

$ ReportGenerator#source — Property in class ReportGenerator

Source this report belongs to (e.g. a volume).

ReportGenerator::setSource() — Method in class ReportGenerator

Set the source.

ReportGenerator::shouldSeparateLabelTrees() — Method in class ReportGenerator

Should this report separate the output files for different label trees?

ReportGenerator::shouldSeparateUsers() — Method in class ReportGenerator

Should this report separate the output files for different user?

ReportGenerator::shouldUseAllLabels() — Method in class ReportGenerator

Should this report show all labels?

IfdoReportGenerator::shouldConvertWormsId() — Method in class IfdoReportGenerator

Determine if the label ID should be converted to a WoRMS URN.

AnnotationReportGenerator::shouldAggregateChildLabels() — Method in class AnnotationReportGenerator

Determines if this report should aggregate child labels.

AreaReportGenerator::setSize() — Method in class AreaReportGenerator

Calculate the pixel/sqm size and dimensions for an annotation.

VolumeReportGenerator::setPythonScriptRunner() — Method in class VolumeReportGenerator

Set the Python script runner object.

VolumeReportGenerator::shouldGetAttributeColumn() — Method in class VolumeReportGenerator

Determines if this report should skip the attributes column.

Shape — Class in namespace Biigle

A shape, e.g. point or circle.

HasJsonAttributes::setJsonAttr() — Method in class HasJsonAttributes

Set a dynamic JSON attribute.

HasMetadataFile::saveMetadata() — Method in class HasMetadataFile
User::setEmailAttribute() — Method in class User

Set the email attribute and transform it to lowercase.

User::setSettings() — Method in class User

Set settings and merge them with the existing settings.

User::setIsInSuperUserModeAttribute() — Method in class User

Enables or disables Super User Mode if the user is a global admin.

User::setCanReviewAttribute() — Method in class User

Enables or disables the ability to review.

User::setHasNoRateLimitAttribute() — Method in class User

Enable or disable the API rate limit for (editor) users.

Video::setErrorAttribute() — Method in class Video

Set the error attribute.

Video::setTakenAtAttribute() — Method in class Video

Set the taken_at timestamps.

VideoAnnotation::setPointsAttribute() — Method in class VideoAnnotation

Round the floats of the points array to 2 decimals before saving.

Volume::scopeAccessibleBy() — Method in class Volume

Scope a query to all volumes that are accessible by a user.

Volume::setUrlAttribute() — Method in class Volume

Set the url attribute of this volume.

Volume::setCreatingAsyncAttribute() — Method in class Volume

Set the creating_async attribute of this volume.

Volume::setExportAreaAttribute() — Method in class Volume

Set or update the dynamic attribute for the export area.

VolumeFile::setMetadataAttribute() — Method in class VolumeFile

Set the metadata attribute.

VolumeFile::setWidthAttribute() — Method in class VolumeFile

Set the width attribute.

VolumeFile::setHeightAttribute() — Method in class VolumeFile

Set the height attribute.

VolumeFile::setSizeAttribute() — Method in class VolumeFile

Set the size attribute.

VolumeFile::setMimeTypeAttribute() — Method in class VolumeFile

Set the mimeType attribute.

T

TiledImagesDeleted — Class in namespace Biigle\Events
ManualController::tutorialsArticle() — Method in class ManualController

Show a tutorials article.

SettingsController::tokens() — Method in class SettingsController

Shows the tokens settings.

TermsController — Class in namespace Biigle\Http\Controllers\Views
PreventRequestForgery::tokensMatch() — Method in class PreventRequestForgery

Determine if the request has a URI that should pass through CSRF verification.

TrimStrings — Class in namespace Biigle\Http\Middleware
TrustHosts — Class in namespace Biigle\Http\Middleware
TrustProxies — Class in namespace Biigle\Http\Middleware
UpdateUserActivity::terminate() — Method in class UpdateUserActivity

Perform any final actions for the request lifecycle.

$ DestroyLabelTree#tree — Property in class DestroyLabelTree

The label tree to destroy.

$ DestroyLabelTreeUser#tree — Property in class DestroyLabelTreeUser

The label tree to attach a user to.

$ ShowPublicLabelTreeExport#tree — Property in class ShowPublicLabelTreeExport

The label tree that should be exported.

$ StoreLabel#tree — Property in class StoreLabel

The label tree to which the label should be attached.

$ StoreLabelTreeAuthorizedProject#tree — Property in class StoreLabelTreeAuthorizedProject

The label tree to attach an authorized project to.

$ StoreLabelTreeMerge#tree — Property in class StoreLabelTreeMerge

The label tree to create/remove the labels of.

$ StoreLabelTreeUser#tree — Property in class StoreLabelTreeUser

The label tree to attach a user to.

$ StoreLabelTreeVersion#tree — Property in class StoreLabelTreeVersion

The label tree from which a new version should be created.

$ UpdateLabelTree#tree — Property in class UpdateLabelTree

The label tree to update.

$ UpdateLabelTreeUser#tree — Property in class UpdateLabelTreeUser

The label tree to attach a user to.

Ifdo::toString() — Method in class Ifdo
$ ApplyLargoSession#tries — Property in class ApplyLargoSession

Number of times to retry this job.

$ ImportVolumeMetadata#tries — Property in class ImportVolumeMetadata

The number of times the job may be attempted.

$ ProcessAnnotatedFile#tries — Property in class ProcessAnnotatedFile

The number of times the job may be attempted.

$ ProcessNewImage#tries — Property in class ProcessNewImage

The number of times the job may be attempted.

$ ProcessNewImage#threshold — Property in class ProcessNewImage

If the image dimensions exceed this threshold the imag eshould be tiled.

$ ProcessNewVideo#tries — Property in class ProcessNewVideo

The number of times the job may be attempted.

TileSingleImage — Class in namespace Biigle\Jobs
$ TileSingleImage#tempPath — Property in class TileSingleImage

Path to the temporary storage file for the tiles.

TrackObject — Class in namespace Biigle\Jobs

Attempts to track an obect in a video. The object is initially defined by a video annotation. The annotation will be updated with the positions determined with the object tracking method.

$ TrackObject#tries — Property in class TrackObject

The number of times the job may be attempted.

Label::tree() — Method in class Label

The label tree this label belongs to.

AnnotationAssistanceRequest::toMail() — Method in class AnnotationAssistanceRequest

Get the mail representation of the notification.

AnnotationAssistanceRequest::toArray() — Method in class AnnotationAssistanceRequest

Get the array representation of the notification.

$ ComputeNewSequence#tries — Property in class ComputeNewSequence

The number of times the job may be attempted.

$ Sequence#table — Property in class Sequence

The table associated with the model.

$ Sequence#timestamps — Property in class Sequence

Don't maintain timestamps for this model.

$ ProcessDelphiJob#tries — Property in class ProcessDelphiJob

The number of times the job may be attempted.

$ GenerateEmbedding#tries — Property in class GenerateEmbedding

The number of times the job may be attempted.

GenerateEmbedding::tryGetVipsImageFromTiles() — Method in class GenerateEmbedding

Attempt to load the bbox area from Zoomify tiles.

$ AnnotationCandidate#table — Property in class AnnotationCandidate

The table associated with the model.

$ AnnotationCandidateFeatureVector#table — Property in class AnnotationCandidateFeatureVector

The table associated with the model.

$ AnnotationCandidateFeatureVector#timestamps — Property in class AnnotationCandidateFeatureVector

Don't maintain timestamps for this model.

$ MigratePatchStorage#tpDisk — Property in class MigratePatchStorage

MAIA training proposal patch storage disk.

TrainingProposalFactory — Class in namespace Biigle\Modules\Maia\Database\Factories
TrainingProposalFeatureVectorFactory — Class in namespace Biigle\Modules\Maia\Database\Factories
TrainingProposalController — Class in namespace Biigle\Modules\Maia\Http\Controllers\Api
$ ConvertAnnotationCandidates#tries — Property in class ConvertAnnotationCandidates

Number of times to retry this job.

$ DeleteAnnotationPatches#trainingProposals — Property in class DeleteAnnotationPatches

The training proposals to delete, grouped by image ID.

$ DetectionJob#tmpDir — Property in class DetectionJob

Temporary directory for files of this job.

$ NoveltyDetection#timeout — Property in class NoveltyDetection

Disable the timeout of the Laravel queue worker because this job may run long.

$ ObjectDetection#trainingProposals — Property in class ObjectDetection

Selected training proposals.

$ MaiaAnnotation#timestamps — Property in class MaiaAnnotation

Don't maintain timestamps for this model.

MaiaJob::trainingProposals() — Method in class MaiaJob

The training proposals of this MAIA job.

$ MaiaJobState#timestamps — Property in class MaiaJobState

Don't maintain timestamps for this model.

JobStateChanged::toMail() — Method in class JobStateChanged

Get the mail representation of the notification.

JobStateChanged::toArray() — Method in class JobStateChanged

Get the array representation of the notification.

TrainingProposalPolicy — Class in namespace Biigle\Modules\Maia\Policies
TrainingProposal — Class in namespace Biigle\Modules\Maia
$ TrainingProposal#table — Property in class TrainingProposal

The table associated with the model.

TrainingProposalFeatureVector — Class in namespace Biigle\Modules\Maia
$ TrainingProposalFeatureVector#table — Property in class TrainingProposalFeatureVector

The table associated with the model.

$ TrainingProposalFeatureVector#timestamps — Property in class TrainingProposalFeatureVector

Don't maintain timestamps for this model.

NewNewsletter::toMail() — Method in class NewNewsletter

Get the mail representation of the notification.

Unsubscribed::toMail() — Method in class Unsubscribed

Get the mail representation of the notification.

$ PtpJob#tmpInputFile — Property in class PtpJob

File where the input data for the Python script will be kept

$ PtpJob#tmpImageInputFile — Property in class PtpJob

File where the image input data for the Python script will be kept

PtpJobConcluded::toMail() — Method in class PtpJobConcluded

Get the mail representation of the notification.

PtpJobConcluded::toArray() — Method in class PtpJobConcluded

Get the array representation of the notification.

PtpJobFailed::toMail() — Method in class PtpJobFailed

Get the mail representation of the notification.

PtpJobFailed::toArray() — Method in class PtpJobFailed

Get the array representation of the notification.

UserDiskExpiresSoon::toMail() — Method in class UserDiskExpiresSoon

Get the mail representation of the notification.

UserDiskExpiresSoon::toArray() — Method in class UserDiskExpiresSoon

Get the array representation of the notification.

StorageRequestApproved::toMail() — Method in class StorageRequestApproved

Get the mail representation of the notification.

StorageRequestApproved::toArray() — Method in class StorageRequestApproved

Get the array representation of the notification.

StorageRequestExpiresSoon::toMail() — Method in class StorageRequestExpiresSoon

Get the mail representation of the notification.

StorageRequestExpiresSoon::toArray() — Method in class StorageRequestExpiresSoon

Get the array representation of the notification.

StorageRequestRejected::toMail() — Method in class StorageRequestRejected

Get the mail representation of the notification.

StorageRequestRejected::toArray() — Method in class StorageRequestRejected

Get the array representation of the notification.

StorageRequestSubmitted::toMail() — Method in class StorageRequestSubmitted

Get the mail representation of the notification.

$ StorageRequestFile#timestamps — Property in class StorageRequestFile

Indicates if the model should be timestamped.

$ InAppNotification#title — Property in class InAppNotification

Title of the notification.

$ InAppNotification#type — Property in class InAppNotification

Notification type.

InAppNotification::toArray() — Method in class InAppNotification

Get the array representation of the notification.

RegistrationAccepted::toMail() — Method in class RegistrationAccepted

Get the mail representation of the notification.

RegistrationConfirmation::toMail() — Method in class RegistrationConfirmation

Get the mail representation of the notification.

RegistrationRejected::toMail() — Method in class RegistrationRejected

Get the mail representation of the notification.

ReportReady::toMail() — Method in class ReportReady

Get the mail representation of the notification.

ReportReady::toArray() — Method in class ReportReady

Get the array representation of the notification.

Report::type() — Method in class Report

Type of the report.

$ VolumeFiles#typeId — Property in class VolumeFiles

The media type ID.

$ ImageAnnotationExport#tmpPath — Property in class ImageAnnotationExport

Path to the temporary CSV file.

$ ImageAnnotationLabelExport#tmpPath — Property in class ImageAnnotationLabelExport

Path to the temporary CSV file.

$ ImageExport#tmpPath — Property in class ImageExport

Path to the temporary CSV file.

$ ImageLabelExport#tmpPath — Property in class ImageLabelExport

Path to the temporary CSV file.

$ PublicLabelExport#tmpPath — Property in class PublicLabelExport

Path to the temporary CSV file.

$ VideoAnnotationExport#tmpPath — Property in class VideoAnnotationExport

Path to the temporary CSV file.

$ VideoAnnotationLabelExport#tmpPath — Property in class VideoAnnotationLabelExport

Path to the temporary CSV file.

$ VideoExport#tmpPath — Property in class VideoExport

Path to the temporary CSV file.

$ VideoLabelExport#tmpPath — Property in class VideoLabelExport

Path to the temporary CSV file.

$ ArchiveManager#tmpPath — Property in class ArchiveManager

Base path to the temporary directory to store extracted imports.

PublicLabelTreeImport::treeExists() — Method in class PublicLabelTreeImport

Checks if the label tree of the import already exists.

$ ReportGenerator#tmpFiles — Property in class ReportGenerator

Temporary files that are created when generating a report.

U

AddAnnotationAssistanceRequestsIndex::up() — Method in class AddAnnotationAssistanceRequestsIndex

Run the migrations.

AnnotationAssistanceRequestsNotification::up() — Method in class AnnotationAssistanceRequestsNotification

Run the migrations.

$ AnnotationLabel#user_id — Property in class AnnotationLabel
AnnotationLabel::user() — Method in class AnnotationLabel

The user who created this annotation label.

AnnotationSession::users() — Method in class AnnotationSession

The users, this annotation session is restricted to.

UserChannel — Class in namespace Biigle\Broadcasting
$ UserChannel#user — Property in class UserChannel

The user of this channel.

UpdateVideoMetadata — Class in namespace Biigle\Console\Commands
UpdateVolumeUrls — Class in namespace Biigle\Console\Commands
UpdateVolumeUrls::updateVolumes() — Method in class UpdateVolumeUrls
$ LargoSessionFailed#user — Property in class LargoSessionFailed

The user that created the server.

$ LargoSessionSaved#user — Property in class LargoSessionSaved

The user that created the server.

$ ObjectTrackingFailed#user — Property in class ObjectTrackingFailed

The user that created the server.

$ ObjectTrackingSucceeded#user — Property in class ObjectTrackingSucceeded

The user that created the server.

$ VolumeFilesDeleted#uuids — Property in class VolumeFilesDeleted

UUIDs of deleted images/videos.

FederatedSearchModel::users() — Method in class FederatedSearchModel

The users who can access this model.

$ GenericFile#url — Property in class GenericFile

The file URL.

AnnotationSessionController::update() — Method in class AnnotationSessionController

Updates the annotation session.

UserExportController — Class in namespace Biigle\Http\Controllers\Api\Export
FederatedSearchInstanceController::update() — Method in class FederatedSearchInstanceController

update federated search instance.

ImageAnnotationController::update() — Method in class ImageAnnotationController

Updates the annotation including its points.

ImageAnnotationLabelController::update() — Method in class ImageAnnotationLabelController

Updates the attributes of the specified annotation label.

ImportController::update() — Method in class ImportController
ImportController::updateUserImport() — Method in class ImportController

Perform a user import.

ImportController::updateLabelTreeImport() — Method in class ImportController

Perform a label tree import.

ImportController::updateVolumeImport() — Method in class ImportController

Perform a volume import.

LabelController::update() — Method in class LabelController

Update a label.

LabelTreeController::update() — Method in class LabelTreeController

Updates the attributes of the specified label tree.

LabelTreeUserController::update() — Method in class LabelTreeUserController

Updates a member of a label tree.

LabelTreeVersionController::update() — Method in class LabelTreeVersionController

Update the specified label tree version.

NotificationController::update() — Method in class NotificationController

Mark a notification as read.

NotificationController::updateAll() — Method in class NotificationController

Mark all notification as read.

PendingVolumeController::update() — Method in class PendingVolumeController

Update a pending volume to create an actual volume

PendingVolumeImportController::updateAnnotationLabels() — Method in class PendingVolumeImportController

Choose annotation labels for import.

PendingVolumeImportController::updateFileLabels() — Method in class PendingVolumeImportController

Choose file labels for import.

PendingVolumeImportController::updateLabelMap() — Method in class PendingVolumeImportController

Match metadata labels with database labels.

PendingVolumeImportController::updateUserMap() — Method in class PendingVolumeImportController

Match metadata users with database users.

ProjectController::update() — Method in class ProjectController

Updates the attributes of the specified project.

ProjectUserController::update() — Method in class ProjectUserController

Updates the attributes of the specified user in the specified project.

UserController — Class in namespace Biigle\Http\Controllers\Api
UserController::update() — Method in class UserController

Updates the attributes of the specified user.

UserController::updateOwn() — Method in class UserController

Updates the attributes of the own user.

UserPinnedProjectController — Class in namespace Biigle\Http\Controllers\Api
UserRegistrationController — Class in namespace Biigle\Http\Controllers\Api
UserSettingsController — Class in namespace Biigle\Http\Controllers\Api
UserSettingsController::update() — Method in class UserSettingsController

Update the own user settings

VideoAnnotationController::update() — Method in class VideoAnnotationController

Updates the video annotation

VolumeController::update() — Method in class VolumeController

Updates the attributes of the specified volume.

UsedFileLabelsController — Class in namespace Biigle\Http\Controllers\Api\Volumes
UserController — Class in namespace Biigle\Http\Controllers\Api\Volumes
UsersController — Class in namespace Biigle\Http\Controllers\Views\Admin
UpdateUserActivity — Class in namespace Biigle\Http\Middleware
$ AttachProjectUser#user — Property in class AttachProjectUser

The user to attach.

$ DestroyProjectUser#user — Property in class DestroyProjectUser

The user to detach.

$ StoreLabelTree#upstreamLabelTree — Property in class StoreLabelTree

The upstream label tree that should be forked (if any)

UpdateAnnotationSession — Class in namespace Biigle\Http\Requests
UpdateFederatedSearchInstance — Class in namespace Biigle\Http\Requests
UpdateImageAnnotation — Class in namespace Biigle\Http\Requests
UpdateLabel — Class in namespace Biigle\Http\Requests
UpdateLabelTree — Class in namespace Biigle\Http\Requests
UpdateLabelTreeUser — Class in namespace Biigle\Http\Requests
UpdateLabelTreeVersion — Class in namespace Biigle\Http\Requests
UpdateOwnUser — Class in namespace Biigle\Http\Requests
UpdatePendingVolume — Class in namespace Biigle\Http\Requests
UpdatePendingVolumeAnnotationLabels — Class in namespace Biigle\Http\Requests
UpdatePendingVolumeFileLabels — Class in namespace Biigle\Http\Requests
UpdatePendingVolumeLabelMap — Class in namespace Biigle\Http\Requests
UpdatePendingVolumeUserMap — Class in namespace Biigle\Http\Requests
UpdateProject — Class in namespace Biigle\Http\Requests
UpdateProjectUser — Class in namespace Biigle\Http\Requests
$ UpdateProjectUser#user — Property in class UpdateProjectUser

The user to update.

UpdateUser — Class in namespace Biigle\Http\Requests
$ UpdateUser#updateUser — Property in class UpdateUser

The user to update.

UpdateUserSettings — Class in namespace Biigle\Http\Requests
UpdateVideoAnnotation — Class in namespace Biigle\Http\Requests
UpdateVolume — Class in namespace Biigle\Http\Requests
$ ApplyLargoSession#user — Property in class ApplyLargoSession

The user who submitted the Largo session.

$ CloneImagesOrVideos#uuidMap — Property in class CloneImagesOrVideos

Array mapping original image uuids to cloned image uuids

CopyAnnotationFeatureVector::updateOrCreateFeatureVector() — Method in class CopyAnnotationFeatureVector

Create a new feature vector model for the annotation of this job.

CopyImageAnnotationFeatureVector::updateOrCreateFeatureVector() — Method in class CopyImageAnnotationFeatureVector

Create a new feature vector model for the annotation of this job.

CopyVideoAnnotationFeatureVector::updateOrCreateFeatureVector() — Method in class CopyVideoAnnotationFeatureVector

Create a new feature vector model for the annotation of this job.

ProcessAnnotatedFile::updateOrCreateFeatureVectors() — Method in class ProcessAnnotatedFile

Create the feature vectors based on the Python script output.

ProcessAnnotatedImage::updateOrCreateFeatureVectors() — Method in class ProcessAnnotatedImage

Create the feature vectors based on the Python script output.

ProcessAnnotatedVideo::updateOrCreateFeatureVectors() — Method in class ProcessAnnotatedVideo

Create the feature vectors based on the Python script output.

$ ProcessCloneVolumeFiles#uuidMap — Property in class ProcessCloneVolumeFiles

Array maps uuid of copied file to uuid of original files.

TileSingleImage::uploadToStorage() — Method in class TileSingleImage

Upload the tiles from temporary local storage to the tiles storage disk.

TileSingleImage::uploadToS3Storage() — Method in class TileSingleImage

Upload the tiles from temporary local storage to the s3 tiles storage disk.

$ TrackObject#userId — Property in class TrackObject

The user ID who initialized the tracking request.

UpdateFederatedSearchIndex — Class in namespace Biigle\Jobs
UpdateFederatedSearchIndex::updateLabelTreeIndex() — Method in class UpdateFederatedSearchIndex

Update the indexed label trees.

UpdateFederatedSearchIndex::updateProjectIndex() — Method in class UpdateFederatedSearchIndex

Update the indexed projects.

UpdateFederatedSearchIndex::updateVolumeIndex() — Method in class UpdateFederatedSearchIndex

Update the indexed projects.

UpdateFederatedSearchIndex::updateUserAccess() — Method in class UpdateFederatedSearchIndex

Update which user may access which federated search model that was created in this job.

UpdateVolumeMetadata — Class in namespace Biigle\Jobs
$ Label#uuid — Property in class Label
$ LabelTree#uuid — Property in class LabelTree
LabelTree::updateMember() — Method in class LabelTree

Update a member (role).

AnnotationAssistanceRequest::user() — Method in class AnnotationAssistanceRequest

The user that created the assistance request.

AnnotationAssistanceRequestController::update() — Method in class AnnotationAssistanceRequestController

Close an annotation assistance request.

UpdateAnnotationAssistanceRequest — Class in namespace Biigle\Modules\Ananas\Http\Requests
LsloginId::user() — Method in class LsloginId
NfdiLoginId::user() — Method in class NfdiLoginId
User — Class in namespace Biigle\Modules\Kpis
$ EmbeddingAvailable#user — Property in class EmbeddingAvailable

The user that requested the embedding.

$ EmbeddingFailed#user — Property in class EmbeddingFailed

The user that requested the embedding.

$ GenerateEmbedding#user — Property in class GenerateEmbedding

The user who initiated the job.

AnnotationCandidateController::update() — Method in class AnnotationCandidateController

Update an annotation candidate.

TrainingProposalController::update() — Method in class TrainingProposalController

Update a training proposal.

UpdateAnnotationCandidate — Class in namespace Biigle\Modules\Maia\Http\Requests
UpdateTrainingProposal — Class in namespace Biigle\Modules\Maia\Http\Requests
$ ConvertAnnotationCandidates#user — Property in class ConvertAnnotationCandidates

The user who initiated the job.

DetectionJob::updateJobState() — Method in class DetectionJob

Update the state of the MAIA job after processing the response.

JobFailure::updateJobState() — Method in class JobFailure

Set the job to a failed state.

NoveltyDetection::updateJobState() — Method in class NoveltyDetection

Update the state of the MAIA job after processing the response.

NoveltyDetectionFailure::updateJobState() — Method in class NoveltyDetectionFailure

Set the job to a failed state.

ObjectDetection::updateJobState() — Method in class ObjectDetection

Update the state of the MAIA job after processing the response.

ObjectDetectionFailure::updateJobState() — Method in class ObjectDetectionFailure

Set the job to a failed state.

ProcessNoveltyDetectedImage::updateOrCreateFeatureVectors() — Method in class ProcessNoveltyDetectedImage

Create the feature vectors based on the Python script output.

ProcessObjectDetectedImage::updateOrCreateFeatureVectors() — Method in class ProcessObjectDetectedImage

Create the feature vectors based on the Python script output.

MaiaJob::user() — Method in class MaiaJob

The user who created this MAIA job.

AnnotationCandidatePolicy::update() — Method in class AnnotationCandidatePolicy

Determine if the given user can update the annotation candidate.

MaiaJobPolicy::update() — Method in class MaiaJobPolicy

Determine if the given user can update the MAIA job.

TrainingProposalPolicy::update() — Method in class TrainingProposalPolicy

Determine if the given user can update the training proposal.

$ Info#url — Property in class Info
Converter::userForId() — Method in class Converter
$ Event#usesUniqueIds — Property in class Event

Indicates if the model uses unique ids.

NewsletterController::update() — Method in class NewsletterController

Update a newsletter draft

NewsletterController::unsubscribe() — Method in class NewsletterController

Shows the unsubscribe page.

NewsletterController::unsubscribed() — Method in class NewsletterController

Shows the unsubscribed page.

UpdateNewsletter — Class in namespace Biigle\Modules\Newsletter\Http\Requests
Unsubscribed — Class in namespace Biigle\Modules\Newsletter\Notifications
NewsletterPolicy::update() — Method in class NewsletterPolicy

Determine if the given user can update a newsletter.

PtpJob::uploadConvertedAnnotations() — Method in class PtpJob

Upload the converted annotations to the DB

UserDiskFactory — Class in namespace Biigle\Modules\UserDisks\Database\Factories
UserDiskController — Class in namespace Biigle\Modules\UserDisks\Http\Controllers\Api
UserDiskController::update() — Method in class UserDiskController

Update a user storage disk

UserDiskController — Class in namespace Biigle\Modules\UserDisks\Http\Controllers\Views
UserDiskController::update() — Method in class UserDiskController

Shows the user disks create view.

UpdateUserDisk — Class in namespace Biigle\Modules\UserDisks\Http\Requests
UserDiskExpiresSoon — Class in namespace Biigle\Modules\UserDisks\Notifications
UserDiskPolicy — Class in namespace Biigle\Modules\UserDisks\Policies
UserDiskPolicy::update() — Method in class UserDiskPolicy

Determine if the given user can update the storage disk.

UserDisk — Class in namespace Biigle\Modules\UserDisks
UserDisk::user() — Method in class UserDisk

The user who owns the disk.

UserDisksServiceProvider — Class in namespace Biigle\Modules\UserDisks
StorageRequestController::update() — Method in class StorageRequestController

Submit a storage request

UpdateStorageRequest — Class in namespace Biigle\Modules\UserStorage\Http\Requests
UserObserver — Class in namespace Biigle\Modules\UserStorage\Observers
StorageRequestPolicy::update() — Method in class StorageRequestPolicy

Determine if the given user can update the storage request.

StorageRequest::user() — Method in class StorageRequest

The user who created this storage request.

User — Class in namespace Biigle\Modules\UserStorage
UserStorageServiceProvider — Class in namespace Biigle\Modules\UserStorage
$ RegistrationConfirmation#user — Property in class RegistrationConfirmation

User who has been newly registered.

UserObserver — Class in namespace Biigle\Observers
AnnotationLabelPolicy::update() — Method in class AnnotationLabelPolicy

Determine if the user can edit the given annotation label.

AnnotationPolicy::update() — Method in class AnnotationPolicy

Determine if the user may update the given annotation.

FederatedSearchInstancePolicy::update() — Method in class FederatedSearchInstancePolicy

Determine whether the user can update the instance.

LabelPolicy::update() — Method in class LabelPolicy

Determine if the given label can be updated by the user.

LabelTreePolicy::update() — Method in class LabelTreePolicy

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

LabelTreePolicy::updateMember() — Method in class LabelTreePolicy

Determine if the user can update the given member of the given label tree.

LabelTreeVersionPolicy::update() — Method in class LabelTreeVersionPolicy

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

PendingVolumePolicy::update() — Method in class PendingVolumePolicy

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

ProjectPolicy::update() — Method in class ProjectPolicy

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

UserPolicy — Class in namespace Biigle\Policies
UserPolicy::update() — Method in class UserPolicy

Determine if the given user can update the user.

VolumePolicy::update() — Method in class VolumePolicy

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

Project::users() — Method in class Project

The members of this project. Every member has a project-specific project_role_id besides their global user role.

Project::userCanBeRemoved() — Method in class Project

Determines if the user can be removed from the project.

Report::user() — Method in class Report

The user that requested the report.

Uuid4 — Class in namespace Biigle\Rules
$ VolumeFiles#url — Property in class VolumeFiles

The volume URL to check the image files.

ApiGuard::user() — Method in class ApiGuard

Get the currently authenticated user.

UserExport — Class in namespace Biigle\Services\Export
$ LabelTreeImport#userImport — Property in class LabelTreeImport

The user import instance that belongs to this import.

LabelTreeImport::updateInsertedLabelParentIds() — Method in class LabelTreeImport

Update/set the parent_id of imported labels.

UserImport — Class in namespace Biigle\Services\Import
$ VolumeImport#userImport — Property in class VolumeImport

The user import instance that belongs to this import.

User — Class in namespace Biigle\Services\MetadataParsing
$ IfdoReportGenerator#users — Property in class IfdoReportGenerator

Users that have been used in this volume.

User — Class in namespace Biigle
$ User#uuid — Property in class User
Volume::users() — Method in class Volume

Return a query for all users associated to this volume through projects.

$ VolumeFile#uuid — Property in class VolumeFile
$ VolumeFileLabel#user_id — Property in class VolumeFileLabel
VolumeFileLabel::user() — Method in class VolumeFileLabel

The user who created this video label.

CreateAnnotationAssistanceRequestsTable::up() — Method in class CreateAnnotationAssistanceRequestsTable

Run the migrations.

CreateCopriaColorSortSequencesTable::up() — Method in class CreateCopriaColorSortSequencesTable

Run the migrations.

CreateGeoOverlaysTable::up() — Method in class CreateGeoOverlaysTable

Run the migrations.

CreateIndices::up() — Method in class CreateIndices

Run the migrations.

InitializeMaiaTables::up() — Method in class InitializeMaiaTables

Run the migrations.

RemoveGeoOverlaysTable::up() — Method in class RemoveGeoOverlaysTable

Run the migrations.

RenameTable::up() — Method in class RenameTable

Run the migrations.

RenameTransectColumn::up() — Method in class RenameTransectColumn

Run the migrations.

UpdateJobParams — Class in namespace [Global Namespace]
UpdateJobParams::up() — Method in class UpdateJobParams

Run the migrations.

V

AnnotationSession::volume() — Method in class AnnotationSession

The volume, this annotation session belongs to.

AnnotationSession::videoAnnotations() — Method in class AnnotationSession

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

VolumeChannel — Class in namespace Biigle\Broadcasting
$ VolumeChannel#volume — Property in class VolumeChannel

The volume of this channel.

VideosDeleted — Class in namespace Biigle\Events
VolumeCloned — Class in namespace Biigle\Events
VolumeFilesDeleted — Class in namespace Biigle\Events
VolumeFilesProcessed — Class in namespace Biigle\Events
$ VolumeFilesProcessed#volume — Property in class VolumeFilesProcessed

The volume that was processed

VolumeAnnotationController — Class in namespace Biigle\Http\Controllers\Api\Annotations
VolumeAnnotationLabelController — Class in namespace Biigle\Http\Controllers\Api\Annotations
VolumeImageAreaController — Class in namespace Biigle\Http\Controllers\Api\Annotations
VolumeExportController — Class in namespace Biigle\Http\Controllers\Api\Export
VideoAnnotationsController — Class in namespace Biigle\Http\Controllers\Api\Labels
VideoAnnotationController — Class in namespace Biigle\Http\Controllers\Api
VideoAnnotationLabelController — Class in namespace Biigle\Http\Controllers\Api
VideoController — Class in namespace Biigle\Http\Controllers\Api
VideoFileController — Class in namespace Biigle\Http\Controllers\Api
VideoLabelController — Class in namespace Biigle\Http\Controllers\Api
VisibilityController — Class in namespace Biigle\Http\Controllers\Api
VolumeAnnotationSessionController — Class in namespace Biigle\Http\Controllers\Api
VolumeController — Class in namespace Biigle\Http\Controllers\Api
VolumeFileController — Class in namespace Biigle\Http\Controllers\Api
VolumeFileLabelController — Class in namespace Biigle\Http\Controllers\Api
VolumeReportController — Class in namespace Biigle\Http\Controllers\Api
VolumeAnnotationLabels — Class in namespace Biigle\Http\Controllers\Api\Volumes
LoginController::validateLogin() — Method in class LoginController

Validate the user login request.

RegisterController::validator() — Method in class RegisterController

Get a validator for an incoming registration request.

DashboardController::volumesActivityItems() — Method in class DashboardController

Get the most recently created volume a user.

DashboardController::videosActivityItems() — Method in class DashboardController

Get the most recently annotated videos of a user.

VideoAnnotationController — Class in namespace Biigle\Http\Controllers\Views\Videos
VideoController — Class in namespace Biigle\Http\Controllers\Views\Videos
VideoController — Class in namespace Biigle\Http\Controllers\Views\Volumes
VolumeCloneController — Class in namespace Biigle\Http\Controllers\Views\Volumes
VolumeController — Class in namespace Biigle\Http\Controllers\Views\Volumes
VolumeReportsController — Class in namespace Biigle\Http\Controllers\Views\Volumes
ValidateSignature — Class in namespace Biigle\Http\Middleware
$ CloneVolume#volume — Property in class CloneVolume

The volume to clone.

$ DestroyLabelTreeVersion#version — Property in class DestroyLabelTreeVersion

The label tree version that should be deleted.

$ IndexVolumeAnnotationsSimilarity#volume — Property in class IndexVolumeAnnotationsSimilarity

The volume of which to index the annotations.

$ StoreAnnotationSession#volume — Property in class StoreAnnotationSession

The volume to store the annotation session to.

StoreLabelTreeMerge::validateCreate() — Method in class StoreLabelTreeMerge

Validate the create labels.

StoreLabelTreeMerge::validateRemove() — Method in class StoreLabelTreeMerge

Validate the remove labels.

StoreLargoSession::videoAnotationsBelongToVolumes() — Method in class StoreLargoSession

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

$ StoreProjectLargoSession#volumes — Property in class StoreProjectLargoSession

The volumes that are associated with the image annotations that should be changed.

StoreProjectReport::validateReportType() — Method in class StoreProjectReport

Validate the report types.

StoreProjectReport::validateGeoInfo() — Method in class StoreProjectReport

Validate the geo info for certain types.

StoreProjectReport::validateImageMetadata() — Method in class StoreProjectReport

Validate image metadata for certain types.

StoreProjectReport::validateIfdos() — Method in class StoreProjectReport

Check if some volumes have iFDO files (if an iFDO report is requested).

$ StoreVideoAnnotation#video — Property in class StoreVideoAnnotation

The video on which the annotation should be created.

$ StoreVolumeFile#volume — Property in class StoreVolumeFile

The volume to create the images in.

$ StoreVolumeLargoSession#volume — Property in class StoreVolumeLargoSession

The volume to store the Largo session for.

StoreVolumeLargoSession::validateImageVolume() — Method in class StoreVolumeLargoSession

Validate the request for an image volume.

StoreVolumeLargoSession::validateVideoVolume() — Method in class StoreVolumeLargoSession

Validate the request for an video volume.

$ StoreVolumeMetadata#volume — Property in class StoreVolumeMetadata

The volume to store the new metadata to.

$ StoreVolumeReport#volume — Property in class StoreVolumeReport

The volume to generate a new report for.

$ UpdateLabelTreeVersion#version — Property in class UpdateLabelTreeVersion

The label tree version that should be updated.

$ UpdateVolume#volume — Property in class UpdateVolume

The volume to update.

$ Ifdo#validator — Property in class Ifdo
$ CloneImagesOrVideos#volume — Property in class CloneImagesOrVideos

The volume to clone.

$ CloneVideoThumbnails#video — Property in class CloneVideoThumbnails

Cloned video of cloned volume

$ CreateNewImagesOrVideos#volume — Property in class CreateNewImagesOrVideos

The volume to create the files for.

$ DeleteVolume#volume — Property in class DeleteVolume

The volume that should be deleted.

$ ProcessCloneVolumeFiles#volume — Property in class ProcessCloneVolumeFiles

The volume for which the files should be processed.

$ ProcessNewVideo#video — Property in class ProcessNewVideo

The new video that should be processed.

$ ProcessNewVolumeFiles#volume — Property in class ProcessNewVolumeFiles

The volume for which the files should be processed.

LabelTree::version() — Method in class LabelTree

The version of this label tree (if it is a version of a master label tree).

LabelTree::versions() — Method in class LabelTree

The versions of this (master) label tree.

LabelTree::visibility() — Method in class LabelTree

The visibility of the label tree.

VolumeClonedListener — Class in namespace Biigle\Listeners
MediaType::video() — Method in class MediaType
MediaType::videoId() — Method in class MediaType
AnnotationAssistanceRequest::via() — Method in class AnnotationAssistanceRequest

Get the notification's delivery channels.

RegisterController::validator() — Method in class RegisterController

Get a validator for an incoming registration request.

RegisterController::validator() — Method in class RegisterController

Get a validator for an incoming registration request.

VolumeColorSortSequenceController — Class in namespace Biigle\Modules\ColorSort\Http\Controllers\Api
$ StoreColorSortSequence#volume — Property in class StoreColorSortSequence

The volume for which the new sequence should be computed.

$ Sequence#visible — Property in class Sequence

The attributes included in the model's JSON form. All other are hidden.

Sequence::volume() — Method in class Sequence

The volume, this image belongs to.

VolumeController — Class in namespace Biigle\Modules\Geo\Http\Controllers\Views
VolumeImageController — Class in namespace Biigle\Modules\Laserpoints\Http\Controllers\Api
$ ComputeVolume#volume — Property in class ComputeVolume

The volume that should be processed with laser point detection.

$ ProcessVolumeDelphiJob#volume — Property in class ProcessVolumeDelphiJob

The volume to process the images of.

Volume — Class in namespace Biigle\Modules\Laserpoints

Extends the base Biigle volume.

$ StoreMaiaJob#volume — Property in class StoreMaiaJob

The volume to create the MAIA job for.

MaiaJob::volume() — Method in class MaiaJob

The volume, this MAIA job belongs to.

JobStateChanged::via() — Method in class JobStateChanged

Get the notification's delivery channels.

Annotation::validate() — Method in class Annotation
Category::validate() — Method in class Category
Coco::validate() — Method in class Coco
Coco::validateCategoriesInData() — Method in class Coco
Coco::validateImagesInData() — Method in class Coco
Image::validate() — Method in class Image
$ Info#version — Property in class Info
NewsletterController::verify() — Method in class NewsletterController

Verify a subscription.

NewNewsletter::via() — Method in class NewNewsletter

Get the notification's delivery channels.

Unsubscribed::via() — Method in class Unsubscribed

Get the notification's delivery channels.

VerifyEmail — Class in namespace Biigle\Modules\Newsletter\Notifications
VerifyEmail::verificationUrl() — Method in class VerifyEmail

Get the verification URL for the given notifiable.

$ PtpJobConcluded#volumeName — Property in class PtpJobConcluded

The volume name for which the PTP job was running.

$ PtpJobConcluded#volumeId — Property in class PtpJobConcluded

The volume ID for which the PTP job was running.

PtpJobConcluded::via() — Method in class PtpJobConcluded

Get the notification's delivery channels.

$ PtpJobFailed#volumeName — Property in class PtpJobFailed

The name of the volume for which the PTP job was running.

$ PtpJobFailed#volumeId — Property in class PtpJobFailed

The volume ID for which the PTP job was running.

PtpJobFailed::via() — Method in class PtpJobFailed

Get the notification's delivery channels.

UserDiskController::validateAndCreateDisk() — Method in class UserDiskController

Check if a new storage disk has valid options/credentials and create it

UserDiskController::validateS3Config() — Method in class UserDiskController

Validates the given user s3 disk configuration

UserDiskController::validateGenericConfig() — Method in class UserDiskController

Validates the given user disk configuration

UserDiskController::validateDiskAccess() — Method in class UserDiskController

Checks whether the endpoint URL is valid and the disk is accessible

UserDiskExpiresSoon::via() — Method in class UserDiskExpiresSoon

Get the notification's delivery channels.

BucketName::validate() — Method in class BucketName

Determine if the validation rule passes.

StorageRequestApproved::via() — Method in class StorageRequestApproved

Get the notification's delivery channels.

StorageRequestExpiresSoon::via() — Method in class StorageRequestExpiresSoon

Get the notification's delivery channels.

StorageRequestRejected::via() — Method in class StorageRequestRejected

Get the notification's delivery channels.

StorageRequestSubmitted::via() — Method in class StorageRequestSubmitted

Get the notification's delivery channels.

InAppNotification::via() — Method in class InAppNotification

Get the notification's delivery channels.

RegistrationAccepted::via() — Method in class RegistrationAccepted

Get the notification's delivery channels.

RegistrationConfirmation::via() — Method in class RegistrationConfirmation

Get the notification's delivery channels.

RegistrationRejected::via() — Method in class RegistrationRejected

Get the notification's delivery channels.

ReportReady::via() — Method in class ReportReady

Get the notification's delivery channels.

VideoAnnotationObserver — Class in namespace Biigle\Observers
VideoObserver — Class in namespace Biigle\Observers
VolumeObserver — Class in namespace Biigle\Observers
PendingVolume::volume() — Method in class PendingVolume
VolumeFileLabelPolicy — Class in namespace Biigle\Policies
VolumeFilePolicy — Class in namespace Biigle\Policies
VolumePolicy — Class in namespace Biigle\Policies
Project::volumes() — Method in class Project

The volumes of this project.

Project::videoVolumes() — Method in class Project

The video volumes of this project.

ReportType::videoAnnotationsCsv() — Method in class ReportType
ReportType::videoAnnotationsCsvId() — Method in class ReportType
ReportType::videoIfdo() — Method in class ReportType
ReportType::videoIfdoId() — Method in class ReportType
ReportType::videoLabelsCsv() — Method in class ReportType
ReportType::videoLabelsCsvId() — Method in class ReportType
AnnotationPoints::validate() — Method in class AnnotationPoints

Run the validation rule.

AnnotationPoints::validateCoordinatesAreNumeric() — Method in class AnnotationPoints

Validate that all coordinates are either int or float.

AnnotationPoints::validateNumberOfCoordinates() — Method in class AnnotationPoints

Validate that the number of coordinates matches the required number for the given shape.

AnnotationPoints::validateNumberOfPoints() — Method in class AnnotationPoints

Validate that the number of points (sequential coordinate pairs) matches the expected number of points for the given shape.

AnnotationPoints::validateShape() — Method in class AnnotationPoints

Validate some edge cases where the given points don't create a valid shape.

VideoAnnotationFrames — Class in namespace Biigle\Rules
VideoAnnotationFrames::validate() — Method in class VideoAnnotationFrames

Run the validation rule.

VideoAnnotationGaps — Class in namespace Biigle\Rules
VideoAnnotationGaps::validate() — Method in class VideoAnnotationGaps

Run the validation rule.

VideoAnnotationPoints — Class in namespace Biigle\Rules
VideoAnnotationPoints::validatePointsStructure() — Method in class VideoAnnotationPoints

Validate the structure of the points array.

VideoAnnotationPoints::validatePointsPerKeyFrame() — Method in class VideoAnnotationPoints

Validate the shape-specific requirements of the points of each key frame.

VideoMetadata — Class in namespace Biigle\Rules
VolumeFileUnique — Class in namespace Biigle\Rules
$ VolumeFileUnique#volume — Property in class VolumeFileUnique

The volume to check for existing files.

VolumeFiles — Class in namespace Biigle\Rules
VolumeUrl — Class in namespace Biigle\Rules
VideoAnnotationExport — Class in namespace Biigle\Services\Export
VideoAnnotationLabelExport — Class in namespace Biigle\Services\Export
VideoExport — Class in namespace Biigle\Services\Export
VideoLabelExport — Class in namespace Biigle\Services\Export
VolumeExport — Class in namespace Biigle\Services\Export
ArchiveManager::validate() — Method in class ArchiveManager

Validate the uploaded import archive.

Import::validateFiles() — Method in class Import

Check if the files of this import are valid.

Import::validateFile() — Method in class Import

Validate a file of this import.

LabelTreeImport::validateFile() — Method in class LabelTreeImport

Validate a file of this import.

PublicLabelTreeImport::validateFile() — Method in class PublicLabelTreeImport

Validate a file of this import.

UserImport::validateFile() — Method in class UserImport

Validate a file of this import.

VolumeImport — Class in namespace Biigle\Services\Import
VolumeImport::validateFile() — Method in class VolumeImport

Validate a file of this import.

Annotation::validate() — Method in class Annotation

Validate the labels.

ImageAnnotation::validate() — Method in class ImageAnnotation

Validate the labels.

VideoAnnotation — Class in namespace Biigle\Services\MetadataParsing
VideoAnnotation::validate() — Method in class VideoAnnotation

Validate the labels.

VideoCsvParser — Class in namespace Biigle\Services\MetadataParsing
VideoMetadata — Class in namespace Biigle\Services\MetadataParsing
VolumeMetadata — Class in namespace Biigle\Services\MetadataParsing
$ Modules#viewMixins — Property in class Modules

The view mixins of every module for every view.

VideoIfdoReportGenerator — Class in namespace Biigle\Services\Reports\Projects
VideoIfdoReportGenerator — Class in namespace Biigle\Services\Reports\Volumes
VolumeReportGenerator — Class in namespace Biigle\Services\Reports\Volumes
Video — Class in namespace Biigle
VideoAnnotation — Class in namespace Biigle
VideoAnnotation::video() — Method in class VideoAnnotation

The video, this annotation belongs to.

VideoAnnotationLabel — Class in namespace Biigle
VideoAnnotationLabelFeatureVector — Class in namespace Biigle
VideoLabel — Class in namespace Biigle
VideoLabel::video() — Method in class VideoLabel

The video, this video label belongs to.

Visibility — Class in namespace Biigle

The visibility of a model.

Volume — Class in namespace Biigle

A volume is a collection of images. Volumes belong to one or many projects.

Volume::videos() — Method in class Volume

The videos belonging to this volume.

VolumeFile — Class in namespace Biigle
$ VolumeFile#volume_id — Property in class VolumeFile
VolumeFile::volume() — Method in class VolumeFile

The volume this video belongs to.

VolumeFileLabel — Class in namespace Biigle

Pivot object for the connection between VolumeFiles and Labels.

W

AttachProjectUser::withValidator() — Method in class AttachProjectUser

Configure the validator instance.

CloneVolume::withValidator() — Method in class CloneVolume

Configure the validator instance.

DestroyProjectUser::withValidator() — Method in class DestroyProjectUser

Configure the validator instance.

DestroyUser::withValidator() — Method in class DestroyUser

Configure the validator instance.

DestroyVideoAnnotationLabel::withValidator() — Method in class DestroyVideoAnnotationLabel

Configure the validator instance.

DestroyVolumeFile::withValidator() — Method in class DestroyVolumeFile

Configure the validator instance.

IndexProjectAnnotationsSimilarity::withValidator() — Method in class IndexProjectAnnotationsSimilarity

Configure the validator instance.

IndexVolumeAnnotationsSimilarity::withValidator() — Method in class IndexVolumeAnnotationsSimilarity

Configure the validator instance.

JoinProjectInvitation::withValidator() — Method in class JoinProjectInvitation

Configure the validator instance.

LinkVideoAnnotation::withValidator() — Method in class LinkVideoAnnotation

Configure the validator instance.

SplitVideoAnnotation::withValidator() — Method in class SplitVideoAnnotation

Configure the validator instance.

StoreAnnouncement::withValidator() — Method in class StoreAnnouncement

Configure the validator instance.

StoreImageAnnotation::withValidator() — Method in class StoreImageAnnotation

Configure the validator instance.

StoreImageAnnotations::withValidator() — Method in class StoreImageAnnotations

Configure the validator instance.

StoreLabel::withValidator() — Method in class StoreLabel

Configure the validator instance.

StoreLabelTree::withValidator() — Method in class StoreLabelTree

Configure the validator instance.

StoreLabelTreeMerge::withValidator() — Method in class StoreLabelTreeMerge

Configure the validator instance.

StoreLabelTreeUser::withValidator() — Method in class StoreLabelTreeUser

Configure the validator instance.

StorePendingVolume::withValidator() — Method in class StorePendingVolume

Configure the validator instance.

StorePendingVolumeFromVolume::withValidator() — Method in class StorePendingVolumeFromVolume

Configure the validator instance.

StorePendingVolumeImport::withValidator() — Method in class StorePendingVolumeImport

Configure the validator instance.

StorePinnedProject::withValidator() — Method in class StorePinnedProject

Configure the validator instance.

StoreProjectInvitation::withValidator() — Method in class StoreProjectInvitation

Configure the validator instance.

StoreProjectLabelTree::withValidator() — Method in class StoreProjectLabelTree

Configure the validator instance.

StoreProjectLargoSession::withValidator() — Method in class StoreProjectLargoSession

Configure the validator instance.

StoreProjectReport::withValidator() — Method in class StoreProjectReport

Configure the validator instance.

StoreReport::withValidator() — Method in class StoreReport

Configure the validator instance.

StoreVideoAnnotation::withValidator() — Method in class StoreVideoAnnotation

Configure the validator instance.

StoreVideoAnnotationLabel::withValidator() — Method in class StoreVideoAnnotationLabel

Configure the validator instance.

StoreVolume::withValidator() — Method in class StoreVolume

Configure the validator instance.

StoreVolumeLargoSession::withValidator() — Method in class StoreVolumeLargoSession

Configure the validator instance.

StoreVolumeMetadata::withValidator() — Method in class StoreVolumeMetadata

Configure the validator instance.

StoreVolumeReport::withValidator() — Method in class StoreVolumeReport

Configure the validator instance.

UpdateFederatedSearchInstance::withValidator() — Method in class UpdateFederatedSearchInstance

Configure the validator instance.

UpdateImageAnnotation::withValidator() — Method in class UpdateImageAnnotation

Configure the validator instance.

UpdateLabel::withValidator() — Method in class UpdateLabel

Configure the validator instance.

UpdateLabelTreeUser::withValidator() — Method in class UpdateLabelTreeUser

Configure the validator instance.

UpdatePendingVolume::withValidator() — Method in class UpdatePendingVolume

Configure the validator instance.

UpdatePendingVolumeAnnotationLabels::withValidator() — Method in class UpdatePendingVolumeAnnotationLabels

Configure the validator instance.

UpdatePendingVolumeFileLabels::withValidator() — Method in class UpdatePendingVolumeFileLabels

Configure the validator instance.

UpdatePendingVolumeLabelMap::withValidator() — Method in class UpdatePendingVolumeLabelMap

Configure the validator instance.

UpdatePendingVolumeUserMap::withValidator() — Method in class UpdatePendingVolumeUserMap

Configure the validator instance.

UpdateProjectUser::withValidator() — Method in class UpdateProjectUser

Configure the validator instance.

UpdateUserSettings::withValidator() — Method in class UpdateUserSettings

Configure the validator instance.

UpdateVideoAnnotation::withValidator() — Method in class UpdateVideoAnnotation

Configure the validator instance.

UpdateVolume::withValidator() — Method in class UpdateVolume

Configure the validator instance.

$ ProcessNewImage#width — Property in class ProcessNewImage

The desired thumbnail width.

StoreAnnotationAssistanceRequest::withValidator() — Method in class StoreAnnotationAssistanceRequest

Configure the validator instance.

UpdateAnnotationAssistanceRequest::withValidator() — Method in class UpdateAnnotationAssistanceRequest

Configure the validator instance.

StoreColorSortSequence::withValidator() — Method in class StoreColorSortSequence

Configure the validator instance.

ComputeImage::withValidator() — Method in class ComputeImage

Configure the validator instance.

ComputeVolume::withValidator() — Method in class ComputeVolume

Configure the validator instance.

StoreImageEmbeddingRequest::withValidator() — Method in class StoreImageEmbeddingRequest

Configure the validator instance.

ContinueMaiaJob::withValidator() — Method in class ContinueMaiaJob

Configure the validator instance.

DestroyMaiaJob::withValidator() — Method in class DestroyMaiaJob

Configure the validator instance.

StoreMaiaJob::withValidator() — Method in class StoreMaiaJob

Configure the validator instance.

SubmitAnnotationCandidates::withValidator() — Method in class SubmitAnnotationCandidates

Configure the validator instance.

UpdateAnnotationCandidate::withValidator() — Method in class UpdateAnnotationCandidate

Configure the validator instance.

UpdateTrainingProposal::withValidator() — Method in class UpdateTrainingProposal

Configure the validator instance.

$ Image#width — Property in class Image
StoreNewsletter::withValidator() — Method in class StoreNewsletter

Configure the validator instance.

ExtendUserDisk::withValidator() — Method in class ExtendUserDisk

Configure the validator instance.

StoreUserDisk::withValidator() — Method in class StoreUserDisk
ApproveStorageRequest::withValidator() — Method in class ApproveStorageRequest

Configure the validator instance.

DestroyStorageRequestDirectory::withValidator() — Method in class DestroyStorageRequestDirectory

Configure the validator instance.

DestroyStorageRequestFile::withValidator() — Method in class DestroyStorageRequestFile

Configure the validator instance.

ExtendStorageRequest::withValidator() — Method in class ExtendStorageRequest

Configure the validator instance.

StoreStorageRequest::withValidator() — Method in class StoreStorageRequest

Configure the validator instance.

StoreStorageRequestFile::withValidator() — Method in class StoreStorageRequestFile

Configure the validator instance.

UpdateStorageRequest::withValidator() — Method in class UpdateStorageRequest

Configure the validator instance.

WormsAdapter — Class in namespace Biigle\Services\LabelSourceAdapters

WoRMS label source adapter.

$ IfdoReportGenerator#wormsLabelSource — Property in class IfdoReportGenerator

Label source model for the WoRMS database.

IfdoReportGenerator::writeIfdo() — Method in class IfdoReportGenerator

Write the report JSON file.

Shape::wholeFrame() — Method in class Shape
Shape::wholeFrameId() — Method in class Shape
WebDAVAdapter — Class in namespace Biigle\WebDav
WebDavServiceProvider — Class in namespace Biigle\WebDav

Y

$ Info#year — Property in class Info

_

UserChannel::__construct() — Method in class UserChannel

Create a new channel instance.

VolumeChannel::__construct() — Method in class VolumeChannel

Create a new channel instance.

AnnotationLabelAttached::__construct() — Method in class AnnotationLabelAttached
LargoSessionFailed::__construct() — Method in class LargoSessionFailed

Create a new event instance.

LargoSessionSaved::__construct() — Method in class LargoSessionSaved

Create a new event instance.

ObjectTrackingFailed::__construct() — Method in class ObjectTrackingFailed

Create a new event instance.

ObjectTrackingSucceeded::__construct() — Method in class ObjectTrackingSucceeded

Create a new event instance.

VolumeCloned::__construct() — Method in class VolumeCloned
VolumeFilesDeleted::__construct() — Method in class VolumeFilesDeleted

Create a new event instance.

VolumeFilesProcessed::__construct() — Method in class VolumeFilesProcessed

Create a new event instance.

FileCache::__construct() — Method in class FileCache

Create an instance.

FileCache::__destruct() — Method in class FileCache

Release the process lock when the instance is destroyed. If this does not run (e.g. on a crash) the kernel releases the lock anyway and the orphan lock file is reaped by the pruner.

GenericFile::__construct() — Method in class GenericFile

Create a new instance.

FileCacheFake::__construct() — Method in class FileCacheFake
ApiTokenController::__construct() — Method in class ApiTokenController

Creates a new ApiTokenController instance.

Controller::__construct() — Method in class Controller

Creates a new instance.

ImportController::__construct() — Method in class ImportController

Creates a new instance.

UserController::__construct() — Method in class UserController

Creates a new UserController instance.

UserRegistrationController::__construct() — Method in class UserRegistrationController

Creates a new instance.

ForgotPasswordController::__construct() — Method in class ForgotPasswordController

Create a new controller instance.

LoginController::__construct() — Method in class LoginController

Create a new controller instance.

RegisterController::__construct() — Method in class RegisterController

Create a new controller instance.

ResetPasswordController::__construct() — Method in class ResetPasswordController

Create a new controller instance.

DashboardController::__construct() — Method in class DashboardController

Create a new instance.

ProjectInvitationController::__construct() — Method in class ProjectInvitationController

Instantiate a new controller instance.

StoreVolume::__destruct() — Method in class StoreVolume

Remove potential temporary files.

Ifdo::__construct() — Method in class Ifdo
ApplyLargoSession::__construct() — Method in class ApplyLargoSession

Create a new job instance.

CloneImageThumbnails::__construct() — Method in class CloneImageThumbnails
CloneImagesOrVideos::__construct() — Method in class CloneImagesOrVideos

Create a new job instance.

CloneVideoThumbnails::__construct() — Method in class CloneVideoThumbnails
CopyAnnotationFeatureVector::__construct() — Method in class CopyAnnotationFeatureVector

Copy the feature vector of the annotation associated with the annotation label to create a new feature vector for the annotation label.

CreateNewImagesOrVideos::__construct() — Method in class CreateNewImagesOrVideos

Create a new job instance.

DeleteVolume::__construct() — Method in class DeleteVolume

Create a new job instance.

GenerateReportJob::__construct() — Method in class GenerateReportJob

Create a new job instance.

ImportVolumeMetadata::__construct() — Method in class ImportVolumeMetadata

Create a new job instance.

InitializeFeatureVectorChunk::__construct() — Method in class InitializeFeatureVectorChunk
MigrateTiledImage::__construct() — Method in class MigrateTiledImage

Create a new job instance.

PostprocessVolumeImport::__construct() — Method in class PostprocessVolumeImport

Create a new job instance.

ProcessAnnotatedFile::__construct() — Method in class ProcessAnnotatedFile

Create a new job instance.

ProcessCloneVolumeFiles::__construct() — Method in class ProcessCloneVolumeFiles

Create a new job instance.

ProcessNewImage::__construct() — Method in class ProcessNewImage

Create a new job instance.

ProcessNewVideo::__construct() — Method in class ProcessNewVideo

Create a new instance.

ProcessNewVolumeFiles::__construct() — Method in class ProcessNewVolumeFiles

Create a new job instance.

RemoveAnnotationPatches::__construct() — Method in class RemoveAnnotationPatches

Create a new job instance.

TileSingleImage::__construct() — Method in class TileSingleImage

Create a new job instance.

TrackObject::__construct() — Method in class TrackObject

Create a new instance.

UpdateFederatedSearchIndex::__construct() — Method in class UpdateFederatedSearchIndex

Create a new job instance.

UpdateVolumeMetadata::__construct() — Method in class UpdateVolumeMetadata

Create a new job instance.

CreateRedisLogger::__invoke() — Method in class CreateRedisLogger

Create a custom Monolog instance.

LogManager::__construct() — Method in class LogManager

Create a new instance.

AnnotationAssistanceRequest::__construct() — Method in class AnnotationAssistanceRequest

Create a new instance.

AnnotationAssistanceResponse::__construct() — Method in class AnnotationAssistanceResponse

Create a new notification instance.

ComputeNewSequence::__construct() — Method in class ComputeNewSequence

Create a new job instance.

Job::__construct() — Method in class Job

Create a new job instance.

ProcessDelphiJob::__construct() — Method in class ProcessDelphiJob

Create a new job instance.

ProcessImageDelphiJob::__construct() — Method in class ProcessImageDelphiJob

Create a new job instance.

ProcessImageManualJob::__construct() — Method in class ProcessImageManualJob

Create a new job instance.

ProcessManualJob::__construct() — Method in class ProcessManualJob

Create a new job instance.

ProcessVolumeDelphiJob::__construct() — Method in class ProcessVolumeDelphiJob

Create a new job instance.

DelphiGather::__construct() — Method in class DelphiGather
EmbeddingAvailable::__construct() — Method in class EmbeddingAvailable

Create a new event instance.

EmbeddingFailed::__construct() — Method in class EmbeddingFailed

Create a new event instance.

GenerateEmbedding::__construct() — Method in class GenerateEmbedding

Create a new instance.

MaiaJobContinued::__construct() — Method in class MaiaJobContinued

Create a new instance

MaiaJobCreated::__construct() — Method in class MaiaJobCreated

Create a new instance

MaiaJobDeleting::__construct() — Method in class MaiaJobDeleting

Create a new instance

GenericImage::__construct() — Method in class GenericImage

Create a new instance.

ConvertAnnotationCandidates::__construct() — Method in class ConvertAnnotationCandidates

Create a new isntance.

DeleteAnnotationPatchChunk::__construct() — Method in class DeleteAnnotationPatchChunk

Create a new isntance.

DeleteAnnotationPatches::__construct() — Method in class DeleteAnnotationPatches

Create a new isntance.

DetectionJob::__construct() — Method in class DetectionJob

Create a new instance

JobFailure::__construct() — Method in class JobFailure

Create a new instance

NotifyNoveltyDetectionComplete::__construct() — Method in class NotifyNoveltyDetectionComplete

Create a new isntance.

NotifyObjectDetectionComplete::__construct() — Method in class NotifyObjectDetectionComplete

Create a new isntance.

ObjectDetection::__construct() — Method in class ObjectDetection

Create a new instance

PrepareAnnotationsJob::__construct() — Method in class PrepareAnnotationsJob

Create a new instance

ProcessNewAnnotationCandidates::__construct() — Method in class ProcessNewAnnotationCandidates

Create a new isntance.

ProcessNewTrainingProposals::__construct() — Method in class ProcessNewTrainingProposals

Create a new isntance.

ProcessNoveltyDetectedImage::__construct() — Method in class ProcessNoveltyDetectedImage

Create a new job instance.

ProcessObjectDetectedImage::__construct() — Method in class ProcessObjectDetectedImage

Create a new job instance.

JobStateChanged::__construct() — Method in class JobStateChanged

Create a new notification instance.

Converter::__construct() — Method in class Converter
NewNewsletter::__construct() — Method in class NewNewsletter

Create a new instance.

PtpJob::__construct() — Method in class PtpJob

Job used for converting Point annotations to Polygons

PtpJobConcluded::__construct() — Method in class PtpJobConcluded

Create a new notification instance.

PtpJobFailed::__construct() — Method in class PtpJobFailed

Create a new notification instance.

UserDiskExpiresSoon::__construct() — Method in class UserDiskExpiresSoon

Create a new notification instance.

ApproveStorageRequest::__construct() — Method in class ApproveStorageRequest

Create a new job instance.

AssembleChunkedFile::__construct() — Method in class AssembleChunkedFile

Create a new job instance.

DeleteStorageRequestDirectory::__construct() — Method in class DeleteStorageRequestDirectory

Create a new job instance.

DeleteStorageRequestFile::__construct() — Method in class DeleteStorageRequestFile

Create a new job instance.

StorageRequestApproved::__construct() — Method in class StorageRequestApproved

Create a new notification instance.

StorageRequestExpiresSoon::__construct() — Method in class StorageRequestExpiresSoon

Create a new notification instance.

StorageRequestRejected::__construct() — Method in class StorageRequestRejected

Create a new notification instance.

StorageRequestSubmitted::__construct() — Method in class StorageRequestSubmitted

Create a new notification instance.

ChunkedFileStreamPump::__construct() — Method in class ChunkedFileStreamPump
ChunkedFileStreamPump::__destruct() — Method in class ChunkedFileStreamPump
ChunkedFileStreamPump::__invoke() — Method in class ChunkedFileStreamPump
InAppNotification::__construct() — Method in class InAppNotification

Create a new notification instance.

RegistrationConfirmation::__construct() — Method in class RegistrationConfirmation

Create a new notification instance.

ReportReady::__construct() — Method in class ReportReady

Create a new notification instance.

CachedPolicy::__construct() — Method in class CachedPolicy

Create a new CachedPolicy.

AnnotationPoints::__construct() — Method in class AnnotationPoints

Create a new instance.

GreaterThan::__construct() — Method in class GreaterThan

Create a new instance.

ImageMetadata::__construct() — Method in class ImageMetadata

Create a new instance.

LessThan::__construct() — Method in class LessThan

Create a new instance.

VideoAnnotationFrames::__construct() — Method in class VideoAnnotationFrames

Create a new instance.

VideoAnnotationGaps::__construct() — Method in class VideoAnnotationGaps

Create a new instance.

VolumeFileUnique::__construct() — Method in class VolumeFileUnique

Create a new instance.

VolumeFiles::__construct() — Method in class VolumeFiles

Create a new instance.

VolumeUrl::__construct() — Method in class VolumeUrl

Create a new instance.

Export::__construct() — Method in class Export

Create a new instance.

ArchiveManager::__construct() — Method in class ArchiveManager

Create a new instance.

Import::__construct() — Method in class Import

Create a new instance.

Annotation::__construct() — Method in class Annotation
FileMetadata::__construct() — Method in class FileMetadata
Label::__construct() — Method in class Label
LabelAndUser::__construct() — Method in class LabelAndUser
MetadataParser::__construct() — Method in class MetadataParser
User::__construct() — Method in class User
VideoAnnotation::__construct() — Method in class VideoAnnotation
VideoMetadata::__construct() — Method in class VideoMetadata
VolumeMetadata::__construct() — Method in class VolumeMetadata
Modules::__construct() — Method in class Modules

Create a new instance.

CsvFile::__construct() — Method in class CsvFile

Create a new CSV file.

File::__construct() — Method in class File

Create a new file.

File::__destruct() — Method in class File
ReportGenerator::__construct() — Method in class ReportGenerator

Create a report generator instance.

PythonScriptRunner::__construct() — Method in class PythonScriptRunner

Create and execute the exec command.

VolumeReportGenerator::__construct() — Method in class VolumeReportGenerator

Create a report generator instance.

HasConstantInstances::__callStatic() — Method in class HasConstantInstances

Get one of the instances of this model that are defined in the INSTANCES constant array.

WebDAVAdapter::__construct() — Method in class WebDAVAdapter