annotation_report.py: Annotation Reporting Tool

August 5, 2021 ยท View on GitHub

This program combines the contents of all video annotation files and dumps them to a single CSV file suitable for analyzing with the statistical software of your choice. Each record (line) of the report represents one annotation and contains the following information:

  • site: Camera site
  • file: The name of the annotation file this record came from
  • activity: The name of the activity or event associated with this annotation
  • kind: Kind of animal associated with this annotation, either 'focal' or 'commensal'
  • individual: ID of the animal associated with this annotation
  • startTime: Time the activity began
  • endTime: Time the activity ended
  • user: Name of the user who created the annotation

Command Line Arguments

All arguments are optional; default values can be provided in a configuration file.

Short FormLong FormTypeDescription
-c--configpathConfiguration file. If not provided, defaults to "annotation_report.config" located in the same directory as this program.
-o--outpathPath to output report file. If not provided, the report is printed to stdout.

Configuration File Settings

If no configuration file is provided using the -c command line option, this program will read configuration settings from a file named annotation_report.config An example of how each setting is used can be found in the configuration file production.config

[General_Settings]

This section contains configuration variables used by more than one program in the Camera Trap Tools suite.

  • default_annotation_folder: path to root of the default folder where annotations are stored