olivierfriard / boris Goto Github PK

View Code? Open in Web Editor NEW

168.0 18.0 34.0 178.67 MB

Behavioral Observation Research Interactive Software

Home Page: http://www.boris.unito.it

License: GNU General Public License v3.0

Python 98.61% HTML 0.07% Makefile 0.01% Shell 0.08% Just 0.02% SCSS 1.23%

video-coding behavior-analysis animal-behavior animal-behaviour ethology

boris's Introduction

BORIS (Behavioral Observation Research Interactive Software)

BORIS is an easy-to-use event logging software for video/audio coding or live observations.

BORIS is a free and open-source software available for GNU/Linux and Windows. You can not longer run BORIS natively on MacOS (since v.8). Some alternatives to run the last version of BORIS are available, see BORIS on MacOS.

It provides also some analysis tools like time budget and some plotting functions.

The BORIS paper has more than 1400 citations in peer-reviewed scientific publications.

See http://www.boris.unito.it

https://static.pepy.tech/personalized-badge/boris-behav-obs?period=total&units=international_system&left_color=black&right_color=orange&left_text=Downloads

Documentation

The documentation provides a good starting point for learning how to use BORIS: http://boris.readthedocs.io/

Some video tutorials are available: http://www.boris.unito.it/pages/video_tutorials.html

Bug reports and feature requests

To search for bugs, report them or request a feature, please use the github tracker: https://github.com/olivierfriard/BORIS/issues

Citing BORIS

Please acknowledge and cite the use of this software and its authors when results are used in publications or published elsewhere. You can use the following BibTex entry

@article {MEE3:MEE312584,
author = {Friard, Olivier and Gamba, Marco},
title = {BORIS: a free, versatile open-source event-logging software for video/audio coding and live observations},
journal = {Methods in Ecology and Evolution},
issn = {2041-210X},
url = {http://dx.doi.org/10.1111/2041-210X.12584},
doi = {10.1111/2041-210X.12584},
pages = {1324--1330},
keywords = {behavioural analysis, behaviour coding, coding scheme, ethology, observational data, ttime-budget},
year = {2016},
}

You can also send us a nice postcard! See the user testimonials

Licence

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.

Distributed with a GPL v.3 license

boris's People

Contributors

Stargazers

Watchers

boris's Issues

Boris 2.98 version link not working

The download link is no longer working.

events without modifier are not taken into account during time budget analysis and diagram visualization

this occurs only for events without any modifier selected

empty subject can not be removed from subjects list in "New project" window

Traceback (most recent call last):
File "project.py", line 959, in pbRemoveSubject_clicked
subjectToDelete = self.twSubjects.item( self.twSubjects.selectedIndexes()[0].row(), 1).text() ### 1: subject name
AttributeError: 'NoneType' object has no attribute 'text'

MAP CREATOR: control when coding map has changed

If the current map has changed ask user to save it

BORIS overwrites VLC preferences; pins video file to start and will not resize

How can I change the VLC preferences within BORIS? I'd like to be able to resize my video so I can actually see what's going on, lo-def and all, and this business of always pinning the video to the top of the screen is driving me absolutely insane.

generation of subtitles with subjects and events for coding verification with media player

BORIS freezes on Windows when a media file path contains accented characters

BORIS freezes when a media file path containing accented characters is selected for observation.
The problem occurs only on Windows

add function for checking state events

a function for checking for each behavior if the number of state events is odd (started and stopped) should be useful

Coding sheet comments do not save

In the coding sheet, event comments that are entered via edit event screen's comment box are not saved when I click OK. I'm pretty sure this worked in previous versions, but not in 2.66 & 2.7.

OS: Ubuntu 14.04
Boris: 2.7

Speed selection

Could you add the amount of 'extra speed' that the Plus and Minus buttons add/substract configurable in the Preferences? It is hardcoded to 0.1 in (boris.py), it would be nice if this could be set to a different value by the user.

The time scale in plot events function should be customizable

Spectrogram and recode/resize video functions are not working on WIndows

This is due to a bug in pyinstaller program with the multiprocessing module:
https://github.com/pyinstaller/pyinstaller/wiki/Recipe-Multiprocessing
On Windows running BORIS from sources works well.

Linux and Mac OS versions are running well

Request: option to use key depression instead of key presses for state events

It would be nice to have the option to have the option to press and hold a key during a state event, instead of only being able to press the key once for "start" and "stop" of a state event. This would be helpful in scoring rapidly changing state events to avoid accidentally reversing your observation scoring. For example, if you accidentally hit a the button twice, all of the subsequent "start" times will become "stop" times. Having the option to hold down a button to indicate a state behavior would be more of a binary and less confusing.

editing of coding map modifiers is not possible

Behaviors colors can be different between plots of various observations

Modifiers set are not numbered correctly in "edit event" window

Displayed modifiers sets numbers are #1, #3, #5 etc

use arrows for media navigation

I am using your program to code for ant behavior. I must often work backwards to determine the location an ant started from before it performed an action. I think it would be great if you could connect the media navigation buttons to the keyboard; for instance I would like to use the arrow keys for stepping forward and backward. This would make navigation much more quick and more exact. I have tried the frame-by-frame option, but the layout of the / and * keys is not user-friendly on a US keyboard, you have to use "shift" to get to the * (and sometimes I would like to go faster than frame-wise and still use the keyboard to navigate the video/frames). Adding in the ability for users to set their own preferences for media navigation keys on the keyboard would be the most awesome solution, if possible.

So far, your program is great, and it looks like it will meet my needs quite well. Thank you for sharing it!

Set an optional alert when no focal subject is selected

Let user choose in Preferences window

"export aggregated events" function did not export comments

Point event should exclude a state event

Like a state event (if configured) a point event should be able to exclude a current state event when triggered

Allow manual input of FPS

BORIS doesn't recognize the FPS for my video's. They play just fine, but means I cannot use the frame by frame command. Would it be possible to manually edit that value?

Add possibility to sort observations in observations list

by observation id (as now)
by observation date
by descrition
by media file

Exporting start and end times of behavioral observations

The ‘plot events’ analyze option is nice to look at, but we would like to have a way to export the actual start/end times for all observed behaviors, rather than just the time budget summary. Would this be possible? Thanks!

"export events" function do not export modifiers

map creator do not update coding map file name when "save as..." option is used

add function for excluding events from total media length

Events like "out of frame" should be excluded from the total media length for the time budget

add a "recent files" to File menu

This option should list the last 5 opened projects.

add sorting options for behaviors in ethogram creation window

Behaviors should be sorted by key or by code

map creator "close" menu option closes BORIS

Speed visible in player

Complementary to issue #18, would it be possible to add a UI element to the player showing the current speed? This way it's easier to go back to 'normal' playback speed. Another option would be to add an "=" button, next to "+" and "-", to set the playback speed back to normal.

events from observations with id > 31 char can not be exported in XLS format

due to the XLS format limitation

An area can be selected more times using coding map

One area should not be selected more times

Analysis of observations (time budget and time diagram) should be available even without media file

events from coding map are not included in time budget/time diagram

Calculating time budgets for individual observations

The time budget tool is great, but it'd be nice if it could summarize it by individual observation even when I select all observations. Otherwise I have to analyze time budget by each observation by hand and export by hand which takes forever with 100+ observations.

Spectrogram visualization do not work in frame-by-frame mode

Export for excel not working

I am try export for excel, but i cant, someone help-me?

Transition Matrix

The analysis for Transition Matrix appears to be missing from version 2.995. That's too bad as I started using Boris primarily for that analysis. Any plans to reincorporate it?

Boris hangs and crashes when trying to load video file observation

This has happened with .wmv and .avi video files. I was able to get a video to load only one time, in .wmv format. All other times the application froze. I am running the program on Mac OS X 10.9.

[EDIT] I believe the problem was having invalid directory name in the folder containing the videos. It might be nice to have a warning in such cases, instead of crashing the whole program.

import JWatcher Global Definition File (.gdf)

A coding map area should contain more polygons

More separated polygons should define the same coding area

The same behiavor has different colors between subjects when plotted

Editing observations where video location is incorrect

I moved to a new computer and was in the process of updating the video locations. The newer versions of BORIS do not let me edit the observations with the old locations. When I click the "edit" button nothing happens.

editing of coding map name in ethogram table can not be cancelled

If the Cancel button is pressed in the file dialog then the behavior type is reset to Point event and the coding map name is deleted

Event added with "Add event" menu option do not exclude current events (if excluded by new event)

Export to .xls doesn't work

Hi,

I'm trying to export all point and state events of my observations to an excel file for further analysis.
I use the most recent version of BORIS on mac.
But when I choose 'observations' -> 'export events' -> 'xls' -> 'select all',
I only get to pick a place to save the file, and then nothing happens.

This isn't only on my mac, but also on the pc's of my colleagues.
Hope you can help us out, thanks in advance!

All modifers reset to "none" when editing selected event

Just upgraded from BORIS 2.55 to latest version 2.72, (running on Windows 7, VLC 2.1.5).

I've noticed that now when editing an existing event, all modifiers are reset to "none". Could this be changed back to how it used to be in earlier versions (I think...) so that selected modifiers are remain unchanged when editing an event and can then be changed only if needed?

Thanks!