README.rst 3.2 KB
Newer Older
Manuel Günther's avatar
Manuel Günther committed
1
.. vim: set fileencoding=utf-8 :
2
.. Tiago de Freitas Pereira <tiago.pereira@idiap.ch>
Manuel Günther's avatar
Manuel Günther committed
3
.. Thu Sep  4 11:35:05 CEST 2014
Elie KHOURY's avatar
Elie KHOURY committed
4

Manuel Günther's avatar
Manuel Günther committed
5
6

=======================================================
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
7
 CASIA NIR-VIS 2.0 Face Database
Manuel Günther's avatar
Manuel Günther committed
8
9
=======================================================

10
11
12
This package contains the access API and descriptions for the `CASIA NIR-VIS 2.0 database <http://www.cbsr.ia.ac.cn/english/NIR-VIS-2.0-Database.html>`. 
The actual raw data for the database should be downloaded from the original URL. 
This package only contains the Bob accessor methods to use the DB directly from python, with the original protocol of the database.
Elie KHOURY's avatar
Elie KHOURY committed
13

14
15
16
17
CASIA NIR-VIS 2.0 database offers pairs of mugshot images and their correspondent NIR photos.
Capured by CASIA (Chinese Academy of Sciences), the images of this database were collected in four recording sessions: 2007 spring, 2009 summer, 2009 fall and 2010 summer, in which the first session is identical to the `HFB database <http://www.cbsr.ia.ac.cn/english/HFB%20Databases.asp>`. 
The CASIA NIR-VIS 2.0 database consists of 725 subjects in total. 
There are 1-22 VIS and 5-50 NIR face images per subject.
Elie KHOURY's avatar
Elie KHOURY committed
18

19
20
21
You would normally not install this package unless you are maintaining it. 
What you would do instead is to tie it in at the package you need to **use** it.
There are a few ways to achieve this:
Elie KHOURY's avatar
Elie KHOURY committed
22

23
24
25
26
27
28
1. You can add this package as a requirement at the ``setup.py`` for your own
   `satellite package
   <https://github.com/idiap/bob/wiki/Virtual-Work-Environments-with-Buildout>`_
   or to your Buildout ``.cfg`` file, if you prefer it that way. With this
   method, this package gets automatically downloaded and installed on your
   working environment, or
Elie KHOURY's avatar
Elie KHOURY committed
29

30
31
2. You can manually download and install this package using commands like
   ``easy_install`` or ``pip``.
Elie KHOURY's avatar
Elie KHOURY committed
32

33
The package is available in two different distribution formats:
Elie KHOURY's avatar
Elie KHOURY committed
34

35
1. You can download it from `PyPI <http://pypi.python.org/pypi>`_, or
Elie KHOURY's avatar
Elie KHOURY committed
36

37
38
2. You can download it in its source form from `its git repository
   <https://github.com/bioidiap/bob.db.cbsr_nir_vis_2>`_.
Elie KHOURY's avatar
Elie KHOURY committed
39

40
41
You can mix and match points 1/2 and a/b above based on your requirements. Here
are some examples:
Elie KHOURY's avatar
Elie KHOURY committed
42

43
44
Modify your setup.py and download from PyPI
===========================================
Elie KHOURY's avatar
Elie KHOURY committed
45

46
47
48
49
That is the easiest. Edit your ``setup.py`` in your satellite package and add
the following entry in the ``install_requires`` section (note: ``...`` means
`whatever extra stuff you may have in-between`, don't put that on your
script)::
50

51
52
53
54
    install_requires=[
      ...
      "bob.db.cbsr_nir_vis_2",
    ],
55

56
57
Proceed normally with your ``boostrap/buildout`` steps and you should be all
set. That means you can now import the ``bob.db.cbsr_nir_vis_2`` namespace into your scripts.
58

59
60
Modify your buildout.cfg and download from git
==============================================
Elie KHOURY's avatar
Elie KHOURY committed
61

62
63
64
65
You will need to add a dependence to `mr.developer
<http://pypi.python.org/pypi/mr.developer/>`_ to be able to install from our
git repositories. Your ``buildout.cfg`` file should contain the following
lines::
Elie KHOURY's avatar
Elie KHOURY committed
66

67
68
69
70
71
72
  [buildout]
  ...
  extensions = mr.developer
  auto-checkout = *
  eggs = bob
         ...
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
73
         bob.db.cbsr_nir_vis_2
Elie KHOURY's avatar
Elie KHOURY committed
74

75
  [sources]
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
76
  bob.db.cbsr_nir_vis_2 = git https://github.com/bioidiap/bob.db.cbsr_nir_vis_2.git
77
  ...