Skip to content
Snippets Groups Projects
Commit 7385c193 authored by Tristan Walter's avatar Tristan Walter
Browse files

updated list of contents

parent f18f5b7b
No related branches found
No related tags found
No related merge requests found
......@@ -3,26 +3,6 @@
Welcome to TRex's documentation!
================================
.. toctree::
:maxdepth: 2
:caption: Contents:
install
run
formats
parameters_trex
parameters_tgrabs
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Overview
========
|trex| is a tracking software designed to track and identify individuals and other moving entities using computer vision and machine learning. The work-load is split into two (not entirely separate) tools:
* **TGrabs**: Record or convert existing videos, perform live-tracking and closed-loop experiments
......@@ -30,21 +10,30 @@ Overview
.. raw:: html
<div style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden; max-width: 100%; height: auto;">
<video autoplay muted loop playsinline id="myVideo">
<source src="composite_tracking_video.webm" type='video/webm; codecs="vp9"' />
<source src="composite_tracking_video_.mp4" type='video/mp4; codecs="avc1"'>
<source src="composite_tracking_video.mov" type='video/mp4; codecs="h264"' />
</video>
</div>
<video autoplay muted loop playsinline id="myVideo" style="position: relative; padding-bottom: 15px; height: 0; overflow: hidden; max-width: 100%; height: auto;">
<source src="composite_tracking_video.webm" type='video/webm; codecs="vp9"' />
<source src="composite_tracking_video_.mp4" type='video/mp4; codecs="avc1"'>
<source src="composite_tracking_video.mov" type='video/mp4; codecs="h264"' />
</video>
|grabs| always has to be used first. |trex| is optional in some cases. Use-cases where |trex| is not required include:
* *Just give me tracks*: The user has a video and wants positional, or posture-related data for the individuals seen in the video. Maintaining identities is not required.
* *Closed-loop*: React to the behavior of individuals during a trial, e.g. lighting an LED when individuals get close to it, or run a python script every time individual 2 sees individual 3.
Whereas other use-cases do:
Whereas other use-cases are:
* *Maintaining identities*: Individuals are required to be assigned consistent identities throughout the entire video. Any results involving automatic identity correction will have to use |trex|.
* *Adjusting parameters with visual feedback*: While |grabs| includes a lot of the functionality of |trex|, it currently has no interface to directly test out parameters. Tracking parameters, specifically, have to be tested in |trex|. This is useful, e.g. when trying to figure out parameters for a batch process or adapting parameters for specific purposes.
* *Exploring and generating videos for presentations*: |trex| provides a rich set of functionalities for generating heatmaps and other useful visual information, as well as offering support to record anything that is on-screen to a AVI video file. For example, one can follow a subset of individuals and record every frame (lag-free and making sure that no frames are skipped). Any changes to the interface will be visible in the video as well.
\ No newline at end of file
* *Exploring and generating videos for presentations*: |trex| provides a rich set of functionalities for generating heatmaps and other useful visual information, as well as offering support to record anything that is on-screen to a AVI video file. For example, one can follow a subset of individuals and record every frame (lag-free and making sure that no frames are skipped). Any changes to the interface will be visible in the video as well.
.. toctree::
:maxdepth: 2
:caption: Contents:
install
run
formats
parameters_trex
parameters_tgrabs
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment