.. _`kognihome/mirror/face`:

KogniMirror-Gesichtserkennung
=============================

:Kontakt: Alexander Neumann <alneuman@techfak.uni-bielefeld.de>
:CITK: `kognimirror-facedetection <https://opensource.cit-ec.de/projects/citk/repository/revisions/master/entry/projects/kognimirror-openface.project>`_
:Vorbedingung:
  Es wird `openface <https://github.com/cmusatyalab/openface>` benötigt.
  Diese muss im ``PYTHONPATH`` verfügbar sein.

:Quickstart:

  Das Paket installiert eine Anwendung namens ``smartface``, welche mit einer Anweisung und einem
  Arbeitspfad (-w) gestartet wird.

	    ${prefix}/bin/smartface detect -w ${db_path}

  Neben ``detect`` wird noch ``capture`` (Aufnahme von Trainingsbildern) und
  ``train`` (Training des neuralen Netzwerkes) unterstützt. ``detect`` startet den Erkennungsmodus
  und erlaubt das nachtrainieren über RSB. Wichtig ist, dass ``detect`` nur dann funktioniert, wenn
  sich bereits 2 trainierte Klassen in ``db_path`` befinden.

RSB-Schnittstellen
------------------

.. rsbpubsub:: IN /io/display/mirror/faceMode string Der gewünschte Modus (Training, Detection)

.. rsbpubsublist::
    :type: IN

.. rsbpubsub:: OUT-Pub-2 /io/display/mirror/face string Detektierte Person vor dem Spiegel

.. rsbpubsublist::
    :type: OUT


Parameter
---------

Auszug aus der Hilfe::

    usage: smartface [-h] [-w WORKDIR] [-p] [-n NAME] [-v VIDEO VIDEO]
                     [-r ROI ROI ROI ROI] [-c] [-t THREADS] [-l LIMIT] [-s SIZE]
                     [-d DEVICE] [-m CONFIDENCE]
                     {capture,train,detect}

    Openface for Smart Mirrors

    positional arguments:
      {capture,train,detect}

    optional arguments:
      -h, --help            show this help message and exit
      -w WORKDIR, --workdir WORKDIR
                            database and feature directory [required]
      -p, --prune           prune person dataset before capturing
      -n NAME, --name NAME  name/label for captured data
      -v VIDEO VIDEO, --video VIDEO VIDEO
                            face detection image resolution (w h)
      -r ROI ROI ROI ROI, --roi ROI ROI ROI ROI
                            region of interest for face detection (x y w h) in
                            relative(!) coordinates
      -c, --cuda            use cuda
      -t THREADS, --threads THREADS
                            number of image alignment parallel threads
      -l LIMIT, --limit LIMIT
                            amount of images to capture
      -s SIZE, --size SIZE  image width of database faces
      -d DEVICE, --device DEVICE
                            opencv video device id
      -m CONFIDENCE, --min-confidence CONFIDENCE
                            minimal detection confidence