Adapter - NeoFace Eva Event
This page describes version 2.0.9 of the adapter.
Overview
This adapter is used to receive events from a NeoFace Eva system.
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| address | Server Address | True | The address (DNS or IP) to connect to for alerts. | string | 1024 | 1 | |||
| port | Server Port | True | The port to connect to for alerts. | integer | 21121 | 65535 | 1 | ||
| serverKey | Server Key | False | The ZeroMQ public key for the alertPublishAddress. | string | 1024 | 1 | |||
| sendFaceMatch | Send face match events | False | boolean | false | |||||
| eventTimeoutFaceMatch | Timeout between face match events | False | The number of seconds between sending events for a specific track id (0 = disabled). | integer | 0 | 300 | 0 | ||
| sendFaceMatchImages | Send images with the face match event | False | boolean | false | |||||
| sendVibration | Send vibration events | False | boolean | false | |||||
| sendVibrationStartEnd | Send vibration start and end events | False | boolean | false | |||||
| sendGenderAge | Send genderAge events | False | boolean | false | |||||
| eventTimeoutGenderAge | Timeout between genderAge events | False | The number of seconds between sending events for a specific track id (0 = disabled). | integer | 0 | 300 | 0 | ||
| skipCountGenderAge | Skip count for genderAge events | False | The number of events to skip before sending (0 = disabled). | integer | 0 | 25 | 0 | ||
| sendGenderAgeImages | Send images with the genderAge event. | False | boolean | false |
Events
Face Match (facematch)
A person in a watchlist has been matched
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| timestamp | Timestamp | The time the alert was published to ZeroMQ. | string |
| instanceId | Instance Id | The instance Id of the program that this event originated from. | string |
| sensorId | Sensor Id | The Id of the sensor (or camera) that captured the face match. | string |
| sensorName | Sensor Name | The name of the sensor (or camera) that captured the face match. | string |
| latitude | Latitude | The latitude value assigned when the sensor was created. | string |
| longitude | Longitude | The longitude value assigned when the sensor was created. | string |
| frameTimestamp | Frame Timestamp | The timestamp of the frame capture. | string |
| faceDetectionTimestamp | Face Detection Timestamp | The timestamp of the face detection. | string |
| faceMatchingTimestamp | Face Matching Timestamp | The timestamp of the face matching. | string |
| person | Person | The name of the person that was detected. | string |
| personId | Person Id | The person id of the person that was detected. | string |
| pictureId | Picture Id | The picture id of the image that was used to compare the matched person. | string |
| faceId | Face Id | The id of the face. | string |
| trackId | Track Id | The id of the track. | string |
| comments | Comments | The comments associated with this face match. | string |
| watchlistId | Watchlist Id | The watchlist Id of the watchlist that the person was matched against. | string |
| watchlistName | Watchlist Name | The watchlist name of the watchlist that the person was matched against. | string |
| score | Score | The score of the match, between 0 and 1. | string |
| quality | Quality | The quality of the match, between 0 and 1. | string |
| frontalScore | Frontal Score | The frontal score. | string |
| pan | Pan | The camera pan. | string |
| roll | Roll | The camera roll. | string |
| tilt | Tilt | The camera tilt. | string |
| reliability | Reliability | The reliability. | string |
| faceAreaX | Face Area X | The x coordinate of the face in the image. | string |
| faceAreaY | Face Area Y | The y coordinate of the face in the image. | string |
| faceAreaWidth | Face Area Width | The width of the face in the image. | string |
| faceAreaHeight | Face Area Height | The height of the face in the image. | string |
| headAreaX | Head Area X | The x coordinate of the head in the image. | string |
| headAreaY | Head Area Y | The y coordinate of the head in the image. | string |
| headAreaWidth | Head Area Width | The width of the head in the image. | string |
| headAreaHeight | Head Area Height | The height of the head in the image. | string |
| leftEyeX | Left Eye X | The x coordinate of the left eye in the image. | string |
| leftEyeY | Left Eye Y | The y coordinate of the left eye in the image. | string |
| rightEyeX | Right Eye X | The x coordinate of the right eye in the image. | string |
| rightEyeY | Right Eye Y | The y coordinate of the right eye in the image. | string |
| detectedImage | Detected image data | The base64 encoded string of the detected image. | string |
| enrolledImage | Enrolled image data | The base64 encoded string of the enrolled image. | string |
| contextImage | Context image data | The base64 encoded string of the context image. | string |
Gender Age (genderAge)
The gender and age for person
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| timestamp | Timestamp | The time the alert was published. | string |
| instanceId | Instance Id | The instance Id of the program that this event originated from. | string |
| sensorId | Sensor Id | The id of the sensor (or camera) that captured the face match. | string |
| sensorName | Sensor Name | The name of the sensor (or camera) that captured the face match. | string |
| latitude | Latitude | The latitude value assigned when the sensor was created. | string |
| longitude | Longitude | The longitude value assigned when the sensor was created. | string |
| frameId | Frame Id | The id of the frame. | string |
| trackId | Track Id | The id of the track. | string |
| faceId | Face Id | The id of the face. | string |
| frameTimestamp | Frame Timestamp | The timestamp of the frame capture. | string |
| faceDetectionTimestamp | Face Detection Timestamp | The timestamp of the face detection. | string |
| gender | Gender | The detected gender. | string |
| genderConfidence | Gender Confidence | The confidence of the gender detection. | string |
| ageMode | Age Mode | The mode of the collected ages (when using timeout and skip for events). | string |
| age | Age | The detected age. | string |
| ageConfidence | Age Confidence | The confidence of the age detection. | string |
| age2 | Age2 | The detected age2. | string |
| age2Confidence | Age2 Confidence | The confidence of the age2 detection. | string |
| age3 | Age3 | The detected age3. | string |
| age3Confidence | Age3 Confidence | The confidence of the age3 detection. | string |
| averageAge | Average Age | The average of the detected ages. | string |
| quality | Quality | The quality of the match, between 0 and 1. | string |
| frontalScore | Frontal Score | The frontal score. | string |
| pan | Pan | The camera pan. | string |
| roll | Roll | The camera roll. | string |
| tilt | Tilt | The camera tilt. | string |
| reliability | Reliability | The reliability. | string |
| faceAreaX | Face Area X | The x coordinate of the face in the image. | string |
| faceAreaY | Face Area Y | The y coordinate of the face in the image. | string |
| faceAreaWidth | Face Area Width | The width of the face in the image. | string |
| faceAreaHeight | Face Area Height | The height of the face in the image. | string |
| headAreaX | Head Area X | The x coordinate of the head in the image. | string |
| headAreaY | Head Area Y | The y coordinate of the head in the image. | string |
| headAreaWidth | Head Area Width | The width of the head in the image. | string |
| headAreaHeight | Head Area Height | The height of the head in the image. | string |
| leftEyeX | Left Eye X | The x coordinate of the left eye in the image. | string |
| leftEyeY | Left Eye Y | The y coordinate of the left eye in the image. | string |
| rightEyeX | Right Eye X | The x coordinate of the right eye in the image. | string |
| rightEyeY | Right Eye Y | The y coordinate of the right eye in the image. | string |
| pictureJpg | The image data | The base64 encoded string of the image. | string |
Vibration Start (vibrationStart)
Vibration start notification
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| timestamp | Timestamp | The time the alert was published. | string |
| alertId | Alert Id | The id of the alert. | string |
| instanceId | Instance Id | The instance Id of the program that this event originated from. | string |
| sensorId | Sensor Id | The id of the sensor (or camera) that captured the face match. | string |
| sensorName | Sensor Name | The name of the sensor (or camera) that captured the face match. | string |
| latitude | Latitude | The latitude value assigned when the sensor was created. | string |
| longitude | Longitude | The longitude value assigned when the sensor was created. | string |
| dasSensorName | DAS Sensor Name | The name of the sensor. | string |
| dasSensorId | DAS Sensor Id | The id of the sensor. | string |
| eventType | Event Type | The type of event (vibrated). | string |
| alarmId | Alarm Id | The alarm id. | string |
Vibration End (vibrationEnd)
Vibration end notification
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| timestamp | Timestamp | The time the alert was published. | string |
| alertId | Alert Id | The id of the alert. | string |
| instanceId | Instance Id | The instance Id of the program that this event originated from. | string |
| sensorId | Sensor Id | The id of the sensor (or camera) that captured the face match. | string |
| sensorName | Sensor Name | The name of the sensor (or camera) that captured the face match. | string |
| latitude | Latitude | The latitude value assigned when the sensor was created. | string |
| longitude | Longitude | The longitude value assigned when the sensor was created. | string |
| dasSensorName | DAS Sensor Name | The name of the sensor. | string |
| dasSensorId | DAS Sensor Id | The id of the sensor. | string |
| eventType | Event Type | The type of event (vibrated). | string |
| alarmId | Alarm Id | The alarm id. | string |
Vibration (vibration)
Vibration notification
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| timestamp | Timestamp | The time the alert was published. | string |
| alertId | Alert Id | The id of the alert. | string |
| instanceId | Instance Id | The instance Id of the program that this event originated from. | string |
| sensorId | Sensor Id | The id of the sensor (or camera) that captured the face match. | string |
| sensorName | Sensor Name | The name of the sensor (or camera) that captured the face match. | string |
| latitude | Latitude | The latitude value assigned when the sensor was created. | string |
| longitude | Longitude | The longitude value assigned when the sensor was created. | string |
| dasSensorName | DAS Sensor Name | The name of the sensor. | string |
| dasSensorId | DAS Sensor Id | The id of the sensor. | string |
| eventType | Event Type | The type of event (vibrated). | string |
| alarmId | Alarm Id | The alarm id. | string |
| eventId | Event Id | The event id. | string |
| eventReliability | Event Reliability | The event reliability. | string |
| startTimestamp | Start Timestamp | The timestamp when it started. | string |
| positionInFiber | Position in Fiber | The position in the fiber where it occurred. | string |
| mapX | Map X | Map X coordinate. | string |
| mapY | Map Y | Map Y coordinate. | string |
| realLatitude | Real Latitude | The latitude of the event. | string |
| realLongitude | Real Longitude | The longitudee of the event. | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | ||
| 2.0.8 | Feature | Added Vibration event support | NAP-22420 | |
| 2.0.9 | Feature | Add support for vibration start/end events | NAP-25005 | 2023-05-17 |