Параметры конфигурации¶
Параметры конфигурации видеодетектора задаются одним из следующих способов:
непосредственно в интерфейсе командной строки как опции команды запуска видеодетектора;
fkvideo_detector [options]
в файле конфигурации.
Предупреждение
По умолчанию в качестве файла конфигурации fkvideo_detector используется файл
/etc/fkvideo.ini. Не редактируйте файл/etc/fkvideo.ini, особенно если fkvideo_detector и веб-интерфейс FindFace установлены на одном физическом сервере, т. к. веб-интерфейс тоже использует данный файл. Вместо этого скопируйте файл, отредактируйте копию и укажите ее в опции-cпри запуске fkvideo_detector.sudo cp /etc/fkvideo.ini /etc/fkvideo_example.ini fkvideo_detector -c /etc/fkvideo_example.ini
В этом разделе:
Аргументы в командной строке¶
Использование:
fkvideo_detector [options]
Опции:
Предупреждение
Опции api-host, api-port, api-token, --license-ntls-server являются обязательными.
| Опция | Описание | Аргумент | Пример |
|---|---|---|---|
| -c [ ‑‑config ] arg | Запускает видеодетектор лиц с заданным файлом конфигурации .ini. Если параметр задан как в командной строке, так и в файле конфигурации, значение в командной строке будет иметь приоритет. |
Путь к файлу конфигурации .ini. Если имя файла указывается без полного пути, видеодетектор лиц ищет файл в папке своей установки. По умолчанию файл конфигурации fkvideo_detector /etc/fkvideo.ini. Если fkvideo_detector и веб-интерфейс FindFace установлены на одном физическом сервере, не редактируйте файл /etc/fkvideo.ini, поскольку он также используется веб-интерфейсом FindFace. Вместо этого скопируйте данный файл, отредактируйте копию и укажите ее в опции -c при запуске fkvideo_detector. |
$ fkvideo_detector -c /etc/fkvideo_example.ini |
| ‑‑license-ntls-server arg | Обязательная опция. Определяет IP-адрес и порт локального сервера лицензий NTLS. Редактируется только в случае удаленного NTLS. | IP-адрес:порт | ‑‑license-ntls-server 192.168.10.1:3133 |
| -n [ ‑‑detector-name ] arg | Применяет видеодетектор к заданному списку видеокамер. | Уникальный идентификатор виртуального детектора (по умолчанию имя локального сервера), соответствующего определенному списку видеокамер на Сервере FindFace. | ‑‑detector-name detec1 |
| -d [ ‑‑detectors-max ] arg | Определяет максимальное количество видеопотоков, обрабатываемых видеодетектором лиц. | Максимальное количество видеопотоков, одновременно обрабатываемых видеодетектором лиц (по умолчанию 5). | ‑‑detectors-max 7 |
| -t [ ‑‑reload-timeout ] arg | Определяет интервал в секундах между 2-мя последовательными запросами, отправляемыми видеодетектором лиц на Сервер для обновления списка видеокамер. | Интервал в секундах между 2-мя последовательными обновлениями списка видеокамер (по умолчанию 15 с). | -t 20 |
| ‑‑camid arg | Задает видеопоток для отслеживания как ID видеокамеры (см. также --source). Если видеопоток не задан, видеодетектор лиц запрашивает список видеокамер у Сервера FindFace с интервалом reload-timeout. |
ID видеокамеры. | ‑‑camid b28a898b-6334 |
| ‑‑api-host arg | Обязательная опция. Определяет физический сервер findface-facenapi в составе Сервера FindFace, на который видеодетектор лиц отправляет API-запросы. |
IP-адрес сервера FindFace. | ‑‑api-host 127.0.0.1 |
| ‑‑api-port arg | Обязательная опция. Определяет порт физического сервера findface-facenapi для API-запросов. |
Номер порта. | ‑‑api-port 8000 |
| ‑‑api-token arg | Обязательная опция. Определяет токен авторизации для Сервера FindFace. | Токен авторизация. | ‑‑api-token c9FsRNDAt |
| -S [ ‑‑source ] arg | Задает видеопоток для отслеживания как адрес видеокамеры (см. также --camid). Если видеопоток не задан, видеодетектор лиц запрашивает список видеокамер у Сервера FindFace с интервалом reload-timeout. |
Адрес видеокамеры: rtsp://… — сетевой видеопоток; /dev/video0 — веб-камера; file@FPS:PATH - видеофайл с настраиваемой частотой кадров в секунду (FPS). | ‑‑source rtsp://192.168.120.55:500 |
| ‑‑source-params arg | Задает опции ffmeg для видеопотока. | Список опций ffmeg с присвоенными значениями. | ‑‑source-params rtsp_transport=tcp, rtsp_flags=prefer, timeout=-1 |
| ‑‑md-threshold arg | Определяет минимальную интенсивность движения, которая будет регистрироваться детектором движения. Пороговое значение определяется эмпирически. | Интенсивность движения в эмпирических единицах (ноль и положительные рациональные числа). Реперные точки: 0 = детектор выключен, 0.002 = значение по умолчанию, 0.05 = минимальная интенсивность слишком высока, чтобы зарегистрировать движение. | ‑‑md-threshold 0.003 |
| ‑‑scale arg | Изменяет размер кадра для детектора движения. Кадр должен быть уменьшен при больших разрешениях камеры, отображении лиц крупным планом, а также при чрезмерной загрузке процессора — для снижения потребления системных ресурсов. Убедитесь, что размер лиц после уменьшения превышает значение параметра min-face-size. |
Коэффициент изменения размера видеокадра. | ‑‑scale 0.3 |
| ‑‑request-url arg | Определяет метод API-запросов, которые отправляюся видеодетектором лиц на Сервер FindFace при обнаружении лица. | /v0/face/ или /v0/identify/. | ‑‑request-url /v0/identify |
| ‑‑camera-url arg | Определяет метод API-запросов, которые отправляются видеодетектором лиц на Сервер FindFace для получения списка камер. | /v0/camera (по умолчанию) или /v1/camera. | ‑‑camera-url /v1/camera |
| ‑‑img-arg arg | Определяет имя аргумента с изображением лица, отправляемым в API-запросе. | Имя аргумента (по умолчанию photo). | ‑‑img-arg picture |
| ‑‑req-timeout arg | Определяет время ожидания ответа от Сервера FindFace на API-запрос видеодетектора лиц. | Время ожидания API-ответа в секундах (по умолчанию 3 с). | ‑‑req-timeout 2 |
| ‑‑headers arg | Создает дополнительный заголовок в POST-запросе с изображением лица. | Дополнительный заголовок (заголовки) в POST-запросе. | ‑‑headers xxx = yyy ‑‑headers kkk = ppp |
| ‑‑body arg | Создает дополнительное поле в POST-запросе с изображением лица. | Дополнительное поле (поля). | ‑‑body galleries=testgal ‑‑body gender=true ‑‑body age=true ‑‑body emotions=true ‑‑body meta=video.mp4 |
| ‑‑bbox-scale | Изменяет размер изображения лица. | Коэффициент изменения размера лица (по умолчанию 1). | ‑‑bbox-scale 1.3 |
| ‑‑post-uniq arg | Включает отправку на Сервер только нескольких лиц, принадлежащих одному человеку, из множества захваченных в течение определенного промежутка времени. В этом случае, если видеодетектор лиц отправляет лицо на Сервер и затем захватывает еще одно в течение периода времени uc-max-time-diff, и если расстояние между лицами не превышает значение uc-max-avg-shift, видеодетектор лиц оценивает их схожесть. Если лица схожи и общее количество схожих лиц в течение периода времени uc-max-time-diff не превышает число uc-max-dup, видеодетектор отправляет на Сервер второе лицо. Иначе, второе лицо не отправляется. |
Логический: 1 = только определенное количество лиц из множества принадлежащих одному человеку отправляется на Сервер, 0 = все захваченные лица отправляются на Сервер. | ‑‑post-uniq 1 |
| ‑‑uc-max-time-diff arg | Только для --post-uniq=1. Определяет максимальный период времени, в течение которого схожие лица рассматриваются как лица одного человека. |
Максимальный период времени в секундах. | ‑‑uc-max-time-diff 1 |
| ‑‑uc-max-dup arg | Только для --post-uniq=1. Определяет максимальное количество лиц в течение периода времени uc-max-time-diff, которое отправляется на Сервер для одного человека. |
Максимальное количество лиц. | ‑‑uc-max-dup 3 |
| ‑‑uc-max-avg-shift arg | Только для --post-uniq=1. Определяет максимальное расстояние, на котором схожие лица еще рассматриваются как лица одного человека. |
Расстояние в пикселях. | ‑‑uc-max-avg-shift 10 |
| -r [ ‑‑realtime ] [=arg(=1)] | Включает режим реального времени видеодетектора. | Режим работы fkvideo_detector: 1 = реального времени, 0 = буферный режим. Записи -r и -r 1 идентичны. | -r или -r 1, -r 0 |
| ‑‑min-score arg | Определяет пороговое значение качества изображения лица. Лицо отправляется на Сервер, если его изображение лучшего качества. Пороговое значение определяется эмпирически. | Пороговое значение качества изображения лица в эмпирических единицах (отрицательные рациональные числа до нуля). Реперные точки: 0 = высокое качество изображения, -1 = хорошее качество, -2 = удовлетворительное качество, -5 = распознавание лица может быть неэффективным. Значение по умолчанию -7. | ‑‑min-score -1.5 |
| ‑‑min-dir-score arg | Определяет максимальное отклонение лица от положения анфас. Лицо отправляется на Сервер FindFace, если отклонение не превышает заданного значения (определяется эмпирически). | Максимальное отклонение лица от положения анфас в эмпирических единицах (отрицательные рациональные числа до нуля). Реперные точки: -3.5 = допускаются лица, повернутые под большим углом, распознавание может быть неэффективно, -2.5 = удовлетворительное качество, -0.05 = близко к фронтальной позиции, 0 = анфас. Значение по умолчанию -1000. | ‑‑min-dir-score -1 |
| ‑‑rt-refresh arg | Только для режима реального времени. Определяет временной интервал между 2-мя последовательными обнулениями счетчика при динамическом поиске лучшего изображения лица. | Временной интервал в миллисекундах. Значение по умолчанию 0 (обнуление отключено). | ‑‑rt-refresh 10 |
| ‑‑rt-score-step arg | Только для режима реального времени. Определяет шаг увеличения порогового значения качества при динамическом поиске лучшего изображения лица. | Шаг увеличения порогового изображения (положительные рациональные числа). | ‑‑rt-score-step 3.4 |
| ‑‑rt-delay arg | Только для режима реального времени. Определяет максимальный период времени между двумя последовательными отправками одного и того же лица, но в улучшенном качестве. | Период времени в миллисекундах между отправками одного и того же лица. | ‑‑rt-delay 100 |
| ‑‑rot arg | Включает детектирование и отслеживание лиц только внутри заданной прямоугольной области. Используйте данную опцию, чтобы уменьшить нагрузку на fkvideo_detector. | Прямоугольник: WxH+X+Y | ‑‑rot 150x123+300+155 |
| ‑‑roi arg | Включает отправку на Сервер FindFace лиц, обнаруженных только внутри интересующей области. | Интересующая область: WxH+X+Y. | ‑‑roi 123x122+159+220 |
| ‑‑draw-track [=arg(=1)] | Включает рисование в bbox следа от движения лица. | Логический: 1 = след рисуется, 0 = рисование следа отключено. Записи –draw-track и –draw-track 1 тождественны. | ‑‑draw-track |
| ‑‑min-face-size arg | Определяет минимальный размер лица. Лица меньшего размера на Сервер не отправляются. | Минимальный размер меньшей стороны прямоугольника с лицом, в пикселях. | ‑‑min-face-size 50 |
| ‑‑max-face-size arg | Определяет максимальный размер лица. Лица большего размера на Сервер не отправляются. | Максимальный размер большей стороны прямоугольника с лицом, в пикселях. | ‑‑max-face-size 120 |
| ‑‑max-persons arg | Определяет максимальное количество лиц, одновременно отслеживаемых трекером лиц. Данный параметр существенно влияет на производительность. | Максимальное количество одновременно отслеживаемых лиц. | ‑‑max-persons 4 |
| ‑‑single-pass [=arg(=1)] | Отключает периодические обновления списка видеокамер. Используйте эту опцию, если нужно обработать видеофайл. В этом случае видеодетектор лиц запросит список камер только один раз. | Логический: 1 = обновления отключены, 0 = обновления включены. Записи – single-pass и –single-pass 1 тождественны. | ‑‑single-pass 0 |
| ‑‑start-ts arg | Добавляет время обнаружения лица в API-запрос к Серверу FindFace. | Логический: 1 = метка времени добавляется, 0 = добавление метки времени отключено. | ‑‑start-ts 1 |
| ‑‑disable-drops [=arg(=1)] | Включает отправку на Сервер FindFace всех подходящих лиц без пропусков. По умолчанию, если fkvideo_detector не обладает достаточными ресурсами для обработки всех кадров с лицами, он отбрасывает некоторые из них. Если данная опция активна, fkvideo_detector помещает лишние кадры в очередь, чтобы обработать их впоследствии. | Логический: 1 = лишние кадры не отбрасываются, 0 = лишние кадры отбрасываются. Записи –disable-drops и –disable-drops 1 тождественны. | ‑‑disable-drops |
| ‑‑sink-url arg | Только в случае если fkvideo_detector обрабатывает одну видеокамеру (указанную в файле конфигурации или в командной строке). Определяет IP-адрес видео-сервера nginx для выходного видеопотока из fkvideo_detector (видео-сервер далее перенаправляет поток в веб-интерфейс FindFace). | IP-адрес и порт видео-сервера nginx. | ‑‑sink-url 192.168.15.1:3222 |
| ‑‑sink-res arg | Определяет разрешение выходного видеопотока. | Разрешение WхH | ‑‑sink-res 1280x720 |
| ‑‑tracker-threads arg | Определяет количество тредов отслеживания для трекера лиц. Данное значение должно быть меньше или равно значению параметра max-persons. Оптимально, когда они равны. Если количество тредов отслеживания меньше, чем максимальное количество отслеживаемых лиц, потребление ресурсов уменьшается, однако также уменьшается и скорость отслеживания. |
Количество тредов отслеживания. | ‑‑tracker-threads 4 |
| -h [ ‑‑help ] | Выводит справку по опциям видеодетектора лиц. | ─ | ─ |
Формат файла конфигурации¶
[General]
| long-arg=option ; long-arg from command line arguments
| ...
| license-ntls-server=192.168.10.1:3133
| source-params=rtsp_transport=tcp,rtsp_flags=prefer,timeout=-1
| body=galleries=testgal,gender=true,age=true,emotions=true,meta=video.mp4