Fawkes API  Fawkes Development Version
fawkes::FacerInterface Class Reference

FacerInterface Fawkes BlackBoard Interface. More...

#include <>>

Inheritance diagram for fawkes::FacerInterface:

Classes

class  EnableIdentityMessage
 EnableIdentityMessage Fawkes BlackBoard Interface Message. More...
 
class  GetNameMessage
 GetNameMessage Fawkes BlackBoard Interface Message. More...
 
class  LearnFaceMessage
 LearnFaceMessage Fawkes BlackBoard Interface Message. More...
 
class  SetNameMessage
 SetNameMessage Fawkes BlackBoard Interface Message. More...
 
class  SetOpmodeMessage
 SetOpmodeMessage Fawkes BlackBoard Interface Message. More...
 
class  StartSearchPersonMessage
 StartSearchPersonMessage Fawkes BlackBoard Interface Message. More...
 
class  StopSearchPersonMessage
 StopSearchPersonMessage Fawkes BlackBoard Interface Message. More...
 

Public Types

enum  if_facer_opmode_t {
  OPMODE_DISABLED, OPMODE_DETECTION, OPMODE_RECOGNITION, OPMODE_LEARNING,
  OPMODE_GENDER
}
 This determines the current status of skill execution. More...
 

Public Member Functions

const char * tostring_if_facer_opmode_t (if_facer_opmode_t value) const
 Convert if_facer_opmode_t constant to string. More...
 
virtual bool message_valid (const Message *message) const
 Check if message is valid and can be enqueued. More...
 
if_facer_opmode_t opmode () const
 Get opmode value. More...
 
void set_opmode (const if_facer_opmode_t new_opmode)
 Set opmode value. More...
 
size_t maxlenof_opmode () const
 Get maximum length of opmode value. More...
 
uint32_t num_identities () const
 Get num_identities value. More...
 
void set_num_identities (const uint32_t new_num_identities)
 Set num_identities value. More...
 
size_t maxlenof_num_identities () const
 Get maximum length of num_identities value. More...
 
uint32_t recognized_identity () const
 Get recognized_identity value. More...
 
void set_recognized_identity (const uint32_t new_recognized_identity)
 Set recognized_identity value. More...
 
size_t maxlenof_recognized_identity () const
 Get maximum length of recognized_identity value. More...
 
char * recognized_name () const
 Get recognized_name value. More...
 
void set_recognized_name (const char *new_recognized_name)
 Set recognized_name value. More...
 
size_t maxlenof_recognized_name () const
 Get maximum length of recognized_name value. More...
 
uint32_t num_detections () const
 Get num_detections value. More...
 
void set_num_detections (const uint32_t new_num_detections)
 Set num_detections value. More...
 
size_t maxlenof_num_detections () const
 Get maximum length of num_detections value. More...
 
uint32_t num_recognitions () const
 Get num_recognitions value. More...
 
void set_num_recognitions (const uint32_t new_num_recognitions)
 Set num_recognitions value. More...
 
size_t maxlenof_num_recognitions () const
 Get maximum length of num_recognitions value. More...
 
uint32_t most_likely_identity () const
 Get most_likely_identity value. More...
 
void set_most_likely_identity (const uint32_t new_most_likely_identity)
 Set most_likely_identity value. More...
 
size_t maxlenof_most_likely_identity () const
 Get maximum length of most_likely_identity value. More...
 
char * most_likely_gender () const
 Get most_likely_gender value. More...
 
void set_most_likely_gender (const char *new_most_likely_gender)
 Set most_likely_gender value. More...
 
size_t maxlenof_most_likely_gender () const
 Get maximum length of most_likely_gender value. More...
 
float history_ratio () const
 Get history_ratio value. More...
 
void set_history_ratio (const float new_history_ratio)
 Set history_ratio value. More...
 
size_t maxlenof_history_ratio () const
 Get maximum length of history_ratio value. More...
 
float sec_since_detection () const
 Get sec_since_detection value. More...
 
void set_sec_since_detection (const float new_sec_since_detection)
 Set sec_since_detection value. More...
 
size_t maxlenof_sec_since_detection () const
 Get maximum length of sec_since_detection value. More...
 
int32_t visibility_history () const
 Get visibility_history value. More...
 
void set_visibility_history (const int32_t new_visibility_history)
 Set visibility_history value. More...
 
size_t maxlenof_visibility_history () const
 Get maximum length of visibility_history value. More...
 
bool is_learning_in_progress () const
 Get learning_in_progress value. More...
 
void set_learning_in_progress (const bool new_learning_in_progress)
 Set learning_in_progress value. More...
 
size_t maxlenof_learning_in_progress () const
 Get maximum length of learning_in_progress value. More...
 
bool is_searching_person () const
 Get searching_person value. More...
 
void set_searching_person (const bool new_searching_person)
 Set searching_person value. More...
 
size_t maxlenof_searching_person () const
 Get maximum length of searching_person value. More...
 
float recording_progress () const
 Get recording_progress value. More...
 
void set_recording_progress (const float new_recording_progress)
 Set recording_progress value. More...
 
size_t maxlenof_recording_progress () const
 Get maximum length of recording_progress value. More...
 
float bearing () const
 Get bearing value. More...
 
void set_bearing (const float new_bearing)
 Set bearing value. More...
 
size_t maxlenof_bearing () const
 Get maximum length of bearing value. More...
 
float slope () const
 Get slope value. More...
 
void set_slope (const float new_slope)
 Set slope value. More...
 
size_t maxlenof_slope () const
 Get maximum length of slope value. More...
 
uint32_t requested_index () const
 Get requested_index value. More...
 
void set_requested_index (const uint32_t new_requested_index)
 Set requested_index value. More...
 
size_t maxlenof_requested_index () const
 Get maximum length of requested_index value. More...
 
char * requested_name () const
 Get requested_name value. More...
 
void set_requested_name (const char *new_requested_name)
 Set requested_name value. More...
 
size_t maxlenof_requested_name () const
 Get maximum length of requested_name value. More...
 
uint32_t index_last_learned () const
 Get index_last_learned value. More...
 
void set_index_last_learned (const uint32_t new_index_last_learned)
 Set index_last_learned value. More...
 
size_t maxlenof_index_last_learned () const
 Get maximum length of index_last_learned value. More...
 
virtual Messagecreate_message (const char *type) const
 Create message based on type name. More...
 
virtual void copy_values (const Interface *other)
 Copy values from other interface. More...
 
virtual const char * enum_tostring (const char *enumtype, int val) const
 Convert arbitrary enum value to string. More...
 
- Public Member Functions inherited from fawkes::Interface
virtual ~Interface ()
 Destructor. More...
 
bool oftype (const char *interface_type) const
 Check if interface is of given type. More...
 
const void * datachunk () const
 Get data chunk. More...
 
unsigned int datasize () const
 Get data size. More...
 
const char * type () const
 Get type of interface. More...
 
const char * id () const
 Get identifier of interface. More...
 
const char * uid () const
 Get unique identifier of interface. More...
 
unsigned short serial () const
 Get instance serial of interface. More...
 
unsigned int mem_serial () const
 Get memory serial of interface. More...
 
bool operator== (Interface &comp) const
 Check equality of two interfaces. More...
 
const unsigned char * hash () const
 Get interface hash. More...
 
size_t hash_size () const
 Get size of interface hash. More...
 
const char * hash_printable () const
 Get printable interface hash. More...
 
bool is_writer () const
 Check if this is a writing instance. More...
 
void set_validity (bool valid)
 Mark this interface invalid. More...
 
bool is_valid () const
 Check validity of interface. More...
 
const char * owner () const
 Get owner of interface. More...
 
void set_from_chunk (void *chunk)
 Set from a raw data chunk. More...
 
void resize_buffers (unsigned int num_buffers)
 Resize buffer array. More...
 
unsigned int num_buffers () const
 Get number of buffers. More...
 
void copy_shared_to_buffer (unsigned int buffer)
 Copy data from private memory to buffer. More...
 
void copy_private_to_buffer (unsigned int buffer)
 Copy data from private memory to buffer. More...
 
void read_from_buffer (unsigned int buffer)
 Copy data from buffer to private memory. More...
 
int compare_buffers (unsigned int buffer)
 Compare buffer to private memory. More...
 
Time buffer_timestamp (unsigned int buffer)
 Get time of a buffer. More...
 
void buffer_timestamp (unsigned int buffer, Time *timestamp)
 Get time of a buffer. More...
 
void read ()
 Read from BlackBoard into local copy. More...
 
void write ()
 Write from local copy into BlackBoard memory. More...
 
bool has_writer () const
 Check if there is a writer for the interface. More...
 
unsigned int num_readers () const
 Get the number of readers. More...
 
std::string writer () const
 Get owner name of writing interface instance. More...
 
std::list< std::string > readers () const
 Get owner names of reading interface instances. More...
 
bool changed () const
 Check if data has been changed. More...
 
const Timetimestamp () const
 Get timestamp of last write. More...
 
void set_auto_timestamping (bool enabled)
 Enable or disable automated timestamping. More...
 
void set_timestamp (const Time *t=NULL)
 Set timestamp. More...
 
void set_clock (Clock *clock)
 Set clock to use for timestamping. More...
 
void mark_data_changed ()
 Mark data as changed. More...
 
std::list< const char * > get_message_types ()
 Obtain a list of textual representations of the message types available for this interface. More...
 
unsigned int msgq_enqueue (Message *message)
 Enqueue message at end of queue. More...
 
unsigned int msgq_enqueue_copy (Message *message)
 Enqueue copy of message at end of queue. More...
 
void msgq_remove (Message *message)
 Remove message from queue. More...
 
void msgq_remove (unsigned int message_id)
 Remove message from queue. More...
 
unsigned int msgq_size ()
 Get size of message queue. More...
 
void msgq_flush ()
 Flush all messages. More...
 
void msgq_lock ()
 Lock message queue. More...
 
bool msgq_try_lock ()
 Try to lock message queue. More...
 
void msgq_unlock ()
 Unlock message queue. More...
 
void msgq_pop ()
 Erase first message from queue. More...
 
Messagemsgq_first ()
 Get the first message from the message queue. More...
 
bool msgq_empty ()
 Check if queue is empty. More...
 
void msgq_append (Message *message)
 Enqueue message. More...
 
template<class MessageType >
bool msgq_first_is ()
 Check if first message has desired type. More...
 
template<class MessageType >
MessageType * msgq_first ()
 Get first message casted to the desired type. More...
 
template<class MessageType >
MessageType * msgq_first (MessageType *&msg)
 Get first message casted to the desired type. More...
 
template<class MessageType >
MessageType * msgq_first_safe (MessageType *&msg) throw ()
 Get first message casted to the desired type without exceptions. More...
 
MessageQueue::MessageIterator msgq_begin ()
 Get start iterator for message queue. More...
 
MessageQueue::MessageIterator msgq_end ()
 Get end iterator for message queue. More...
 
InterfaceFieldIterator fields ()
 Get iterator over all fields of this interface instance. More...
 
InterfaceFieldIterator fields_end ()
 Invalid iterator. More...
 
unsigned int num_fields ()
 Get the number of fields in the interface. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from fawkes::Interface
static void parse_uid (const char *uid, std::string &type, std::string &id)
 Parse UID to type and ID strings. More...
 
- Protected Member Functions inherited from fawkes::Interface
 Interface ()
 Constructor. More...
 
void set_hash (unsigned char *ihash)
 Set hash. More...
 
void add_fieldinfo (interface_fieldtype_t type, const char *name, size_t length, void *value, const char *enumtype=0, const interface_enum_map_t *enum_map=0)
 Add an entry to the field info list. More...
 
void add_messageinfo (const char *name)
 Add an entry to the message info list. More...
 
- Protected Attributes inherited from fawkes::Interface
void * data_ptr
 Pointer to local memory storage. More...
 
unsigned int data_size
 Minimal data size to hold data storage. More...
 
bool data_changed
 Indicator if data has changed. More...
 
interface_data_ts_tdata_ts
 Pointer to data casted to timestamp struct. More...
 

Detailed Description

FacerInterface Fawkes BlackBoard Interface.

The interface provides access to the face recognition plugin (facer). It provides basic status information about facer and allows for setting a specific mode and access the resolut. calling skills via messages. It can also be used to manually restart the Lua interpreter if something is wedged.

Definition at line 33 of file FacerInterface.h.

Member Enumeration Documentation

◆ if_facer_opmode_t

This determines the current status of skill execution.

Enumerator
OPMODE_DISABLED 

Facer will not process any images.

OPMODE_DETECTION 

Facer will detect faces, but not try to recognize them.

OPMODE_RECOGNITION 

Facer will detect faces, and then try to recognize the most dominant face.

OPMODE_LEARNING 

Facer will gather images and learn an identity.

OPMODE_GENDER 

Facer will detect faces and try to identify the gender of the faces.

Definition at line 44 of file FacerInterface.h.

Member Function Documentation

◆ bearing()

float fawkes::FacerInterface::bearing ( ) const

Get bearing value.

The relative bearing to the recognized face in radians.

Returns
bearing value

Definition at line 621 of file FacerInterface.cpp.

◆ copy_values()

void fawkes::FacerInterface::copy_values ( const Interface other)
virtual

Copy values from other interface.

Parameters
otherother interface to copy values from

Implements fawkes::Interface.

Definition at line 818 of file FacerInterface.cpp.

References fawkes::Message::type(), and fawkes::Interface::type().

◆ create_message()

Message * fawkes::FacerInterface::create_message ( const char *  type) const
virtual

Create message based on type name.

This will create a new message of the given type. The type must be given without the InterfaceName:: prefix but just the plain class name of the message.

Parameters
typemessage type
Returns
message of the given type, empty
Exceptions
UnknownTypeExceptionthrown if this interface cannot create a message of the given type.

Implements fawkes::Interface.

Definition at line 791 of file FacerInterface.cpp.

◆ enum_tostring()

const char * fawkes::FacerInterface::enum_tostring ( const char *  enumtype,
int  val 
) const
virtual

Convert arbitrary enum value to string.

Given the string representation of the enum type and the value this method returns the string representation of the specific value, or the string UNKNOWN if the value is not defined. An exception is thrown if the enum type is invalid.

Parameters
enumtypeenum type as string
valvalue to convert
Returns
string representation of value
Exceptions
UnknownTypeExceptionthrown if enumtype is not specified for interface.

Implements fawkes::Interface.

Definition at line 829 of file FacerInterface.cpp.

◆ history_ratio()

float fawkes::FacerInterface::history_ratio ( ) const

Get history_ratio value.

The ratio of the most likely identity showing up in the history and the length of the history.

Returns
history_ratio value

Definition at line 402 of file FacerInterface.cpp.

◆ index_last_learned()

uint32_t fawkes::FacerInterface::index_last_learned ( ) const

Get index_last_learned value.

Index of the identity which was learned last.

Returns
index_last_learned value

Definition at line 761 of file FacerInterface.cpp.

◆ is_learning_in_progress()

bool fawkes::FacerInterface::is_learning_in_progress ( ) const

Get learning_in_progress value.

Indicates whether a new identity is currently learnt. If learning is in progress only "old" faces can be recognized.

Returns
learning_in_progress value

Definition at line 511 of file FacerInterface.cpp.

◆ is_searching_person()

bool fawkes::FacerInterface::is_searching_person ( ) const

Get searching_person value.

Indicates whether the plugin is searching for a specified person. If set to true, the index and name will be listed in the fields "requested_index" and "requested_name".

Returns
searching_person value

Definition at line 549 of file FacerInterface.cpp.

◆ maxlenof_bearing()

size_t fawkes::FacerInterface::maxlenof_bearing ( ) const

Get maximum length of bearing value.

Returns
length of bearing value, can be length of the array or number of maximum number of characters for a string

Definition at line 631 of file FacerInterface.cpp.

◆ maxlenof_history_ratio()

size_t fawkes::FacerInterface::maxlenof_history_ratio ( ) const

Get maximum length of history_ratio value.

Returns
length of history_ratio value, can be length of the array or number of maximum number of characters for a string

Definition at line 412 of file FacerInterface.cpp.

◆ maxlenof_index_last_learned()

size_t fawkes::FacerInterface::maxlenof_index_last_learned ( ) const

Get maximum length of index_last_learned value.

Returns
length of index_last_learned value, can be length of the array or number of maximum number of characters for a string

Definition at line 771 of file FacerInterface.cpp.

◆ maxlenof_learning_in_progress()

size_t fawkes::FacerInterface::maxlenof_learning_in_progress ( ) const

Get maximum length of learning_in_progress value.

Returns
length of learning_in_progress value, can be length of the array or number of maximum number of characters for a string

Definition at line 521 of file FacerInterface.cpp.

◆ maxlenof_most_likely_gender()

size_t fawkes::FacerInterface::maxlenof_most_likely_gender ( ) const

Get maximum length of most_likely_gender value.

Returns
length of most_likely_gender value, can be length of the array or number of maximum number of characters for a string

Definition at line 376 of file FacerInterface.cpp.

◆ maxlenof_most_likely_identity()

size_t fawkes::FacerInterface::maxlenof_most_likely_identity ( ) const

Get maximum length of most_likely_identity value.

Returns
length of most_likely_identity value, can be length of the array or number of maximum number of characters for a string

Definition at line 341 of file FacerInterface.cpp.

◆ maxlenof_num_detections()

size_t fawkes::FacerInterface::maxlenof_num_detections ( ) const

Get maximum length of num_detections value.

Returns
length of num_detections value, can be length of the array or number of maximum number of characters for a string

Definition at line 271 of file FacerInterface.cpp.

◆ maxlenof_num_identities()

size_t fawkes::FacerInterface::maxlenof_num_identities ( ) const

Get maximum length of num_identities value.

Returns
length of num_identities value, can be length of the array or number of maximum number of characters for a string

Definition at line 166 of file FacerInterface.cpp.

◆ maxlenof_num_recognitions()

size_t fawkes::FacerInterface::maxlenof_num_recognitions ( ) const

Get maximum length of num_recognitions value.

Returns
length of num_recognitions value, can be length of the array or number of maximum number of characters for a string

Definition at line 306 of file FacerInterface.cpp.

◆ maxlenof_opmode()

size_t fawkes::FacerInterface::maxlenof_opmode ( ) const

Get maximum length of opmode value.

Returns
length of opmode value, can be length of the array or number of maximum number of characters for a string

Definition at line 131 of file FacerInterface.cpp.

◆ maxlenof_recognized_identity()

size_t fawkes::FacerInterface::maxlenof_recognized_identity ( ) const

Get maximum length of recognized_identity value.

Returns
length of recognized_identity value, can be length of the array or number of maximum number of characters for a string

Definition at line 201 of file FacerInterface.cpp.

◆ maxlenof_recognized_name()

size_t fawkes::FacerInterface::maxlenof_recognized_name ( ) const

Get maximum length of recognized_name value.

Returns
length of recognized_name value, can be length of the array or number of maximum number of characters for a string

Definition at line 236 of file FacerInterface.cpp.

◆ maxlenof_recording_progress()

size_t fawkes::FacerInterface::maxlenof_recording_progress ( ) const

Get maximum length of recording_progress value.

Returns
length of recording_progress value, can be length of the array or number of maximum number of characters for a string

Definition at line 596 of file FacerInterface.cpp.

◆ maxlenof_requested_index()

size_t fawkes::FacerInterface::maxlenof_requested_index ( ) const

Get maximum length of requested_index value.

Returns
length of requested_index value, can be length of the array or number of maximum number of characters for a string

Definition at line 701 of file FacerInterface.cpp.

◆ maxlenof_requested_name()

size_t fawkes::FacerInterface::maxlenof_requested_name ( ) const

Get maximum length of requested_name value.

Returns
length of requested_name value, can be length of the array or number of maximum number of characters for a string

Definition at line 736 of file FacerInterface.cpp.

◆ maxlenof_searching_person()

size_t fawkes::FacerInterface::maxlenof_searching_person ( ) const

Get maximum length of searching_person value.

Returns
length of searching_person value, can be length of the array or number of maximum number of characters for a string

Definition at line 559 of file FacerInterface.cpp.

◆ maxlenof_sec_since_detection()

size_t fawkes::FacerInterface::maxlenof_sec_since_detection ( ) const

Get maximum length of sec_since_detection value.

Returns
length of sec_since_detection value, can be length of the array or number of maximum number of characters for a string

Definition at line 448 of file FacerInterface.cpp.

◆ maxlenof_slope()

size_t fawkes::FacerInterface::maxlenof_slope ( ) const

Get maximum length of slope value.

Returns
length of slope value, can be length of the array or number of maximum number of characters for a string

Definition at line 666 of file FacerInterface.cpp.

◆ maxlenof_visibility_history()

size_t fawkes::FacerInterface::maxlenof_visibility_history ( ) const

Get maximum length of visibility_history value.

Returns
length of visibility_history value, can be length of the array or number of maximum number of characters for a string

Definition at line 484 of file FacerInterface.cpp.

◆ message_valid()

bool fawkes::FacerInterface::message_valid ( const Message message) const
virtual

Check if message is valid and can be enqueued.

Parameters
messageMessage to check
Returns
true if the message is valid, false otherwise.

Implements fawkes::Interface.

Definition at line 1566 of file FacerInterface.cpp.

◆ most_likely_gender()

char * fawkes::FacerInterface::most_likely_gender ( ) const

Get most_likely_gender value.

The gender that was recogniced.

Returns
most_likely_gender value

Definition at line 366 of file FacerInterface.cpp.

◆ most_likely_identity()

uint32_t fawkes::FacerInterface::most_likely_identity ( ) const

Get most_likely_identity value.

The identity that was recognized most prevalently.

Returns
most_likely_identity value

Definition at line 331 of file FacerInterface.cpp.

◆ num_detections()

uint32_t fawkes::FacerInterface::num_detections ( ) const

Get num_detections value.

Number of currently detected faces.

Returns
num_detections value

Definition at line 261 of file FacerInterface.cpp.

◆ num_identities()

uint32_t fawkes::FacerInterface::num_identities ( ) const

Get num_identities value.

The number of identities in the database.

Returns
num_identities value

Definition at line 156 of file FacerInterface.cpp.

◆ num_recognitions()

uint32_t fawkes::FacerInterface::num_recognitions ( ) const

Get num_recognitions value.

Number of recognized faces.

Returns
num_recognitions value

Definition at line 296 of file FacerInterface.cpp.

◆ opmode()

FacerInterface::if_facer_opmode_t fawkes::FacerInterface::opmode ( ) const

Get opmode value.

Current opmode.

Returns
opmode value

Definition at line 121 of file FacerInterface.cpp.

◆ recognized_identity()

uint32_t fawkes::FacerInterface::recognized_identity ( ) const

Get recognized_identity value.

The index of the recognized identity.

Returns
recognized_identity value

Definition at line 191 of file FacerInterface.cpp.

◆ recognized_name()

char * fawkes::FacerInterface::recognized_name ( ) const

Get recognized_name value.

The name of the recognized identity.

Returns
recognized_name value

Definition at line 226 of file FacerInterface.cpp.

◆ recording_progress()

float fawkes::FacerInterface::recording_progress ( ) const

Get recording_progress value.

Indicates the progress of recording images of a new face.

Returns
recording_progress value

Definition at line 586 of file FacerInterface.cpp.

◆ requested_index()

uint32_t fawkes::FacerInterface::requested_index ( ) const

Get requested_index value.

Index of the identity for which the name was requested.

Returns
requested_index value

Definition at line 691 of file FacerInterface.cpp.

◆ requested_name()

char * fawkes::FacerInterface::requested_name ( ) const

Get requested_name value.

Requested name.

Returns
requested_name value

Definition at line 726 of file FacerInterface.cpp.

◆ sec_since_detection()

float fawkes::FacerInterface::sec_since_detection ( ) const

Get sec_since_detection value.

Time in seconds since the last successful detection.

Returns
sec_since_detection value

Definition at line 438 of file FacerInterface.cpp.

◆ set_bearing()

void fawkes::FacerInterface::set_bearing ( const float  new_bearing)

Set bearing value.

The relative bearing to the recognized face in radians.

Parameters
new_bearingnew bearing value

Definition at line 643 of file FacerInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_history_ratio()

void fawkes::FacerInterface::set_history_ratio ( const float  new_history_ratio)

Set history_ratio value.

The ratio of the most likely identity showing up in the history and the length of the history.

Parameters
new_history_rationew history_ratio value

Definition at line 425 of file FacerInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_index_last_learned()

void fawkes::FacerInterface::set_index_last_learned ( const uint32_t  new_index_last_learned)

Set index_last_learned value.

Index of the identity which was learned last.

Parameters
new_index_last_learnednew index_last_learned value

Definition at line 783 of file FacerInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_learning_in_progress()

void fawkes::FacerInterface::set_learning_in_progress ( const bool  new_learning_in_progress)

Set learning_in_progress value.

Indicates whether a new identity is currently learnt. If learning is in progress only "old" faces can be recognized.

Parameters
new_learning_in_progressnew learning_in_progress value

Definition at line 534 of file FacerInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_most_likely_gender()

void fawkes::FacerInterface::set_most_likely_gender ( const char *  new_most_likely_gender)

Set most_likely_gender value.

The gender that was recogniced.

Parameters
new_most_likely_gendernew most_likely_gender value

Definition at line 388 of file FacerInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_most_likely_identity()

void fawkes::FacerInterface::set_most_likely_identity ( const uint32_t  new_most_likely_identity)

Set most_likely_identity value.

The identity that was recognized most prevalently.

Parameters
new_most_likely_identitynew most_likely_identity value

Definition at line 353 of file FacerInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_num_detections()

void fawkes::FacerInterface::set_num_detections ( const uint32_t  new_num_detections)

Set num_detections value.

Number of currently detected faces.

Parameters
new_num_detectionsnew num_detections value

Definition at line 283 of file FacerInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_num_identities()

void fawkes::FacerInterface::set_num_identities ( const uint32_t  new_num_identities)

Set num_identities value.

The number of identities in the database.

Parameters
new_num_identitiesnew num_identities value

Definition at line 178 of file FacerInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_num_recognitions()

void fawkes::FacerInterface::set_num_recognitions ( const uint32_t  new_num_recognitions)

Set num_recognitions value.

Number of recognized faces.

Parameters
new_num_recognitionsnew num_recognitions value

Definition at line 318 of file FacerInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_opmode()

void fawkes::FacerInterface::set_opmode ( const if_facer_opmode_t  new_opmode)

Set opmode value.

Current opmode.

Parameters
new_opmodenew opmode value

Definition at line 143 of file FacerInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_recognized_identity()

void fawkes::FacerInterface::set_recognized_identity ( const uint32_t  new_recognized_identity)

Set recognized_identity value.

The index of the recognized identity.

Parameters
new_recognized_identitynew recognized_identity value

Definition at line 213 of file FacerInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_recognized_name()

void fawkes::FacerInterface::set_recognized_name ( const char *  new_recognized_name)

Set recognized_name value.

The name of the recognized identity.

Parameters
new_recognized_namenew recognized_name value

Definition at line 248 of file FacerInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_recording_progress()

void fawkes::FacerInterface::set_recording_progress ( const float  new_recording_progress)

Set recording_progress value.

Indicates the progress of recording images of a new face.

Parameters
new_recording_progressnew recording_progress value

Definition at line 608 of file FacerInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_requested_index()

void fawkes::FacerInterface::set_requested_index ( const uint32_t  new_requested_index)

Set requested_index value.

Index of the identity for which the name was requested.

Parameters
new_requested_indexnew requested_index value

Definition at line 713 of file FacerInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_requested_name()

void fawkes::FacerInterface::set_requested_name ( const char *  new_requested_name)

Set requested_name value.

Requested name.

Parameters
new_requested_namenew requested_name value

Definition at line 748 of file FacerInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_searching_person()

void fawkes::FacerInterface::set_searching_person ( const bool  new_searching_person)

Set searching_person value.

Indicates whether the plugin is searching for a specified person. If set to true, the index and name will be listed in the fields "requested_index" and "requested_name".

Parameters
new_searching_personnew searching_person value

Definition at line 573 of file FacerInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_sec_since_detection()

void fawkes::FacerInterface::set_sec_since_detection ( const float  new_sec_since_detection)

Set sec_since_detection value.

Time in seconds since the last successful detection.

Parameters
new_sec_since_detectionnew sec_since_detection value

Definition at line 460 of file FacerInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_slope()

void fawkes::FacerInterface::set_slope ( const float  new_slope)

Set slope value.

The relative slope to the recognized face in radians.

Parameters
new_slopenew slope value

Definition at line 678 of file FacerInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_visibility_history()

void fawkes::FacerInterface::set_visibility_history ( const int32_t  new_visibility_history)

Set visibility_history value.

The number of consecutive sighting ( <= 1 ) and non-sightings ( >= -1 ), respectively.

Parameters
new_visibility_historynew visibility_history value

Definition at line 497 of file FacerInterface.cpp.

References fawkes::Interface::data_changed.

◆ slope()

float fawkes::FacerInterface::slope ( ) const

Get slope value.

The relative slope to the recognized face in radians.

Returns
slope value

Definition at line 656 of file FacerInterface.cpp.

◆ tostring_if_facer_opmode_t()

const char * fawkes::FacerInterface::tostring_if_facer_opmode_t ( if_facer_opmode_t  value) const

Convert if_facer_opmode_t constant to string.

Parameters
valuevalue to convert to string
Returns
constant value as string.

Definition at line 102 of file FacerInterface.cpp.

◆ visibility_history()

int32_t fawkes::FacerInterface::visibility_history ( ) const

Get visibility_history value.

The number of consecutive sighting ( <= 1 ) and non-sightings ( >= -1 ), respectively.

Returns
visibility_history value

Definition at line 474 of file FacerInterface.cpp.


The documentation for this class was generated from the following files: