Select page from this chapter: Home, Quick Start, Terminology

Home

"Manual tracking is not feasible for a data set comprising more than a handful of trials."- O'Connor et al., The Journal of Neuroscience, 3 February 2010, 30(5): 1947-1967.

"In all, 334 recordings were obtained ... [and] were tracked on an LCD flat-screen monitor by a human observer ..."- Grant et al., Journal of Neurophysiology, February 2009, 101(2): 862-874.

Welcome

Neigh-eigh!!! The little pony welcomes you to the documentation for the BIOTACT Whisker Tracking Tool (BWTT). PLEASE, pony friend, do read the WARNINGS below - they are not the usual legalese (at least, not all of them are!).

WARNINGS

Fair Use Users of the software should read Fair Use before they begin, which indicates how the provided software should be cited, as well as highlighting any currently applicable cases where co-authorship of publications should be offered to one of the software authors.

Data Security Users of the BWTT are STRONGLY ADVISED to maintain regular backups of their BWTT project files. The software is offered WITHOUT WARRANTY and may corrupt these files at any time. If you lose all of your hard work, the authors may not be able to help you recover it.

Neigh! Little Pony warns you sternly! Before you use the software, you must agree to the End User License Agreement (EULA) included with all releases of the BWTT. In summary, the bulk of the software is provided under the terms of the GNU General Public License Version 3 (GPL3) - key summary terms of this license are reproduced below. Some third-party components are provided under the terms of the Simplified BSD License.

GPL3 SUMMARY TERMS

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see this page.

Documentation Organisation

This section is the Getting Started guide. The following few sections provide detailed information on the various components you'll meet in Getting Started. The section Advanced Use covers topics that you should probably not approach until you are familiar with how the BWTT works. Miscellaneous is a collection of random stuff that doesn't fit anywhere else. The final section is a reference for the included methods, and has various authors.

"Quick Start" sounds like a good place to go to get started quickly. This will work especially well if you were familiar with the previous version of the BWTT.

Acknowledgements

The BWTT is an artefact of the EU Framework 7 Project BIOTACT 215910. See CREDITS.txt for a list of the main contributors.