]> rtime.felk.cvut.cz Git - hercules2020/kcf.git/blob - README.md
piotr toolbox ack moved to main README file
[hercules2020/kcf.git] / README.md
1 ## Tracking with Kernelized Correlation Filters
2
3 Code author : Tomas Vojir
4
5 ________________
6
7 This is a C++ reimplementation of algorithm presented in "High-Speed Tracking with Kernelized Correlation Filters" paper.
8 For more info and implementation in other languages visit the [autor's webpage!](http://home.isr.uc.pt/~henriques/circulant/). 
9
10 It is free for research use. If you find it useful or use it in your research, please acknowledge my git repository 
11 and cite the original paper [1].
12
13 The code depends on OpenCV 2.4+ library and is build via cmake toolchain.
14
15 _________________
16 Quick start guide
17
18 for linux: open terminal in the directory with the code
19
20 $ mkdir build; cd build; cmake .. ; make
21
22 This code compiles into binary **kcf_vot**
23
24 ./kcf_vot 
25 - using VOT 2014 methodology (http://www.votchallenge.net/)
26  - INPUT : expecting two files, images.txt (list of sequence images with absolute path) and 
27            region.txt with initial bounding box in the first frame in format "top_left_x, top_left_y, width, height" or 
28            four corner points listed clockwise starting from bottom left corner.
29  - OUTPUT : output.txt containing the bounding boxes in the format "top_left_x, top_left_y, width, height"
30
31 __________
32 References
33
34 [1] João F. Henriques, Rui Caseiro, Pedro Martins, Jorge Batista, “High-Speed Tracking with Kernelized Correlation Filters“, 
35 IEEE Transactions on Pattern Analysis and Machine Intelligence, 2015
36
37 _____________________________________
38 Copyright (c) 2014, Tomáš Vojíř
39
40 Permission to use, copy, modify, and distribute this software for research
41 purposes is hereby granted, provided that the above copyright notice and 
42 this permission notice appear in all copies.
43
44 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
45 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
46 MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
47 ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
48 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
49 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
50 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
51
52 __________________
53 Additional Library
54
55 NOTE: The following files are part of Piotr's Toolbox, and may had been modified for usage with c++
56
57    src/piotr_fhog/gradientMex.cpp
58    src/piotr_fhog/sse.hpp
59    src/piotr_fhog/wrappers.hpp
60   
61 You are encouraged to get the full version of this library at
62 http://vision.ucsd.edu/~pdollar/toolbox/doc/index.html
63
64 ______________________________________________________________________________
65
66 Copyright (c) 2012, Piotr Dollar
67 All rights reserved.
68
69 Redistribution and use in source and binary forms, with or without
70 modification, are permitted provided that the following conditions are met: 
71
72 1. Redistributions of source code must retain the above copyright notice, this
73    list of conditions and the following disclaimer. 
74 2. Redistributions in binary form must reproduce the above copyright notice,
75    this list of conditions and the following disclaimer in the documentation
76    and/or other materials provided with the distribution. 
77
78 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
79 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
80 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
81 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
82 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
83 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
84 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
85 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
86 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
87 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
88
89 The views and conclusions contained in the software and documentation are those
90 of the authors and should not be interpreted as representing official policies, 
91 either expressed or implied, of the FreeBSD Project.
92