×

Manual

This is the application manual of BIIGLE. Here you can find articles on how to use the application as well as reference publications and the developer documentation.

Account settings

Learn how you can manage your user account.

Notifications

View and manage BIIGLE notifications in the notification center.

Projects

Learn what projects are and how to manage them.

Label Trees

About Label Trees

Learn what label trees are and how you can manage them.

Manage Labels

Learn how to create, modify or delete labels of a label tree.

Label Tree Versions

Everything you need to know about versioned label trees.

Merge Label Trees

View and resolve differences between label trees.

Annotation Catalog

The annotation catalog shows you all annotations with a certain label.

Download and import

Learn more on how you can download a label tree and use it elsewhere.

Volumes

Volume overview

The volume overview allows you to explore all files that belong to a volume.

Annotation sessions

Annotation sessions can be used to conduct scientific studies.

File metadata

Upload metadata to add information that can't be extracted from the files.

File Labels

File labels are labels that are attached to whole images or videos.

Annotation and file label import

Import annotations and file labels from metadata files.

Files

Remote locations

Remote locations serve volume files from a public web server.

Image Annotations

Getting Started

A quick introduction to the image annotation tool.

Creating Image Annotations

Learn about all the tools that are available to create new image annotations.

Editing Image Annotations

Learn about all the tools to modify or delete existing image annotations.

Navigating Images

Learn about advanced ways to navigate the images in the image annotation tool.

Sidebar

All sidebar tabs of the image annotation tool explained.

Shortcuts

A list of all available shortcut keys in the image annotation tool.

URL Parameters

Advanced configuration of the image annotation tool.

Video Annotations

Getting Started

An introduction to the video annotation tool.

Creating Video Annotations

Learn how to create different kinds of video annotations.

Navigating the Timeline

Learn about the video timeline and how to navigate it.

Editing Video Annotations

Learn about all the tools to modify or delete existing video annotations.

Sidebar

All sidebar tabs of the video annotation tool explained.

Shortcuts

A list of all available shortcut keys in the video annotation tool.

URL Parameters

Advanced configuration of the video annotation tool.

Largo

The Label Review Grid Overview and what you can do with it.

Reports

Reports schema

A description of the file formats of the different available reports.

Image location reports

A detailed description of image location reports with a short introduction to QGIS.

Annotation location reports

A detailed description of the annotation position estimation of the annotation location report.

Image volume map

The image volume map shows the locations of images on a world map.

Laser point detection

The automatic laser point detection is used to determine the visual footprint of images.

Annotation assistance requests

Learn how to ask any person for advice on the label of an image annotation.

References

Reference publications that you should cite if you use BIIGLE for one of your studies.

BIIGLE 2.0
Langenkämper, D., Zurowietz, M., Schoening, T., & Nattkemper, T. W. (2017). Biigle 2.0-browsing and annotating large marine image collections.
Frontiers in Marine Science, 4, 83. doi: 10.3389/fmars.2017.00083

Observations From Four Years of BIIGLE 2.0
Zurowietz, M., & Nattkemper, T. W. (2021). Current Trends and Future Directions of Large Scale Image and Video Annotation: Observations From Four Years of BIIGLE 2.0.
Frontiers in Marine Science, 8, 760036. doi: 10.3389/fmars.2021.760036

Video Object Tracking
Lukezic, A., Vojir, T., ˇCehovin Zajc, L., Matas, J., & Kristan, M. (2017). Discriminative correlation filter with channel and spatial reliability. In Proceedings of the IEEE Conference on Computer Vision and Pattern Recognition (pp. 6309-6318). doi: 10.1109/CVPR.2017.515

Laser Point Detection
Schoening, T., Kuhn, T., Bergmann, M., & Nattkemper, T. W. (2015). DELPHI—fast and adaptive computational laser point detection and visual footprint quantification for arbitrary underwater image collections.
Frontiers in Marine Science, 2, 20. doi: 10.3389/fmars.2015.00020

API

You may access most of the functionality of this application using the RESTful API. Most of the API requires user authentication via session cookie (being logged in to the website) but it is also available for external requests using a personal API token. You can manage your API tokens in the user settings.

API access is rate-limited to 10,800 requests per hour (3,600 for unauthenticated users). You may access the rate limit and the current number of remaining requests through the X-RateLimit-Limit and X-RateLimit-Remaining HTTP headers.

The API works with form (x-www-form-urlencoded) as well as JSON requests. For form requests, you can use method spoofing to use different HTTP methods. For the complete documentation, check out the link below.

API Documentation

Further Resources