Skip to content
Snippets Groups Projects
Commit 87bfd43f authored by Tim Laibacher's avatar Tim Laibacher
Browse files

Merge branch 'docs-setup' into 'master' 

Add bob.db install instructions

See merge request bob/bob.ip.binseg!3
parents cb5804e4 0b1abb76
No related branches found
No related tags found
1 merge request!3Add bob.db install instructions
Pipeline #32960 passed
Stage: build
Stage: deploy
Hide whitespace changes
Inline Side-by-side
Showing
with 42 additions and 29 deletions
doc/setup.rst
+ 42
− 29
View file @ 87bfd43f
...@@ -15,33 +15,45 @@ package ...@@ -15,33 +15,45 @@ package
conda install bob.ip.binseg conda install bob.ip.binseg
Dataset Links Datasets
============= ========
+------------+----------------------------------------------------------------------+ The package supports a range of retina fundus datasets but does not install the `bob.db`
| Dataset | Website | APIs by default, nor does it include the datasets.
+------------+----------------------------------------------------------------------+
| STARE | http://cecas.clemson.edu/~ahoover/stare/ | To setup a datasets:
+------------+----------------------------------------------------------------------+
| DRIVE | https://www.isi.uu.nl/Research/Databases/DRIVE/ | 1. Download the dataset from the authors website
+------------+----------------------------------------------------------------------+ 2. Install the corresponding bob.db package via ``conda install bob.db.<database>``. E.g. to install the DRIVE API run ``conda install bob.db.drive``
| DRIONS | http://www.ia.uned.es/~ejcarmona/DRIONS-DB.html | 3. :ref:`datasetpathsetup`
+------------+----------------------------------------------------------------------+ 4. :ref:`dsconsistency`
| RIM-ONE | http://medimrg.webs.ull.es/research/downloads/ |
+------------+----------------------------------------------------------------------+ +------------+----------------------------------------------------------------------+---------------------+
| CHASE-DB1 | https://blogs.kingston.ac.uk/retinal/chasedb1/ | | Dataset | Website | `bob.db` package |
+------------+----------------------------------------------------------------------+ +------------+----------------------------------------------------------------------+---------------------+
| HRF | https://www5.cs.fau.de/research/data/fundus-images/ | | STARE | http://cecas.clemson.edu/~ahoover/stare/ | `bob.db.stare` |
+------------+----------------------------------------------------------------------+ +------------+----------------------------------------------------------------------+---------------------+
| Drishti-GS | http://cvit.iiit.ac.in/projects/mip/drishti-gs/mip-dataset2/Home.php | | DRIVE | https://www.isi.uu.nl/Research/Databases/DRIVE/ | `bob.db.drive` |
+------------+----------------------------------------------------------------------+ +------------+----------------------------------------------------------------------+---------------------+
| IOSTAR | http://www.retinacheck.org/datasets | | DRIONS | http://www.ia.uned.es/~ejcarmona/DRIONS-DB.html | `bob.db.drionsdb` |
+------------+----------------------------------------------------------------------+ +------------+----------------------------------------------------------------------+---------------------+
| REFUGE | https://refuge.grand-challenge.org/Details/ | | RIM-ONE | http://medimrg.webs.ull.es/research/downloads/ | `bob.db.rimoner3` |
+------------+----------------------------------------------------------------------+ +------------+----------------------------------------------------------------------+---------------------+
| CHASE-DB1 | https://blogs.kingston.ac.uk/retinal/chasedb1/ | `bob.db.chasedb` |
Setting up dataset paths +------------+----------------------------------------------------------------------+---------------------+
======================== | HRF | https://www5.cs.fau.de/research/data/fundus-images/ | `bob.db.hrf` |
+------------+----------------------------------------------------------------------+---------------------+
| Drishti-GS | http://cvit.iiit.ac.in/projects/mip/drishti-gs/mip-dataset2/Home.php | `bob.db.drishtigs1` |
+------------+----------------------------------------------------------------------+---------------------+
| IOSTAR | http://www.retinacheck.org/datasets | `bob.db.iostar` |
+------------+----------------------------------------------------------------------+---------------------+
| REFUGE | https://refuge.grand-challenge.org/Details/ | `bob.db.refuge` |
+------------+----------------------------------------------------------------------+---------------------+
.. _datasetpathsetup:
Set up dataset paths
=====================
For each dataset that you are planning to use, set the datadir to For each dataset that you are planning to use, set the datadir to
the path where it is stored. E.g.: the path where it is stored. E.g.:
...@@ -73,9 +85,10 @@ This should result in an output similar to the following: ...@@ -73,9 +85,10 @@ This should result in an output similar to the following:
} }
.. _dsconsistency:
Testing dataset consitency Test dataset consitency
========================== ========================
To check whether the downloaded version is consistent with To check whether the downloaded version is consistent with
the structure that is expected by our ``bob.db`` packages the structure that is expected by our ``bob.db`` packages
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment