.. _settings:

*********************************************
General Settings
*********************************************

The FindFace Multi general settings determine your system functioning and resource consumption. Here they are:

* generic confidence threshold
* thumbnail JPEG quality
* schedule for automatic events/episodes cleanup

The general settings for faces, bodies, and vehicles are provided separately, depending on the enabled recognition objects.

To configure the general settings, navigate :guilabel:`Settings` → :guilabel:`General`. After you are finished with adjustments, click :guilabel:`Update`.

|settings_en|

.. |settings_en| image:: /_static/settings_en.png
        :scale: 75%

.. |settings_ru| image:: /_static/settings_ru.png
        :scale: 75%

To work with VMS cleanup settings from the web interface, make sure that the ``vms_cleanup`` parameter is enabled in the ``findface-multi-legacy.py`` configuration file. Follow this instruction :ref:`vms_cleanup_ui`.


Find the detailed explanation of each general setting below.

.. rubric:: In this section:

.. contents::
   :local:


Generic Confidence Threshold
===============================

FindFace Multi verifies that objects match (i.e. two faces belong to the same person), based on the pre-defined confidence threshold. The default threshold is set to the optimum value. If necessary, you can change it.

.. note::
   The higher is the threshold, the less are chances that a wrong object will be positively verified, however, some valid photos may also fail verification.

.. tip::
   You can configure the confidence thresholds individually for each :ref:`camera group <camera-groups>` and :ref:`watch list <create-list>`.

.. include:: /_inclusions/threshold_important.rst


Thumbnail JPEG Quality
============================================

Subject to JPEG quality, thumbnails may take up a significant amount of disc volume. Use the :guilabel:`General` tab to configure the parameter.

.. _event_episode_cleanup:

Automatic Event and Episode Cleanup
===========================================

Use the same tab to schedule automatically purging old events and related episodes from the database. For example, you can purge matched and unmatched events/episodes on different schedules and purge only full frames.

.. tip::
   To delete all events for a specific parameter, set its ``Hours`` value to ``0`` (zero). The system will then remove events as scheduled by the ``CLEANUP_SCHEDULE`` parameter within the ``/opt/findface-multi/configs/findface-multi-legacy/findface-multi-legacy.py`` configuration file.

   For example, to clean up matched events for an object, specify ``0`` (zero) in the ``Delete matched events older than`` parameter. Then, :guilabel:`Update` the settings.

   |cleanup_param_en|

   .. |cleanup_param_en| image:: /_static/cleanup_param_en.png
        :scale: 75%

   .. |cleanup_param_ru| image:: /_static/cleanup_param_ru.png
        :scale: 75%


.. _global_vms_cleanup:

Global VMS Cleanup Settings
============================================

After you have :ref:`enabled VMS cleanup settings <vms_cleanup_ui>`, you can configure the regular video cleanup directly from the web interface.

|global_vms_cleanup_en|

.. |global_vms_cleanup_en| image:: /_static/global_vms_cleanup_en.png
        :scale: 75%

.. |global_vms_cleanup_ru| image:: /_static/global_vms_cleanup_ru.png
        :scale: 75%

The following settings are available:

* :guilabel:`Clean up between tracks`: remove those intervals between tracks that do not contain recognition events.
* :guilabel:`Save tracks of events`: save tracks of events for a selected object (face, body, or vehicle).
* :guilabel:`Keep events before and after`: a video interval in seconds before and after a track with events that is kept along with the track.
* :guilabel:`Cleanup threshold`: a minimum interval between tracks in seconds. If an interval between tracks is below the threshold, the video is not removed. A minimum allowed value for this field is 360 seconds.
* :guilabel:`Clean up between tracks from`: time period (in days) during which the entire video archive is kept. After this period, the intervals between tracks will be cleaned up as configured in the settings. The value can be greater than or equal to zero.
* :guilabel:`Clean up archive`: enable the entire video archive cleanup.
* :guilabel:`Archive cleanup age`: a number of days the video archive is kept in the system. After that period, the video archive is removed.

VMS cleanup settings in the general settings section apply globally to the system. To configure video cleanup for a single camera, switch to :ref:`custom VMS cleanup settings <custom_vms_cleanup>`.