anki_vector.faces

Face recognition and enrollment.

Vector is capable of recognizing human faces, tracking their position and rotation (“pose”) and assigning names to them via an enrollment process.

The anki_vector.world.World object keeps track of faces the robot currently knows about, along with those that are currently visible to the camera.

Each face is assigned a Face object, which generates a number of observable events whenever the face is observed or when the face id is updated.

Faces can generate events which can be subscribed to from the anki_vector.events class, such as face_appeared (of type EvtFaceAppeared), and face_disappeared (of type EvtFaceDisappeared), which are broadcast based on both robot originating events and local state.

Module Attributes

FACE_VISIBILITY_TIMEOUT

Length of time in seconds to go without receiving an observed event before assuming that Vector can no longer see a face.

Classes

EvtFaceAppeared(face, image_rect, name, pose)

Triggered whenever a face is first visually identified by a robot.

EvtFaceDisappeared(face)

Triggered whenever a face that was previously being observed is no longer visible.

EvtFaceObserved(face, image_rect, name, pose)

Triggered whenever a face is visually identified by the robot.

Expression(value[, names, module, qualname, ...])

Facial expressions that Vector can distinguish.

Face(robot, pose, image_rect, face_id, name, ...)

A single face that Vector has detected.

FaceComponent(robot)

Manage the state of the faces on the robot.