Documentation for Face PSIM 1.0.1.

Previous page FIRSERVER requests  Examples of frequently used scripts Next page

Events received from the FIRSERVER object can be used in Axxon PSIM scripts to run the procedures when the corresponding event occurs (see Guide for creating scripts (programming)).

The description of the events from the FIRSERVER object:
EventDescription
PERSON_NOT_FOUNDThe face was captured but not recognized (cannot be found in the Face PSIM database)
FIND_PERSONThe face is recognized
ADD_PERSON_FROM_FILE_OKThe reference face file is added to the Face PSIM database
ADD_PERSON_FROM_FILE_ERRORThere is an error when adding the reference face file to the Face PSIM database
IDENTIFY_ACCEPTThe verification is accepted
IDENTIFY_DECLINEThe verification is declined
RECOGNITION_PASSThe face is recognized if the Access event generation checkbox is set (see Configuring event generation)
TEMPERATURE_ALARM

Temperature rise (when the temperature threshold specified for the thermal camera is exceeded, see Configuring operation of the Face recognition server with thermal camera)

FACE_TEMPERATURE_SYNC_PROBLEMThe Server time and thermal camera time differ by more than 10 minutes
MASK_DETECTEDThe mask is found on the face (see Configuring event generation)
MASK_NOT_DETECTEDThere is no mask on the face (see Configuring event generation)
MASK_NOT_IN_PLACEThe mask is placed incorrectly
DATABASE_ERRORDatabase error (lost connection with the Fir database)
REGENERATE_STARTBiometric vectors re-generation in progress
REGENERATE_STOPBiometric vectors re-generation complete
REGENERATE_CANCELBiometric vectors re-generation cancelled

The parameters of the events of the FIRSERVER object:

ParametersDescription
requestId<>The ID of the request
fraction<>The millisecond when the face was captured
owner<>The server name. It is used for the PERSON_NOT_FOUND event
protocol_id<>The captured face ID (the link to the image)
date<>

The date of the recognition completion

face_id<>The unique ID of the face in Axxon PSIM
imageBase64.N<>

Image of the face captured by the camera in Base64 format for comparison with a saved photo of a user in the reference face databasewhere N is the image number (imageBase64.1<>, imageBase64.2<>, and so on). It is used for the IDENTIFY_ACCEPT and IDENTIFY_DECLINE events

imageBase64Count<>

Number of images of the faces captured by the camera in Base64 format for comparison with a saved photo of a user in the reference face database. It is used for the IDENTIFY_ACCEPT and IDENTIFY_DECLINE events

guid_pk<>The event ID (generated randomly for every event)
confidence<>

The quality percentage of the added face image, it has the double type and the 0.0-1.0 range of values

capture_fraction<>The millisecond when the face was added to the Face PSIM database
capture_date<>

The date of the image capture

sim<>The similarity percentage
surname<>

The last name of a person who looks similar to the recognized face

comment<>

The comment on adding a user (a face)

capture_time<>

The time of the image capture

cam_name<>The name of the camera that captured the face
patronymic<>The middle name of the person
filename<>

The full name of the image file

department<>

The department a user (a face) is added to

name<>

The name of the added user (face)

obj_id<>The face ID. The value is empty if there is no face match
error<>

Description of error cause

gender<>The gender of the recognized or unrecognized face (unknown, male, female)
age<>The age of the recognized or unrecognized face
param0<>

The following can be specified:

  • similarity percentage during the verification;
  • temperature in the TEMPERATURE_ALARM event;
  • Timeout if the IDENTIFY_DECLINE event occurred due to the expiration of the temperature timeout from the thermal camera
total_passes<>The general number of passes of the currently recognized face
firstId<>The unique identifier of the captured face
camera_id<>The identifier of the camera that captured a face
camera_name<>The name of the camera that captured a face
person_id<>The user ID in the Axxon PSIM objects tree, if the recognized face was created with the Create user in Axxon PSIM database checkbox set. It is used for the FIND_PERSON event
person_guid<>The recognized face ID that is assigned to the user when a face is added to the reference face database. It is used for the FIND_PERSON event
eye_closeness<>

The result of the closed eyes recognition by the detection tool when using the Recognition module VA:

  • unknownnot recognized (if a recognition module other than Recognition module VA is used);
  • eye_closedeyes are closed;
  • eye_not_closedeyes are not closed
temperature<>

Face temperature in degrees Celsius from the thermal camera

temperature_alarm<>

Temperature threshold from the thermal camera. When this value is exceeded, the TEMPERATURE_ALARM event is generated

info<>Contains the following information separated by a semicolon (;): the names and identifiers of the cameras that has ever captured the faces, and the number of passes

emotion<>

Emotion

glasses<>

Glasses

headwear<>

Headwear

evasion<>

Concealment of the face

facialHair<>

Facial hair

frame_type<>

Used for internal development

hairColor<>

Hair color

hairType<>

Type of bald head

liveness<>

Fake face

timeout<>
The waiting time in seconds for the temperature from the thermal camera if the IDENTIFY_DECLINE event occurred due to a timeout
noImage<>

The user doesn't have a saved photo in the Access Manager:

1—there is no photo;

0—there is a photo

quality<>The quality of the saved user photo in the Access Manager as a percentage. If quality<0>, the user doesn't have a photo in the Access Manager
  • No labels