Приложение 1. Общие параметры конфигурации#
Общие параметры изменяются в реестре (для Windows) файлах server.conf (Таблица 7) иrsengine.conf (Таблица 8). Параметры конфигурации реестра Windows представлены в Таблице 9.
Таблица 7. Общие параметры конфигурации в файле server.conf
| Наименование параметра | Тип данных | Знач. по умолч. | Описание |
|---|---|---|---|
data-path |
string |
./data. |
Путь к каталогу данных RSE Server. |
| Не рекомендуется изменять значение параметра. | |||
rsengine-conf-path |
string |
./client/rsengine.conf |
Путь к config-файлу библиотеки RSEngine. |
| Актуален для настройки Системы на ОС Ubuntu 18.04 x64 и Debian 10 x64 и ОС Windows, использующей файлы конфигурации | |||
cs-communication |
string |
msg-pack |
Тип взаимодействия сервера с клиентом. Зависит от выбранной конфигурации Системы. Может принимать следующие значения: |
- json: возвращаемый сервером тип данных – JSON; |
|||
- msg-pack: возвращаемый сервером тип данных – MessagePack |
|||
bestshot-format |
string |
jpg |
Возвращаемый формат изображения лучших кадров. Выбирается исходя из требований внешнего ПО. Может принимать следующие значения: |
- jpg: Формат JPEG; |
|||
- png: Формат PNG |
|||
save-bestshot-ondisk |
int |
0 |
Сохранение лучших кадров на диск в директорию save-bestshot-path/SaveBestshotPath. Не используется в этой версии Системы. |
- 0 – не сохранять; |
|||
- 1 – сохранять. |
|||
save-bestshot-path |
string |
./bestshots |
Директория сохранения лучших кадров при активации переменной save-bestshot-ondisk/SaveBestshotonDisk. |
| Не используется в этой версии Системы. | |||
encrypt-bestshot |
int |
0 |
Шифрование лучших кадров при их сохранении. Не используется в этой версии Системы. |
- 0 – не шифровать; |
|||
- 1 – шифровать. |
|||
server-host |
string |
127.0.0.1 |
IP адрес сервера на котором следует запуститься чтобы слушать вебсокет соединения. |
| При использовании одной копии необходимо указывать localhost, при Использовании нескольких запущенных копий – указывать главный сервер. | |||
server-port |
int |
4444 |
Порт, на котором RSE Server принимает соединения |
log-level |
int, [0, 3] |
1 |
Уровень логирования фильтрует сообщения журнала и имеет следующие уровни от 0 до 3: |
- 0 – отключение логирования; |
|||
- 1 – логирование информации о работе; |
|||
- 2 – логирование предупреждений и информации о работе; |
|||
- 3 – логирование ошибок, предупреждений и информации о работе. |
|||
log-path |
string |
./logs |
Путь к доступному для записи каталогу для хранения журналов сервера |
Таблица 8. Общие параметры конфигурации в файле rsengine.conf
| Наименование параметра | Тип данных | Знач. по умолч. | Описание |
|---|---|---|---|
processor-strategy |
string |
realsense |
Режим работы Системы с камерами. |
- realsense – работа с камерами Intel RealSense |
|||
- orbbec – работа с камерами VLS |
|||
camera-monitoring |
int |
1 |
Параметр включает/выключает мониторинг состояния камеры. |
- 0 – выключает мониторинг; |
|||
- 1 – включает мониторинг |
|||
camera-monitoring-delay |
int |
300 |
Параметр устанавливает в секундах частоту опроса состояния камеры у службы мониторинга |
rgb-ir-match |
int |
0 |
Использование данных с RGB и IR камер для проведения проверок.Не рекомендуется изменять данный параметр. |
- 0 – отключено; |
|||
- 1 – включено. |
|||
check-eyes |
int |
0 |
Использование информации о положении и статусе глаз при проверке Liveness. |
- 0 – отключено; |
|||
- 1 – включено. |
|||
check-mouth |
int |
0 |
Использование информации о статусе рта при проверке Liveness. |
- 0 – отключено; |
|||
- 1 – включено. |
|||
liveness-depth |
int |
1 |
Использование информации об объемности лица на изображении при проверке Liveness.Не рекомендуется изменять данный параметр. |
- 0 – отключено; |
|||
- 1 – включено. |
|||
liveness-depth-fpr |
int |
1 |
Проверка FPR Liveness. Не рекомендуется изменять данный параметр. |
- 0 – отключено; |
|||
- 1 – включено. |
|||
liveness-depth-threshold |
float |
0.0 |
Минимальный порог значения Liveness при проверки лица на объемном изображении. |
| Проверка не используется в этой версии. | |||
| Порог задается в диапазоне от 0.0 до 1.0 (0…100 для Windows), где: | |||
- 0 – проверка не проводится |
|||
- 0.1 – высокая вероятность пропуска фейка |
|||
- 1 – малая вероятность пропуска фейка, высокая вероятность пропуска реального человека |
|||
liveness-depth-fpr-threshold |
float |
0.7 |
Минимальный порог значения Liveness при проверки лица.Параметр подбирается аналитически разработчиками и не рекомендуется к изменению.Порог задается в диапазоне от 0.0 до 1.0 (0…100 для Windows), где: |
- 0 – проверка не проводится |
|||
- 0.1 – высокая вероятность пропуска фейка |
|||
- 1 – малая вероятность пропуска фейка, высокая вероятность пропуска реального человека |
|||
rgb-coordinates-transfer |
int |
1 |
Передача координат Bbox лица с RGB изображения в IR изображения для последующей обработки. |
- 0 – отключено; |
|||
- 1 – включено. |
|||
iou-liveness-threshold |
float |
0.5 |
Пороговое значения для использования IoU при построении Bbox. |
| Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. | |||
| Порог задается в диапазоне от 0.0 до 1.0 (0…100 для Windows). | |||
quality-threshold |
float |
0.8 |
Минимальный порог оценки качества изображения перед проверкой Liveness.Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. |
| Порог задается в диапазоне от 0.0 до 1.0 (0…100 для Windows). | |||
rgb-ir-match-threshold |
float |
1.2 |
Порог сравнения лица с IR и RGB изображений. |
| Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. | |||
| Порог задается в диапазоне от 0.0 до 1.0 (0…100 для Windows). | |||
disparity-shift |
int |
0 |
Использования сдвига при сравнении лица с IR и RGB изображений.Не используется в этой версии. |
- 0 – отключено; |
|||
- 1 – включено. |
|||
width |
int |
90 |
Минимальная ширина Bbox в пикселях для проведения проверки Liveness. |
| Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. | |||
| 80…150 пикселей. | |||
height |
int |
90 |
Минимальная высота Bbox в пикселях для проведения проверки Liveness. |
| Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. | |||
| 80…150 пикселей. | |||
margin |
int |
10 |
Минимальный отступ между Bbox лица и границами кадра в пикселях. Лицо должно находиться в минимум 10 пикселях от граница кадра при проведении проверки Liveness, чтобы не была потеряна информация о лице. |
| 10…100 пикселей. | |||
suspicious-threshold |
float |
0.6 |
Минимальный порог оценки качества изображения, при котором будет произведена проверка Liveness. |
| Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. | |||
| Порог задается в диапазоне от 0.0 до 1.0 (0…100 для Windows). | |||
light-threshold |
float |
0.9 |
Минимальный порог оценки качества освещенности лица на изображении, при котором будет произведена проверка Liveness. |
| Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. | |||
| Порог задается в диапазоне от 0.0 до 1.0 (0…100 для Windows). | |||
dark-threshold |
float |
0.93 |
Минимальный порог оценки качества затемненности лица на изображении, при котором будет произведена проверка Liveness. |
| Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. | |||
| Порог задается в диапазоне от 0.0 до 1.0 (0…100 для Windows). | |||
blur-threshold |
float |
0.94 |
Минимальный порог оценки качества размытости лица на изображении, при котором будет произведена проверка Liveness. |
| Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. | |||
| Порог задается в диапазоне от 0.0 до 1.0 (0…100 для Windows). | |||
yaw-threshold |
int |
15 |
Максимальный угол наклона головы относительно оси камеры, при котором будет произведена проверка Liveness. |
| Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. | |||
pitch-threshold |
int |
15 |
Максимальный угол вращения головы относительно оси камеры, при котором будет произведена проверка Liveness. |
| Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. | |||
roll-threshold |
int |
10 |
Максимальный угол поворота головы относительно оси камеры, при котором будет произведена проверка Liveness. |
| Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. | |||
autoexp-rgb |
int |
1 |
Включение режима авто экспозиции для RGB изображения. Не рекомендуется отключать эту настройку. |
- 0 – отключено; |
|||
- 1 – включено. |
|||
autoexp-ir |
int |
1 |
Включение режима авто экспозиции для IR изображения.Не рекомендуется отключать эту настройку. |
- 0 – отключено; |
|||
- 1 – включено. |
|||
ir-stream-darkness-check |
int |
0 |
Проверка недостатка освещения изображения на IR изображении. |
| Не используется в этой версии. | |||
roi-enable |
int |
1 |
Использование обрезки исходного кадра для уменьшения зоны интереса для повышения качества распознавания. Преднастроенные ниже параметры ограничивают центральную часть кадра, где лицо искажено меньше всего. |
| Не рекомендуется отключать эту настройку. | |||
- 0 – отключено; |
|||
- 1 – включено. |
|||
roi-x |
int |
160 |
Горизонтальная координата левого верхнего угла зоны интереса. Задается от верхнего левого угла кадра. |
| Не рекомендуется изменять данный параметр. | |||
roi-y |
int |
0 |
Вертикальная координата левого верхнего угла зоны интереса. Задается от верхнего левого угла кадра. |
| Не рекомендуется изменять данный параметр. | |||
roi-width |
int |
320 |
Ширина зоны интереса.Не рекомендуется изменять данный параметр. |
roi-height |
int |
480 |
Высота зоны интереса.Не рекомендуется изменять данный параметр. |
Таблица 9. Параметры конфигурации реестра Windows
| Наименование параметра | Тип данных | Знач. по умолч. | Описание |
|---|---|---|---|
DataPath |
REG_SZ |
{Path to system files}/data |
Путь к каталогу данных RSE Server. |
| Не рекомендуется изменять значение параметра. | |||
CSCommunication |
REG_SZ |
msg-pack |
Тип взаимодействия сервера с клиентом. Зависит от выбранной конфигурации Системы. Может принимать следующие значения: |
- json: возвращаемый сервером тип данных – JSON; |
|||
- msg-pack: возвращаемый сервером тип данных – MessagePack |
|||
BestshotFormat |
REG_SZ |
jpg |
Возвращаемый формат изображения лучших кадров. Выбирается исходя из требований внешнего ПО. Может принимать следующие значения: |
- jpg: Формат JPEG; |
|||
- png: Формат PNG |
|||
SaveBestshotonDisk |
REG_DWORD |
0 |
Сохранение лучших кадров на диск в директорию save-bestshot-path/SaveBestshotPath. Не используется в этой версии Системы. |
- 0 – не сохранять; |
|||
- 1 – сохранять. |
|||
save-bestshot-path |
string |
./bestshots |
Директория сохранения лучших кадров при активации переменной save-bestshot-ondisk/SaveBestshotonDisk. |
| Не используется в этой версии Системы. | |||
EncryptBestshot |
REG_DWORD |
0 |
Шифрование лучших кадров при их сохранении. Не используется в этой версии Системы. |
- 0 – не шифровать; |
|||
- 1 – шифровать. |
|||
ServerHost |
REG_SZ |
127.0.0.1 |
Адрес сервера на котором развернут RSE Server. |
| При использовании одной копии необходимо указывать localhost, при Использовании нескольких запущенных копий – указывать главный сервер. | |||
ServerPort |
REG_DWORD |
4444 |
Порт, на котором RSE Server принимает соединения |
log-level |
int, [0, 3] |
1 |
LogLevel |
- 0 – отключение логирования; |
|||
- 1 – логирование информации о работе; |
|||
- 2 – логирование предупреждений и информации о работе; |
|||
- 3 – логирование ошибок, предупреждений и информации о работе. |
|||
LogPath |
REG_SZ |
C:\RSE\logs |
Путь к доступному для записи каталогу для хранения журналов сервера |
ProcessorStrategy |
REG_SZ |
realsense |
Режим работы Системы с камерами. |
- realsense – работа с камерами Intel RealSense |
|||
- orbbec – работа с камерами VLS |
|||
CameraMonitoring |
REG_DWORD |
1 |
Параметр включает/выключает мониторинг состояния камеры. |
- 0 – выключает мониторинг; |
|||
- 1 – включает мониторинг. |
|||
CameraMonitoringDelay |
REG_DWORD |
300 |
Параметр устанавливает в секундах частоту опроса состояния камеры у службы мониторинга |
RgbIrMatch |
REG_DWORD |
0 |
Использование данных с RGB и IR камер для проведения проверок.Не рекомендуется изменять данный параметр. |
- 0 – отключено; |
|||
- 1 – включено. |
|||
CheckEyes |
REG_DWORD |
0 |
Использование информации о положении и статусе глаз при проверке Liveness. |
- 0 – отключено; |
|||
- 1 – включено. |
|||
CheckMouth |
REG_DWORD |
0 |
Использование информации о статусе рта при проверке Liveness. |
- 0 – отключено; |
|||
- 1 – включено. |
|||
LivenessDepth |
REG_DWORD |
1 |
Использование информации об объемности лица на изображении при проверке Liveness.Не рекомендуется изменять данный параметр. |
- 0 – отключено; |
|||
- 1 – включено. |
|||
LivenessDepthFPR |
REG_DWORD |
1 |
Проверка FPR Liveness. Не рекомендуется изменять данный параметр. |
- 0 – отключено; |
|||
- 1 – включено. |
|||
LivenessDepthThreshold |
REG_DWORD |
0 |
Минимальный порог значения Liveness при проверки лица на объемном изображении. |
| Проверка не используется в этой версии. | |||
| Порог задается в диапазоне от 0.0 до 1.0 (0…100 для Windows), где: | |||
- 0 – проверка не проводится |
|||
- 0.1 – высокая вероятность пропуска фейка |
|||
- 1 – малая вероятность пропуска фейка, высокая вероятность пропуска реального человека |
|||
LivenessDepthFPR Threshold |
REG_DWORD |
70 |
Минимальный порог значения Liveness при проверки лица.Параметр подбирается аналитически разработчиками и не рекомендуется к изменению.Порог задается в диапазоне от 0.0 до 1.0 (0…100 для Windows), где: |
- 0 – проверка не проводится |
|||
- 0.1 – высокая вероятность пропуска фейка |
|||
- 1 – малая вероятность пропуска фейка, высокая вероятность пропуска реального человека |
|||
RGBCoordinatesTransfer |
REG_DWORD |
1 |
Передача координат Bbox лица с RGB изображения в IR изображения для последующей обработки. |
- 0 – отключено; |
|||
- 1 – включено. |
|||
IOULivenessThreshold |
REG_DWORD |
50 |
Пороговое значения для использования IoU при построении Bbox. |
| Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. | |||
| Порог задается в диапазоне от 0.0 до 1.0 (0…100 для Windows). | |||
QualityThreshold |
REG_DWORD |
80 |
Минимальный порог оценки качества изображения перед проверкой Liveness.Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. |
| Порог задается в диапазоне от 0.0 до 1.0 (0…100 для Windows). | |||
RgbIRMatchThreshold |
REG_DWORD |
120 |
Порог сравнения лица с IR и RGB изображений. |
| Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. | |||
| Порог задается в диапазоне от 0.0 до 1.0 (0…100 для Windows). | |||
DisparityShift |
REG_DWORD |
0 |
Использования сдвига при сравнении лица с IR и RGB изображений.Не используется в этой версии. |
- 0 – отключено; |
|||
- 1 – включено. |
|||
Width |
REG_DWORD |
90 |
Минимальная ширина Bbox в пикселях для проведения проверки Liveness. |
| Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. | |||
| 80…150 пикселей. | |||
Height |
REG_DWORD |
90 |
Минимальная высота Bbox в пикселях для проведения проверки Liveness. |
| Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. | |||
| 80…150 пикселей. | |||
Margin |
REG_DWORD |
20 |
Минимальный отступ между Bbox лица и границами кадра в пикселях. Лицо должно находиться в минимум 10 пикселях от граница кадра при проведении проверки Liveness, чтобы не была потеряна информация о лице. |
| 10…100 пикселей. | |||
SuspiciousThreshold |
REG_DWORD |
60 |
Минимальный порог оценки качества изображения, при котором будет произведена проверка Liveness. |
| Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. | |||
| Порог задается в диапазоне от 0.0 до 1.0 (0…100 для Windows). | |||
LightThreshold |
REG_DWORD |
90 |
Минимальный порог оценки качества освещенности лица на изображении, при котором будет произведена проверка Liveness. |
| Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. | |||
| Порог задается в диапазоне от 0.0 до 1.0 (0…100 для Windows). | |||
DarkThreshold |
REG_DWORD |
93 |
Минимальный порог оценки качества затемненности лица на изображении, при котором будет произведена проверка Liveness. |
| Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. | |||
| Порог задается в диапазоне от 0.0 до 1.0 (0…100 для Windows). | |||
BlurThreshold |
REG_DWORD |
94 |
Минимальный порог оценки качества размытости лица на изображении, при котором будет произведена проверка Liveness. |
| Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. | |||
| Порог задается в диапазоне от 0.0 до 1.0 (0…100 для Windows). | |||
YawThreshold |
REG_DWORD |
15 |
Максимальный угол наклона головы относительно оси камеры, при котором будет произведена проверка Liveness. |
| Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. | |||
PitchThreshold |
REG_DWORD |
15 |
Максимальный угол вращения головы относительно оси камеры, при котором будет произведена проверка Liveness. |
| Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. | |||
RollThreshold |
REG_DWORD |
10 |
Максимальный угол поворота головы относительно оси камеры, при котором будет произведена проверка Liveness. |
| Параметр подбирается аналитически разработчиками и не рекомендуется к изменению. | |||
AutoexpRGB |
REG_DWORD |
1 |
Включение режима авто экспозиции для RGB изображения. Не рекомендуется отключать эту настройку. |
- 0 – отключено; |
|||
- 1 – включено. |
|||
AutoexpIR |
REG_DWORD |
1 |
Включение режима авто экспозиции для IR изображения.Не рекомендуется отключать эту настройку. |
- 0 – отключено; |
|||
- 1 – включено. |
|||
IRStreamDarknessCheck |
REG_DWORD |
0 |
Проверка недостатка освещения изображения на IR изображении. |
| Не используется в этой версии. | |||
RoiEnable |
REG_DWORD |
1 |
Использование обрезки исходного кадра для уменьшения зоны интереса для повышения качества распознавания. Преднастроенные ниже параметры ограничивают центральную часть кадра, где лицо искажено меньше всего. |
| Не рекомендуется отключать эту настройку. | |||
- 0 – отключено; |
|||
- 1 – включено. |
|||
RoiX |
REG_DWORD |
160 |
Горизонтальная координата левого верхнего угла зоны интереса. Задается от верхнего левого угла кадра. |
| Не рекомендуется изменять данный параметр. | |||
RoiY |
REG_DWORD |
0 |
Вертикальная координата левого верхнего угла зоны интереса. Задается от верхнего левого угла кадра. |
| Не рекомендуется изменять данный параметр. | |||
RoiWidth |
REG_DWORD |
320 |
Ширина зоны интереса.Не рекомендуется изменять данный параметр. |
RoiHeight |
REG_DWORD |
480 |
Высота зоны интереса.Не рекомендуется изменять данный параметр. |