Appendix 1: General configuration parameters

General parameters are changed in the registry (for Windows) files server.conf (Table 8) and rsengine.conf (Table 9). Windows registry configuration parameters are shown below (Table 10).

Table 8. Common configuration parameters in the server.conf file

Parameter name	Data type	Silent value	Description
data-path	string	./data.	Path RSE Server data directory. It is not recommended to change Parameter value.
rsengine-conf-path	string	./client/rsengine.conf	Path to RSEngine library config file. Relevant for setting up the System on Ubuntu 18.04 x64, Debian 10 x64, Armbian 23 and Windows OS using configuration files
cs-communication	string	msg-pack	The type of interaction between the server and the client. Depends on the selected System configuration. Can take the following values: json: the data type returned by the server is JSON; msg-pack: the data type returned by the server is MessagePack
bestshot-format	string	jpg	The returned image format of the bestshots. Selected based on the requirements of external software. Can accept the following values: jpg: JPEG format; png: PNG format
save-bestshot-ondisk	int	0	Saving bestshots to disk to the directory save-bestshot-path/SaveBestshotPath. 0–do not save; 1–save.
save-bestshot-path	string	./bestshots	The directory for saving the best shots when the save-bestshot-ondisk/SaveBestshotonDisk variable is activated.
encrypt-bestshot	int	0	Encryption of the bestshots when saving them. Not used in this version of the System. 0–do not encrypt; 1–encrypt.
server-host	string	127.0.0.1	IP address of the server on which to run to accept websocket connection. When using one copy, specify localhost; when using several running copies, specify the main server.
server-port	int	4444	Port on which RSE Server accepts connections
log-level	int, [0, 3]	1	The logging level filters log messages and has the following levels from 0 to 3: 0–disable logging; 1–logging information about work; 2–logging warnings and information about work; 3–logging errors, warnings and operation information.
log-path	string	./logs	Path to a writable directory for storing server logs
log-file-rotation	int	0	Daily log rotation 0–disabled; 1–enabled.
continuous-bestshots	int	0	Continue to receive bestshots in the session, even if bestshot has already been received 0–disabled; 1–enabled.

\newpage

Table 9. Common configuration parameters in the rsengine.conf file

In the rsengine.conf file, the unique settings for each camera are separated into blocks.

Parameter name	Data type	Silent value	Description
processor-strategy	string	IntelRealSense	Camera System Mode: IntelRealSense–working with Intel RealSense camera; VLSLunaCamera3D–working with VLS LUNA CAMERA 3D; VLSLunaCamera2D–working with VLS LUNA CAMERA 2D.
camera-monitoring	int	1	Parameter enables/disables monitoring of the camera status. 0–turns off monitoring; 1–turns on monitoring
camera-monitoring-delay	int	300	Parameter sets the request frequency for the camera status from the monitoring service
rgb-ir-match	int	0	Using RGB and IR camera data to perform checks It is not recommended to change this parameter. 0– off; 1– on.
check-eyes	int	1	Using information about eye position and status for checking Liveness. 0–off; 1–on.
check-mouth	int	0	Using information about mouth status for checking Liveness. 0–off; 1–on.
liveness-depth	int	1	Using information about face volumetric on image when checking Liveness. It is not recommended to change this parameter. 0–off; 1–on.
liveness-depth-fpr	int	1	FPR Liveness check. It is not recommended to change this parameter. 0–off; 1–on.
liveness-depth-threshold	float	0.0	The minimum threshold for the Liveness value when checking face in the volumetric image. Threshold is set between 0.0 and 1.0 (0...100 for Windows), where: 0–no check `0.1–high probability of missing a fake 1–low probability of missing a fake, high probability to miss a real person
liveness-depth-fpr-threshold	float	0.7	Minimum threshold for Liveness value while face checking Parameter is chosen analytically by the developers and is not recommended to be changed. The threshold is set in the range from 0.0 to 1.0 (0...100 for Windows), where: 0–no check 0.1–a high probability of missing a fake 1–low probability of missing a fake, high probability to miss a real person
rgb-coordinates-transfer	int	1	Transferring the Bbox coordinates of a face from an RGB image to an IR image for further processing. 0–off; 1–on.
iou-liveness-threshold	float	0.5	The threshold for using IOU when building a Bbox. Parameter is chosen analytically by the developers and is not recommended to be changed. The threshold is set in the range of 0.0 to 1.0 (0...100 for Windows).
quality-threshold	float	0.8	Minimum threshold for evaluating image quality before checking Liveness. Parameter is chosen analytically by the developers and is not recommended to change. The threshold is set between 0.0 and 1.0 (0...100 for Windows).
rgb-ir-match-threshold	float	1.2	Face comparison threshold from IR and RGB images. Parameter is chosen analytically by the developers and is not recommended to be changed. The threshold is set between 0.0 and 1.0 (0...100 for Windows).
margin	int	10	Minimum space between the face box and the frame boundaries in pixels. The face must be at least 10 pixels from the frame border when performing a Liveness check, so that face information is not lost. 10...100 pixels
suspicious-threshold	float	0.6	Minimum image quality threshold at which the Liveness check will be performed. Parameter is chosen analytically by the developers and is not is not recommended to be changed. The threshold is set in the range of 0.0 to 1.0 (0...100 for Windows).
light-threshold	float	0.9	Minimum threshold for checking the quality of face illumination at image at which the Liveness check will be performed. Parameter is chosen analytically by the developers and is not recommended to change. The threshold is set in the range of 0.0 to 1.0 (0...100 for Windows).
dark-threshold	float	0.93	Minimum threshold for checking the quality of darkness on the face. image at which the Liveness check will be performed. Parameter is chosen analytically by the developers and is not recommended to change. The threshold is set in the range of 0.0 to 1.0 (0...100 for Windows).
blur-threshold	float	0.94	Minimum threshold for checking the quality of blurred face image at which the Liveness check will be performed. Parameter is chosen analytically by the developers and is not recommended to change. The threshold is set in the range of 0.0 to 1.0 (0...100 for Windows).
yaw-threshold	int	15	Maximum head tilt angle relative to the camera axis,, at which the Liveness check will be performed. Parameter is chosen analytically by the developers and is not recommended to be changed.
pitch-threshold	int	15	Maximum head rotation angle relative to the camera axis, at which the Liveness check will be performed. Parameter is chosen analytically by the developers and is not recommended to be changed.
roll-threshold	int	10	Maximum head rotation angle relative to the camera axis, at which the Liveness check will be performed. Parameter is chosen analytically by the developers and is not recommended to be changed.
autoexp-rgb	int	1	Enable auto exposure mode for RGB images. It is not recommended to disable this setting. 0–off; 1–on.
autoexp-ir	int	1	Enable auto exposure mode for IR image. It is not recommended to disable this setting. 0–off; 1–on.
ir-stream-darkness-check	int	0	Check for lack of image illumination in IR image.
roi-enable	int	1	Cropping the original frame to reduce the area of interest to improve the recognition quality. The preset parameters below limit the central part of the frame, where the face is least distorted. It is not recommended that this setting be turned off. 0–off; 1–on.
roi-x	int	160	Horizontal coordinate of the upper left corner of the area of interest. Specified from the upper left corner of the frame. It is not recommended to change this parameter.
roi-y	int	0	Vertical coordinate of the top left corner of the area of interest. Set from the upper left corner of the frame. It is not recommended to change this parameter.
roi-width	int	320	Width of the area of ​​interest. It is not recommended to change this parameter.
roi-height	int	480	Height of the area of interest. It is not recommended to change this parameter.
frame-rotation	int	0	The rotation angle of the camera frame. Possible values: 0, 90, 180, 270. For the location of the camera depending on the rotation angle of the video frame, see the diagram below (Figure 5)
liveness-ir	int	1	IR Liveness check. 0–off; 1–is on

\newpage

Table 10. Windows Registry Configuration Settings

Parameter name	Data type	Silent value	Description
DataPath	REG_SZ	{Path to system files}/data	Path to RSE Server data directory. It is not recommended to change the value of Parameter.
CSCommunication	REG_SZ	msg-pack	The type of interaction between the server and the client. Depends on the selected System configuration. Can take the following values: json: the data type returned by the server is JSON; msg-pack: the data type returned by the server is MessagePack
BestshotFormat	REG_SZ	jpg	The returned image format of the bestshots. Selected based on the requirements of external software. Can accept the following values: jpg: JPEG format; png: PNG format
SaveBest shotonDisk	REG_DWORD	0	Saving the bestshots to disk to the directory save-bestshot-path/SaveBestshotPath. 0–do not save; 1–save.
save-bestshot-path	string	./bestshots	The directory for saving the best shots when the save-bestshot-ondisk/SaveBestshotonDisk variable is activated.
EncryptBestshot	REG_DWORD	0	Encryption of the bestshots when saving them. Not used in this version of the System. 0–do not encrypt; 1–encrypt.
ServerHost	REG_SZ	127.0.0.1	IP address of the server on which to run to accept websocket connection. When using one copy, specify localhost; when using several running copies, specify the main server.
ServerPort	REG_DWORD	4444	The port on which the RSE Server accepts connections
LogLevel	REG_DWORD	1	The logging level filters log messages and has the following levels from 0 to 3: 0–disable logging; 1–logging information about work; 2–logging warnings and information about work; 3–logging errors, warnings and operation information.
LogPath	REG_SZ	C:\RSE\logs	Path to a writable directory for storing server logs
Processor	REG_SZ	IntelRealSense	Camera System Mode: IntelRealSense–working with Intel RealSense camera; VLSLunaCamera3D–working with VLS LUNA CAMERA 3D; VLSLunaCamera2D–working with VLS LUNA CAMERA 2D.
Camera Monitoring	REG_DWORD	1	Parameter enables/disables monitoring camera status. 0–turns off monitoring; 1–turns on monitoring.
Camera MonitoringDelay	REG_DWORD	300	Parameter sets the request frequency for the camera status from the monitoring service.
RgbIrMatch	REG_DWORD	0	Using RGB and IR camera data to perform checks It is not recommended to change this parameter. 0– off; 1– on.
CheckEyes	REG_DWORD	1	Using information about eye position and status for checking Liveness. 0–off; 1–on.
CheckMouth	REG_DWORD	0	Using information about mouth status for checking Liveness. 0–off; 1–on.
`LivenessDepth	REG_DWORD	1	Using information about face volumetric on image when checking Liveness. It is not recommended to change this parameter. 0–off; 1–on.
`LivenessDepth FPR	REG_DWORD	1	FPR Liveness check. It is not recommended to change this parameter. 0–off; 1–on.
`LivenessDepth	REG_DWORD	0	The minimum threshold for the Liveness value when checking face in the volumetric image. Threshold is set between 0.0 and 1.0 (0...100 for Windows), where: 0–no check `0.1–high probability of missing a fake 1–low probability of missing a fake, high probability to miss a real person
`LivenessDepth FPRThreshold	REG_DWORD	70	Minimum threshold for Liveness value while face checking Parameter is chosen analytically by the developers and is not recommended to be changed. The threshold is set in the range from 0.0 to 1.0 (0...100 for Windows), where: 0–no check 0.1–a high probability of missing a fake 1–low probability of missing a fake, high probability to miss a real person
RGBCoordinates Transfer	REG_DWORD	1	Transferring the Bbox coordinates of a face from an RGB image to an IR image for further processing. 0–off; 1–on.
IOULiveness	REG_DWORD	50	The threshold for using IOU when building a Bbox. Parameter is chosen analytically by the developers and is not recommended to be changed. The threshold is set in the range of 0.0 to 1.0 (0...100 for Windows).
Quality Threshold	REG_DWORD	80	Minimum threshold for evaluating image quality before checking Liveness. Parameter is chosen analytically by the developers and is not recommended to change. The threshold is set between 0.0 and 1.0 (0...100 for Windows).
RgbIRMatch Threshold	REG_DWORD	120	Face comparison threshold from IR and RGB images. Parameter is chosen analytically by the developers and is not recommended to be changed. The threshold is set between 0.0 and 1.0 (0...100 for Windows).
`Margin	REG_DWORD	20	Minimum space between the face box and the frame boundaries in pixels. The face must be at least 10 pixels from the frame border when performing a Liveness check, so that face information is not lost. 10...100 pixels
Suspicious Threshold	REG_DWORD	60	Minimum image quality threshold at which the Liveness check will be performed Parameter is chosen analytically by the developers and is not is not recommended to be changed. The threshold is set in the range of 0.0 to 1.0 (0...100 for Windows).
LightThreshold	REG_DWORD	90	Minimum threshold for checking the quality of face illumination at image at which the Liveness check will be performed. Parameter is chosen analytically by the developers and is not recommended to change. The threshold is set in the range of 0.0 to 1.0 (0...100 for Windows).
DarkThreshold	REG_DWORD	93	Minimum threshold for checking the quality of darkness on the face. image at which the Liveness check will be performed. Parameter is chosen analytically by the developers and is not recommended to change. The threshold is set in the range of 0.0 to 1.0 (0...100 for Windows).
BlurThreshold	REG_DWORD	94	Minimum threshold for checking the quality of blurred face image at which the Liveness check will be performed. Parameter is chosen analytically by the developers and is not recommended to change. The threshold is set in the range of 0.0 to 1.0 (0...100 for Windows).
YawThreshold	REG_DWORD	15	Maximum head tilt angle relative to the camera axis,, at which the Liveness check will be performed. Parameter is chosen analytically by the developers and is not recommended to be changed.
PitchThreshold	REG_DWORD	15	Maximum head rotation angle relative to the camera axis, at which the Liveness check will be performed. Parameter is chosen analytically by the developers and is not recommended to be changed.
RollThreshold	REG_DWORD	10	Maximum head rotation angle relative to the camera axis, at which the Liveness check will be performed. Parameter is chosen analytically by the developers and is not recommended to be changed.
AutoexpRGB	REG_DWORD	1	Enable auto exposure mode for RGB images. It is not recommended to disable this setting. 0–off; 1–on.
AutoexpIR	REG_DWORD	1	Enable auto exposure mode for IR image. It is not recommended to disable this setting. 0–off; 1–on.
IRStream DarknessCheck	REG_DWORD	0	Check for lack of image illumination in IR image.
RoiEnable	REG_DWORD	1	Cropping the original frame to reduce the area of interest to improve the recognition quality. The preset parameters below limit the central part of the frame, where the face is least distorted. It is not recommended that this setting be turned off. 0–off; 1–on.
RoiX	REG_DWORD	160	Horizontal coordinate of the upper left corner of the area of interest. Specified from the upper left corner of the frame. It is not recommended to change this parameter.
RoiY	REG_DWORD	0	Vertical coordinate of the top left corner of the area of interest. Set from the upper left corner of the frame. It is not recommended to change this parameter.
RoiWidth	REG_DWORD	320	Width of the area of interest. It is not recommended to change this parameter.
RoiHeight	REG_DWORD	480	Height of the area of interest. It is not recommended to change this parameter.
LogFileRotation	REG_DWORD	0	Daily log rotation 0–disabled; 1–enabled.
Continuous Bestshots	`REG_DWORD	0	Continue to receive bestshots in session even if bestshot has already been received 0–off; 1–on.
FrameRotation	int	0	The rotation angle of the camera frame. Possible values: 0, 90, 180, 270. For the location of the camera depending on the rotation angle of the video frame, see the diagram below (Figure 5)
LivenessIr	int	1	IR Liveness check. 0–off; 1–is on

Location of the VLS LUNA CAMERA 2D camera depending on the rotation angle of the video frame