Skip to content

Commit

Permalink
Updated - Eval docs, changed to light theme
Browse files Browse the repository at this point in the history
  • Loading branch information
goldbattle committed Mar 5, 2020
1 parent 235bb88 commit f237e0b
Show file tree
Hide file tree
Showing 25 changed files with 3,426 additions and 81 deletions.
5 changes: 3 additions & 2 deletions Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.

PROJECT_NAME = "Open VINS"
PROJECT_NAME = "OpenVINS"

# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
Expand Down Expand Up @@ -865,7 +865,8 @@ EXAMPLE_RECURSIVE = NO
# \image command).

IMAGE_PATH = docs/ \
docs/img/
docs/img/ \
docs/youtube/

# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
Expand Down
7 changes: 4 additions & 3 deletions Doxyfile-mcss
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@ XML_PROGRAMLISTING = NO

HTML_EXTRA_STYLESHEET = \
https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600&subset=latin-ext \
../css/m-dark+documentation.compiled.css \
docs/css/m-udel+documentation.compiled.css \
docs/css/custom.css
#### ../css/m-light+documentation.compiled.css \



Expand All @@ -33,8 +34,8 @@ ALIASES += \
"m_enum_values_as_keywords=@xmlonly<mcss:search xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:enum-values-as-keywords=\"true\" />@endxmlonly"


##! M_THEME_COLOR = #22272e
##! M_FAVICON = docs/img/favicon-dark.png
##! M_THEME_COLOR = #2f73a3
##! M_FAVICON = docs/img/favicon-light.png


##! M_LINKS_NAVBAR1 = pages namespaceov__core namespaceov__eval namespaceov__msckf annotated
Expand Down
22 changes: 11 additions & 11 deletions ReadMe.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@


# Open VINS
# OpenVINS


Welcome to the Open VINS project!
The Open VINS project houses some core computer vision code along with a state-of-the art filter-based visual-inertial estimator.
Welcome to the OpenVINS project!
The OpenVINS project houses some core computer vision code along with a state-of-the art filter-based visual-inertial estimator.
The core filter is an [Extended Kalman filter](https://en.wikipedia.org/wiki/Extended_Kalman_filter) which fuses inertial information with sparse visual feature tracks.
These visual feature tracks are fused leveraging the [Multi-State Constraint Kalman Filter (MSCKF)](https://ieeexplore.ieee.org/document/4209642) sliding window formulation which allows for 3D features to update the state estimate without directly estimating the feature states in the filter.
Inspired by graph-based optimization systems, the included filter has modularity allowing for convenient covariance management with a proper type-based state system.
Expand All @@ -14,7 +14,7 @@ Please take a look at the feature list below for full details on what the system
* Github project page - https://github.com/rpng/open_vins
* Documentation - https://docs.openvins.com/
* Getting started guide - https://docs.openvins.com/getting-started.html
* Publication reference - http://udel.edu/~ghuang/iros19-vins-workshop/papers/06.pdf
* Publication reference - http://udel.edu/~pgeneva/downloads/papers/c10.pdf


## News / Events
Expand Down Expand Up @@ -63,15 +63,15 @@ Please take a look at the feature list below for full details on what the system

## Demo Videos

[![IMAGE ALT TEXT](http://img.youtube.com/vi/KCX51GvYGss/1.jpg)](http://www.youtube.com/watch?v=KCX51GvYGss "OpenVINS - EuRoC MAV Vicon Rooms Flyby")
[![IMAGE ALT TEXT](http://img.youtube.com/vi/Lc7VQHngSuQ/1.jpg)](http://www.youtube.com/watch?v=Lc7VQHngSuQ "OpenVINS - TUM VI Datasets Flyby")
[![IMAGE ALT TEXT](http://img.youtube.com/vi/vaia7iPaRW8/1.jpg)](http://www.youtube.com/watch?v=vaia7iPaRW8 "OpenVINS - UZH-FPV Drone Racing Dataset Flyby")
[![IMAGE ALT TEXT](http://img.youtube.com/vi/MCzTF9ye2zw/1.jpg)](http://www.youtube.com/watch?v=MCzTF9ye2zw "OpenVINS - KAIST Urban 39 Dataset Demonstration")

[![](docs/youtube/KCX51GvYGss.jpg)](http://www.youtube.com/watch?v=KCX51GvYGss "OpenVINS - EuRoC MAV Vicon Rooms Flyby")
[![](docs/youtube/Lc7VQHngSuQ.jpg)](http://www.youtube.com/watch?v=Lc7VQHngSuQ "OpenVINS - TUM VI Datasets Flyby")
[![](docs/youtube/vaia7iPaRW8.jpg)](http://www.youtube.com/watch?v=vaia7iPaRW8 "OpenVINS - UZH-FPV Drone Racing Dataset Flyby")
[![](docs/youtube/MCzTF9ye2zw.jpg)](http://www.youtube.com/watch?v=MCzTF9ye2zw "OpenVINS - KAIST Urban 39 Dataset Demonstration")

[![IMAGE ALT TEXT](http://img.youtube.com/vi/187AXuuGNNw/1.jpg)](http://www.youtube.com/watch?v=187AXuuGNNw "OpenVINS - EuRoC MAV Vicon Rooms Demonstration")
[![IMAGE ALT TEXT](http://img.youtube.com/vi/oUoLlrFryk0/1.jpg)](http://www.youtube.com/watch?v=oUoLlrFryk0 "OpenVINS - TUM VI Datasets Demostration")
[![IMAGE ALT TEXT](http://img.youtube.com/vi/ExPIGwORm4E/1.jpg)](http://www.youtube.com/watch?v=ExPIGwORm4E "OpenVINS - UZH-FPV Drone Racing Dataset Demonstration")
[![](docs/youtube/187AXuuGNNw.jpg)](http://www.youtube.com/watch?v=187AXuuGNNw "OpenVINS - EuRoC MAV Vicon Rooms Demonstration")
[![](docs/youtube/oUoLlrFryk0.jpg)](http://www.youtube.com/watch?v=oUoLlrFryk0 "OpenVINS - TUM VI Datasets Demostration")
[![](docs/youtube/ExPIGwORm4E.jpg)](http://www.youtube.com/watch?v=ExPIGwORm4E "OpenVINS - UZH-FPV Drone Racing Dataset Demonstration")


## Credit / Licensing
Expand Down
4 changes: 4 additions & 0 deletions docs/00-page-order.dox
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@
@page fej First-Estimate Jacobian Estimators
@page update Measurement Update Derivations
@page simulation Visual-Inertial Simulator


@page evaluation Estimator Evaluation Methods
@page eval-metrics Estimator Evaluation Metrics


@page dev-welcome Developer and Internals

Expand Down
24 changes: 23 additions & 1 deletion docs/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,30 @@ main h1 + p, h2 + p, h3 + p {
text-indent: 1.5rem !important;
}


/* math equations by default have some extra space at the top */
div .m-math {
margin-top: -1.5rem;
}

/* handle youtube images on the readme page */
a .m-image {
display: inline !important;
}

/* do not lowercase the title of the project */
body > header > nav a#m-navbar-brand, body > header > nav #m-navbar-brand a {
text-transform: none;
}


/* REMOVE BAD M.CSS THEME SETTING: */
/* light grey text is hard to see */
.m-doc-template, dl.m-doc dd, ul.m-doc li > span.m-doc {
color: #1a1a1a;
}
.m-doc-template a, dl.m-doc dd a, ul.m-doc li > span.m-doc a {
color: #1a1a1a;
}
.m-block.m-dim, .m-text.m-dim, .m-label.m-flat.m-dim {
color: #1a1a1a;
}
Loading

0 comments on commit f237e0b

Please sign in to comment.