From dc05b3c85b8ec0fb73a5730b997682dd57dec36a Mon Sep 17 00:00:00 2001 From: Gabriel Beckers Date: Wed, 13 Sep 2023 15:39:38 +0200 Subject: [PATCH] minor improvement intro text --- README.rst | 2 +- docs/index.rst | 2 +- setup.py | 5 +++++ 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 165fd87..f6bccb5 100644 --- a/README.rst +++ b/README.rst @@ -12,7 +12,7 @@ Birdwatcher is a Python computer vision library for analyzing animal behavior in Birdwatcher should help you getting up and running quickly when building analysis code or tools for specific measurements. It provides functionality that is common in video analysis, such as reading and writing videos into and from numpy arrays, applying processing algorithms such as background subtraction, morphological transformation, resizing, drawing on frames etc. Much of the underlying video and image processing is based on `FFmpeg `__ and `OpenCV `__, but Birdwatcher is easier to use for many tasks because its higher-level implementation of functionality. -Users can use Birdwatcher to efficiently write code for behavioral analysis. If it targets common use cases, such analysis code can in turn become part of Birdwatcher . At the moment behavioral analysis is limited to movement/location detection of single animals. +In addition to video analysis tools, Birdwatcher has high-level functions for behavioral analysis based on those tools, although currently these are limited to movement/location detection of single animals. Despite its name, Birdwatcher is not only for birds. We also successfully analyzed dog behavior, and it could be used on anything that moves. It is being used in our lab but still under heavy development, and should be considered alpha software. diff --git a/docs/index.rst b/docs/index.rst index 2f0d0ba..6ee4893 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -17,7 +17,7 @@ Birdwatcher is a Python computer vision library for analyzing animal behavior in Birdwatcher should help you getting up and running quickly when building analysis code or tools for specific measurements. It provides functionality that is common in video analysis, such as reading and writing videos into and from numpy arrays, applying processing algorithms such as background subtraction, morphological transformation, resizing, drawing on frames etc. Much of the underlying video and image processing is based on `FFmpeg `__ and `OpenCV `__, but Birdwatcher is easier to use for many tasks because its higher-level implementation of functionality. -Users can use Birdwatcher to efficiently write code for behavioral analysis. If it targets common use cases, such analysis code can in turn become part of Birdwatcher . At the moment behavioral analysis is limited to movement/location detection of single animals. +In addition to video analysis tools, Birdwatcher has high-level functions for behavioral analysis based on those tools, although currently these are limited to movement/location detection of single animals. Despite its name, Birdwatcher is not only for birds. We also successfully analyzed dog behavior, and it could be used on anything that moves. It is being used in our lab but still under heavy development, and should be considered alpha software. diff --git a/setup.py b/setup.py index 82ed025..636c9b3 100644 --- a/setup.py +++ b/setup.py @@ -28,6 +28,11 @@ but Birdwatcher is a lot easier to use for many tasks because its higher-level implementation of functionality as compared to these tools. +In addition to video analysis tools, Birdwatcher has high-level functions +for behavioral analysis based on those tools, although currently these are +limited to movement/location detection of single animals. + + Despite its name, Birdwatcher is not only for birds. We also successfully analyzed dog behavior, and it could be used on anything that moves. It is being used in our lab but still under heavy development, and should be