Skip to content

Video Annotation - Settings

Introduction

Flywheel Project Settings control at a per-project level what data is eligible for video annotation, what annotation labels are available, and what annotation file formats are available.

Flywheel Project Settings for CVAT

Instruction Steps

To enable CVAT in a Flywheel project, navigate to Integrations section of the Project Settings and configure the following options.

Note

"Manage Project Settings" project permission is required to change project settings.

Computer Vision Annotation Tool (CVAT)

Enable this so that video acquisition files within the project will be available for annotation.

Compatible video files must:

  1. Be a format supported by ffmpeg, including MP4, AVI, and MOV
  2. Have a file.type == video within flywheel.

Compatible image files must:

  1. Be a .zip archive containing image files supported by the Python Pillow library, including formats like JPEG, PNG, BMP, GIF, PPM and TIFF.
  2. Have a file.type == image and a filename ending in .zip within flywheel.
  3. Not contain hidden folders, like __MACOSX caused by using the Mac Finder's "Compress" command.

With image archives, it is recommended to:

  • Use leading zeros with individual file names, as their sequence when annotating is in alphabetical order.
  • Limit the use of subfolders

Note

If CVAT is disabled on a project after video data within it has been made available for annotation, no label configuration or annotation data is removed. Re-enabling CVAT will restore the access to existing annotations, and start the processing to make all eligible video data available for annotation.

Files to Sync

Controls whether all, or only a subset of the compatible acquisition files in the project are synchronized with CVAT.

  • "Sync all Files" can be useful for bulk annotation workflows.
  • Disable and select the acquisition tags to selectively annotate specific files.
    • The available tags are those defined for the Project's parent Group.
    • If more than one tag is selected, acquisitions matching any one of the tags will be eligible.

Export Formats

Limits the annotation export formats available to users.

  • Limit the formats to help ensure compatibility with downstream tools and pipelines.
  • Leave it unrestricted for flexibility during experimentation.
  • See the CVAT documentation for details on each of the supported formats.

CVAT Project Settings

Defines the labels and structure used in annotation tasks.

  • You must enable CVAT and save the project settings to make this available.
  • The label configuration cannot be accessed by Site Admins who are not a member of the Flywheel project.
  • Only the labels and tools you configure will be available for annotating.
    • Removing a label from the project configuration will remove all annotations within the project using that label, and cannot be undone. This does not affect already exported annotations.
  • Using a consistent scheme across projects will help support reuse of downstream tools and pipelines.
  • Allow annotators to define labels for exploratory or ad-hoc tasks.

CVAT Project Settings

CVAT new label configuration

Tip

To ensure your label configuration is identical on new projects to that of an existing project, copy and paste the text from the "Raw" tab from an existing project to a new one.

Resources