Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

FACE PSIM

Registry section

String parameterAvailable valuesDefaultProduct versionParameter in effect

x32: (x32)\FRS
x64: (x64)\FRS

CpuCoreCount>0
1.0.0 and later

The key defines on how many CPU cores the face recognition module will operate (firserver.run process). All cores are in use by default.

x32: (x32)\FRS
x64:
(x64)\FRS

CpuCoreCountSearch>=011.0.0 and later

The key determines how many CPU cores will be used for face search:

0—the number of cores specified in the CpuCoreCount key. The cores are used sequentially. Each core is assigned its own recognition instance.

1—only 1 fixed core is used

2—only 2 fixed cores are used

and so on

x32: (x32)\FRS
x64: (x64)\FRS
FaceLostAge>010001.0.0 and later

The key sets the timeout upon which Face Server ‘loses’ the face if there is no new data about it.

x32: (x32)\FRS
x64: (x64)\FRS
GenFirsInDetector0, 111.0.0 and later

Sets the parameters of generating and attaching face biometrics in the detection tool:

1 – Face detection tools generate and attach face biometrics to the photo. 

0 – Face detection tools do not generate face biometrics – the face is only captured.

Note. Face recognition Server that performs search in the user database checks up whether it has attached biometrics when it gets a face photo. If yes, then biometrics are not further generated for search in the database – data attached to the photo is in use. If no, then recognition Server generates biometrics itself using the photo. 

Generation of biometrics is a resource-intensive process unlike search by ready data – that is why this key allows distributing load among several Servers having only one Server working with the user database.
x32: (x32)\Video\FaceCapture
x64: (x64)\Video\ FaceCapture
timeUntilLost>011.0.0 and later

The key is used to configure the face detection tool – it sets time on the expiry of which the face is considered lost.

For instance, if timeUntilLost = 1 and a man covers his face with the hands in front of the camera and then shows it again, then the face detection tool does not capture it as it considers that the face was lost for the time it was covered.

If the parameter value is 3, then the face will be detected in this case.
x32: (x32)\FRS
x64: (x64)\FRS
IgnoreSamePeople0, 101.0.0 and later

The key enables function of ignoring repeatedly recognized faces. While enabling this function all vectors of captured faces are saved in cache for the specified time interval. When new face is captured, its biometric vector is comparing with already existed vectors in cache. If it coincides with one of such vectors with specified similarity rate then it doesn't send to the further processing. Duration of vector storing in a cache is specified using the Skip repeated recognitions, sec parameter of the Face Recognition Server object. Similarity rate for comparison is came from the Similarity level parameter of the same object. See also Face PSIM software package. Administrator's Guide, section Configuring the captured faces recognition parameters.

x32: (x32)\FRS
x64: (x64)\FRS
ClearIgnoreCache0, 101.0.0 and laterThe key enables cache clearing while using function of ignoring repeatedly recognized faces.
x32: (x32)\FRS
x64: (x64)\FRS
ClearIgnoreCacheTimeTime in HH:MM:SS formatNA1.0.0 and laterThe key sets time when cache clearing is to be performed while using function of ignoring repeatedly recognized faces.
x32: (x32)\FRS
x64: (x64)\FRS
FaceDetectionPeriod>02501.0.0 and laterSpecifies time period in milliseconds equal to frequency of new faces search on the image for the VA recognition algorithm. See also Face PSIM software package. Administrator's Guide.
x32: (x32)\FRS
x64: (x64)\FRS
FaceDBFull path to a local or network folderNA1.0.0 and laterThe key sets a folder for storage of images and vectors for captured and reference faces when UseFaceDB key is set to 1 or 2 (see below).
x32: (x32)\FRS
x64: (x64)\FRS
UseFaceDB0, 1, 221.0.0 and later

The key sets the storage mode for metadata, images and vectors of captured and reference faces.

0 – metadata, images and vectors are stored only in the database.

1 – metadata, images and vectors are stored in the database, and images and vectors are also stored in a folder on disk. The path to the folder is set by the FaceDB parameter (you can specify both local and network folders).

2 – metadata is stored in the database, and images and vectors are stored only in a folder on disk. The path to the folder is set by the FaceDB parameter (you can specify both local and network folders).

Note 1. Metadata is stored in the database in the Hits table, regardless of the value of the UseFaceDB key. 

Note 2. Images of reference faces are stored in the <Axxon PSIM software installation directory>\Bmp\Person folder, regardless of the UseFaceDB key value.

Note 3. Only the UseFaceDB = 2 mode is supported, which is set automatically when Face Axxon PSIM starts if a mode other than this is detected.

x32: (x32)\FRS
x64: (x64)\FRS
FaceDBFreeMB>010001.0.0 and later

The key is used if the the UseFaceDB parameter value is 1 or 2 (see above). The key sets the size of free disk space in megabytes. Once the specified size is reached, the old images, vectors and metadata of captured faces will be deleted. The cleanup is performed on a loop in portions equivalent to 1000 megabytes.

x32: (x32)\FRS
x64: (x64)\FRS
RestPortport number100001.0.0 and laterThe key is used in case the standard port 10000 used by the Face Recognition Server to communicate with the Face Recognition and Search client is occupied by a third-party application that can not be disabled. The key allows you to specify a new port number for communication between the server and the client.
x32: (x32)\FRS
x64: (x64)\FRS
CpuCoreCountAddPerson
>=001.0.0 and later

The key defines the number of CPU cores where the vectors of persons are generated when adding a reference face to the database.

0 – vectors are generated on the number of cores specified in the CpuCoreCount key. The cores are used successively. Recognition sample is bound to each core.

1 – only 1 fixed core (different from those specified in CpuCoreCount) is in use when adding a reference face to the database.

2 – only 2 fixed cores (different from those specified in CpuCoreCount) are in use when adding a reference face to the database.

etc.
x32: (x32)\FRS
x64: (x64)\FRS
Face.HardwareCPU
0, 1, 2NA1.0.0 and later

The key defines the order of binding streams to CPU cores when generating vectors of persons.

no value or 0 – streams are bound randomly to CPU cores.
1 – streams are bound successively to CPU cores depending on their total number.
2 – streams are bound to first cores of each CPU.

x32: (x32)\FRS
x64: (x64)\FRS
Face.RecognizeFacesSeparately0, 101.0.0 and later

Mechanism of displaying faces. When a new mechanism of displaying is enabled, the photo in the list of captured faces is not duplicated – it is updated in the same cell while the tracker "sees" it.  

0 – new mechanism of displaying faces. 

1 – old mechanism of displaying faces. 

x32: (x32)\FRS
x64: (x64)\FRS
FaceDetector.SaveLastFaceCaptureFrame0, 101.0.0 and later

The key enables saving the last recognized face and all its necessary data to a file. This image file can be sent directly to the recognition server via the iidk_client utility.

0 – General operation mode.

1 – When the face is captured, the captureFrame (cam_N) .log file is created (where N is the camera number that captured the face) in the <Axxon PSIM Installer directory>\Modules64\Firserver folder\. This file will contain the last recognized face and all its necessary data. This image file can be sent directly to the recognition server via the iidk_client utility.

Note. The file is overwritten every time a new face is captured.

x32: (x32)\FRS
x64: (x64)\FRS
XSize>=019201.0.0 and later

The key restricts resolution (width) of the photo when adding it to the faces database.

Set greater value to the key if the following message appears when adding a face to DB: "Adding error. The face was not added. Insufficient image quality to add".

x32: (x32)\FRS
x64: (x64)\FRS
YSize>=010801.0.0 and later

The key restricts resolution (height) of the photo when adding it to the faces database.

Set greater value to the key if the following message appears when adding a face to DB: "Adding error. The face was not added. Insufficient image quality to add".
VA and VideoIntellect 1.1




x32: (x32)\FRS
x64: (x64)\FRS
VaAlgorithmNumber0, 101.0.0 and later

The key enables selecting the face recognition and search algorithm.

0 – less resource intensive algorithm is in use

1 – more resource intensive algorithm is in use 

Important! Biometric vectors received using this algorithm cannot be used with alternative one. For proper operation of Face PSIM after changing this parameter biometric vectors are to be converted as described in Switching between the face recognition modules section. 

x32:(x32)\FRS\CustomAlgoritm
x64:(x64)\FRS\CustomAlgoritm
Va.DetectionFilterAlgorithm0, 101.0.0 and later

An alternative algorithm for filtering false triggerings of the tracker. This key is in use if Va.GlobalTrackingDetectionFilter=0 and Va.DetectionFilterValue > 0 (see the corresponding parameters below). 

0 – ALG1

1 – ALG2

Note. It is not recommended to change this parameter without consulting with AxxonSoft technical support.

x32:(x32)\FRS\CustomAlgoritm
x64:(x64)\FRS\CustomAlgoritm
Va.DetectionFilterValue0-100501.0.0 and later

Configuring alternative algorithm filtering. It is in use if the value of Va.GlobalTrackingDetectionFilter is more than 0 (see the corresponding parameter below).

Note. It is not recommended to change this parameter without consulting with AxxonSoft technical support.

x32:(x32)\FRS\CustomAlgoritm
x64:(x64)\FRS\CustomAlgoritm
Va.GlobalTrackingDetectionFilter0, 111.0.0 and later

Activates an additional check to filter out false triggerings of the tracker. If faces in masks are not recognized, it is recommended to disable this check, however, this can cause false triggerings of the tracker.

0 – disabled

1 – enabled

Note. It is not recommended to change this parameter without first consulting with AxxonSoft technical support.

x32:(x32)\FRS\CustomAlgoritm
x64:(x64)\FRS\CustomAlgoritm
Va.DetectorAlgorithm0, 101.0.0 and later

Face detection operation mode (identification). The recommended parameter value is 0.

0 – ALG1

1 – ALG2

Note. It is not recommended to change this parameter without consulting with AxxonSoft technical support.

x32:(x32)\FRS\CustomAlgoritm
x64:(x64)\FRS\CustomAlgoritm
Va.FaceDetectionPeriod>=03501.0.0 and later

This parameter affects the detector captioning capacity. If there is a great value, the tracks can rend.

Note. It is not recommended to change this parameter without consulting with AxxonSoft technical support.

x32:(x32)\FRS\CustomAlgoritm
x64:(x64)\FRS\CustomAlgoritm
Va.FaceDetectorConfidenceThreshold>=0501.0.0 and later

Face detector confidence threshold (do not confuse with face quality).

Note. It is not recommended to change this parameter without consulting with AxxonSoft technical support.

x32:(x32)\FRS\CustomAlgoritm
x64:(x64)\FRS\CustomAlgoritm
Va.IdentificationAlgorithm0, 1, 201.0.0 and later

The key enables selecting the algorithm for recognition and face search.

0 – ALG1 less resource-intensive algorithm is in use.

1 – ALG2 identification of the higher quality, but more resource-intensive.

2 – PRECISE the highest quality of recognition, but the most resource-intensive. This algorithm is recommended if significantly less time is spent on face recognition than on detection (if there are few people in the frame).

Important! Since the biometric vectors received by one algorithm cannot be used by another, then after changing the algorithm, the biometric vectors are automatically recreated. The biometric vectors can also be recreated manually (see Switching between the face recognition modules or SDK versions).

x32:(x32)\FRS\CustomAlgoritm
x64:(x64)\FRS\CustomAlgoritm
Va.TrackBestFramesCount>=011.0.0 and later

Specifies the number of seconds to accumulate the best frames of a track for recognition. The increase in time makes it possible to average out the recognized face characteristics, but it can result in the poorer accuracy of the face characteristics recognition.

Note. For example, if the 1 second value is set, the average error in determining the age will be 2-3 years, and if the 5 seconds value is set, it will be 3-4 years.

x32:(x32)\FRS\CustomAlgoritm
x64:(x64)\FRS\CustomAlgoritm
Va.TrackerMaxLostTime>=05001.0.0 and later

Time since the last recognition after which the track is considered ended.

Note. It is not recommended to change this parameter without consulting with AxxonSoft technical support.

x32: (x32)\FRS\CustomAlgoritm
x64: (x64)\FRS\CustomAlgoritm
Va.EyesClosedDetectorThreshold>=0501.0.0 and later

Sets the sensitivity of the closed eyes recognition. The higher the value, the less sensitive the closed eyes detector.

x32: (x32)\FRS\CustomAlgoritm
x64: (x64)\FRS\CustomAlgoritm
Va.IgnoreBestFrames0,1081.20.0 .550 and later

Specifies which frames will be recognized.

0 − only 0—only the best frame defined by VA by VA will be recognized.

1 − all 1—all frames will be recognized, as a result the quality of recognition increases, but the CPU load increases, too

х32: (х32)\FRS\CustomAlgoritm
x64:
(х64)\FRS\CustomAlgoritm
Va.LivenessDetectionAlgorithm0, 1, 221.0.0 and later

The key defines the operating mode for the frame-based artificial face detection algorithm:

0—the algorithm is disabled

1—standard operation mode of the algorithm

2—slower but more accurate operation mode of the algorithm

This key can be used together with the Va.LivenessTextureDetectionAlgorithm key for better results

х32: (х32)\FRS\CustomAlgoritm
x64:
(х64)\FRS\CustomAlgoritm
Va.LivenessTextureDetectionAlgorithm0, 1, 2, 301.0.0 and later

The key defines the operating mode for the texture-based artificial face detection algorithm. The following conditions are required for proper operation: high-quality video image, a large face size, and a region of interest (ROI) focused on the center of the frame.

0—the algorithm is disabled

1—standard operation mode of the algorithm

2—slower but more accurate operation mode of the algorithm

3—enables combined operation with the frame-based artificial face detection algorithm (the registry key Va.LivenessDetectionAlgorithm value must be set to 1 or 2)

x32: (x32)\FRS
x64: (x64)\FRS
GenerateEyesClosedEvent0, 101.0.0 and later

Activates the Eyes closed event generation when closed eyes are detected.

x32: (x32)\FRS
x64: (x64)\FRS
FaceTracker.LogTrackerQuality0, 101.0.0 and laterThe key enables logging of every face capture event in the general log file of the Face Recognition Server debugging window, where additional information is displayed, such as: the quality of the captured face, the number of all captured faces, the number of high-quality faces, etc. (for details, see Debug window).
x32: (x32)\FRS
x64: (x64)\FRS
IsProcessObject
0, 111.0.0 and later

Enables the launch of each Face Recognition Server in a separate process.

0 – all Face Recognition Servers launch in the same process.

1 – each Face Recognition Server is launched in a separate process.

x32: (x32)\FRS
x64: (x64)\FRS
ThreadAffinity.Ignore0, 101.0.0 and later

Enables ignoring threads affinity to kernels inside firserver.run.

0 – ignoring threads affinity to kernels is disabled.

1 – ignoring threads affinity to kernels is enabled. The key is used in conjunction with the IsProcessObject=0 key.

x32: (x32)\FRS
x64: (x64)\FRS
ResizeWidth
>=001.0.0 and later

Sets the video resolution that is sent from cameras to all Face Detection modules.

Actually, the width of the video image is set, and the height is adjusted automatically based on the aspect ratio of the original video. For example, if the original video has a resolution of 2560x1920, then if you set the value to 960, then the video will be converted to a resolution of 960x720.

If the value is set to 0, then the video image will be received in its original resolution.

x32: (x32)\FRS
x64:
(x64)\FRS
NeedUpdatePerson0, 111.0.0 and later

Enables compliance check of Face PSIM users with Axxon PSIM users:

0—compliance check is disabled, user changes are not checked

1—compliance check is enabled. All user changes made in the Axxon PSIM database, but missing in the Face PSIM database, are transferred there. User parameters that are present in the Face PSIM database, but missing in the Axxon PSIM database, are deleted

x32: (x32)\FRS\Thermal
x64: (x64)\FRS\Thermal
SaveThermalJson
0, 101.0.0 and later

Enables saving all json and images received from the thermal camera during face recognition to the folder. The data from the camera will be saved at the following address:

  • In case of face recognition: <Axxon PSIM installation directory>\Modules64\Firserver\ThermalImages\{Face detection tool ID}
  • In case the face is not recognized: <Axxon PSIM installation directory>\Modules64\Firserver\ThermalImages\{Face detection tool ID}\NoFaces

0 – data from the thermal camera is not saved to the folders

1 – data from the thermal camera is saved to the folders

x32: (x32)\FRS\Thermal
x64: (x64)\FRS\Thermal
ForceProcessWholeImage
0, 101.0.0 and later

The key is used in case the Combined work with thermal camera and Get photo from thermal camera checkboxes are set on the settings panel of the Face Recognition Server object.

Enables the face search throughout the entire frame if a face was not previously recognized due to incorrect coordinates of the face frame received from the thermal camera.

Details on this mode:

  • The number of recognitions and the system load will increase.
  • The negative face images will be displayed in the Face recognition and search interface module.
  • The same temperature will be indicated for all recognized faces in the frame.

0 – Unrecognized faces are ignored.

1 – Enables the face search throughout the entire frame if a face was not previously recognized.

x32: (x32)\FRS\Update
x64: (x64)\FRS\Update
Update.CpuCoreCount
>=111.0.0 and later

Sets the number of threads on which the biometric vectors are re-generated when switching between different face recognition modules or SDK versions.

...