Banuba SDK
Public Member Functions | Static Public Member Functions | List of all members
bnb::interfaces::frame_data Class Referenceabstract

getters throw exceptions when data are not available android NNs usually output gpu masks More...

#include <frame_data.hpp>

Public Member Functions

virtual full_image_format get_full_img_format ()=0
 
virtual std::vector< float > get_full_img_transform ()=0
 
virtual std::shared_ptr< frx_recognition_resultget_frx_recognition_result ()=0
 Get frx_recognition_result or null if not exists.
 
virtual void set_frx_recognition_result (const std::shared_ptr< frx_recognition_result > &result)=0
 
virtual std::vector< detected_faceget_face_detector_result ()=0
 Face detector is an input for face recognizer. More...
 
virtual action_units_data get_action_units ()=0
 
virtual bool get_is_smile ()=0
 DEPRECATED. More...
 
virtual bool get_is_mouth_open ()=0
 DEPRECATED. More...
 
virtual bool get_are_brows_raised ()=0
 DEPRECATED. More...
 
virtual bool get_are_brows_shifted ()=0
 DEPRECATED. More...
 
virtual bool get_is_wear_glasses ()=0
 DEPRECATED. More...
 
virtual float get_ruler ()=0
 
virtual eyes_state get_eyes_state ()=0
 DEPRECATED. More...
 
virtual float get_light_correction ()=0
 
virtual transformed_mask_byte get_background ()=0
 
virtual transformed_mask_gpu get_background_gpu ()=0
 
virtual transformed_mask_byte get_hair ()=0
 
virtual transformed_mask_gpu get_hair_gpu ()=0
 
virtual transformed_mask_byte get_skin ()=0
 
virtual transformed_mask_gpu get_skin_gpu ()=0
 
virtual transformed_mask_byte get_lips ()=0
 
virtual transformed_mask_gpu get_lips_gpu ()=0
 
virtual transformed_mask_byte get_teeth ()=0
 
virtual transformed_mask_byte get_body ()=0
 
virtual lips_shine_mask get_lips_shine ()=0
 
virtual brows_mask get_brows ()=0
 
virtual eyes_mask get_eyes ()=0
 
virtual transformed_mask_byte get_face ()=0
 
virtual transformed_mask_byte get_face_skin ()=0
 
virtual std::optional< std::string > get_face_attributes ()=0
 
virtual int32_t get_face_shape ()=0
 Return value: 0 – 'Undefined', 1 – 'Heart', 2 – 'Oblong', 3 – 'Oval', 4 – 'Round', 5 – 'Square'.
 
virtual float get_pupillary_distance ()=0
 Pupillary distance in mm.
 
virtual std::vector< float > get_light_source_params ()=0
 list[0] and list[1] - x and y coordinates of the thermal temperature of the light source list[2] - the brightness of the frame
 
virtual std::vector< int32_t > get_teeth_color ()=0
 Teeth color in Lab color space.
 
virtual std::vector< float > get_glasses_frame_color ()=0
 Eyeglasses frame color in RGB space.
 
virtual void add_full_img (::bnb::full_image_t img)=0
 
virtual void replace_full_img (::bnb::full_image_t img)=0
 
virtual ::bnb::full_image_t get_full_img ()=0
 
virtual void add_background (const transformed_mask_byte &mask)=0
 
virtual void add_external_face_data (face_data_source source, const std::vector< external_face_data > &data)=0
 
virtual void add_depth_map (const depth_map &depth_map)=0
 
virtual void add_frame_number (int64_t frame_number)=0
 
virtual void add_action_units_data (const action_units_data &action_units)=0
 
virtual void add_feature_parameters (const std::unordered_map< feature_id, std::vector< feature_parameter >> &params)=0
 Extra parameters during in-CPU feature calculations. More...
 
virtual void add_timestamp_us (double timestamp_us)=0
 add frame timestamp in microseconds
 
virtual std::vector< float > get_chromakey_color ()=0
 

Static Public Member Functions

static std::shared_ptr< frame_datacreate ()
 Creates empty FrameData. More...
 

Detailed Description

getters throw exceptions when data are not available android NNs usually output gpu masks

Definition at line 41 of file frame_data.hpp.

Member Function Documentation

◆ add_feature_parameters()

virtual void bnb::interfaces::frame_data::add_feature_parameters ( const std::unordered_map< feature_id, std::vector< feature_parameter >> &  params)
pure virtual

Extra parameters during in-CPU feature calculations.

Reference feature documentation.

◆ create()

static std::shared_ptr<frame_data> bnb::interfaces::frame_data::create ( )
static

Creates empty FrameData.

Use add* function to fill it.

◆ get_are_brows_raised()

virtual bool bnb::interfaces::frame_data::get_are_brows_raised ( )
pure virtual

DEPRECATED.

Use getFrxRecognitionResult().getFaces() instead.

◆ get_are_brows_shifted()

virtual bool bnb::interfaces::frame_data::get_are_brows_shifted ( )
pure virtual

DEPRECATED.

Use getFrxRecognitionResult().getFaces() instead.

◆ get_eyes_state()

virtual eyes_state bnb::interfaces::frame_data::get_eyes_state ( )
pure virtual

DEPRECATED.

Use getFrxRecognitionResult().getFaces() instead.

◆ get_face_detector_result()

virtual std::vector<detected_face> bnb::interfaces::frame_data::get_face_detector_result ( )
pure virtual

Face detector is an input for face recognizer.

It gives only position of the face. Even if the face is present on the frame it doesn't mean that face detector can track it.

◆ get_is_mouth_open()

virtual bool bnb::interfaces::frame_data::get_is_mouth_open ( )
pure virtual

DEPRECATED.

Use getFrxRecognitionResult().getFaces() instead.

◆ get_is_smile()

virtual bool bnb::interfaces::frame_data::get_is_smile ( )
pure virtual

DEPRECATED.

Use getFrxRecognitionResult().getFaces() instead.

◆ get_is_wear_glasses()

virtual bool bnb::interfaces::frame_data::get_is_wear_glasses ( )
pure virtual

DEPRECATED.

Use getFrxRecognitionResult().getFaces() instead.


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