visageSDK
Instance Methods | List of all members
VisageConfiguration Class Reference

Objective-C wrapper of the native VisageSDK::VisageConfiguration class. More...

#import <objc_VisageConfiguration.h>

Inherits NSObject.

Instance Methods

(VisageConfiguration *) - initWithConfigFile:
 Constructor. More...
 
(VisageConfiguration *) - initWithConfiguration:
 Copy constructor. More...
 
(id) - copyWithZone:
 Copy operator. More...
 
(float) - getCameraFocus
 Returns the value of the camera_focus parameter. More...
 
(float) - getRecoveryTimeout
 Returns the value of the recovery_timeout parameter. More...
 
(NSArray *) - getSmoothingFactors
 Returns the value of the smoothing_factors parameter. More...
 
(int) - getEnableSmoothing
 Returns the value of the enable_smoothing parameter. More...
 
(int) - getTemporallyDenoiseInput
 Returns the value of the temporally_denoise_input parameter. More...
 
(NSString *) - getVftDataPath
 Returns the value of the vft_data_path parameter. More...
 
(NSString *) - getVfdDataPath
 Returns the value of the vfd_data_path parameter. More...
 
(NSString *) - getPrDataPath
 Returns the value of the pr_data_path parameter. More...
 
(NSString *) - getErDataPath
 Returns the value of the er_data_path parameter. More...
 
(int) - getPoseModelAuCount
 Returns the number of action units for the pose fitting model. More...
 
(int) - getAuModelAuCount
 Returns the number of action units for the action unit fitting model. More...
 
(int) - getMeshModelAuCount
 Returns the number of action units for the mesh fitting model. More...
 
(int) - getPoseModelSuCount
 Returns the number of shape units for the pose fitting model. More...
 
(int) - getAuModelSuCount
 Returns the number of shape units for the action unit fitting model. More...
 
(int) - getMeshModelSuCount
 Returns the number of shape units for the mesh fitting model. More...
 
(int) - getProcessEyes
 Returns the value of the process_eyes parameter. More...
 
(int) - getRefineLandmarks
 Returns the value of the refine_landmarks parameter. More...
 
(int) - getRefineEars
 Returns the value of the refine_ears parameter. More...
 
(float) - getMinFaceScale
 Returns the value of the min_face_scale parameter. More...
 
(float) - getMaxFaceScale
 Returns the value of the max_face_scale parameter. More...
 
(float) - getFaceDetectorSensitivity
 Returns the value of the face_detector_sensitivity parameter. More...
 
(NSString *) - getPoseFittingModelConfiguration
 Returns the value of the pose_fitting_model_configuration parameter. More...
 
(NSString *) - getAuFittingModelConfiguration
 Returns the value of the au_fitting_model_configuration parameter. More...
 
(NSString *) - getMeshFittingModelConfiguration
 Returns the value of the mesh_fitting_model_configuration parameter. More...
 
(bool) - setCameraFocus:
 Sets the value of the camera_focus parameter. More...
 
(bool) - setRecoveryTimeout:
 Sets the value of the recovery_timeout parameter. More...
 
(bool) - setSmoothingFactors:
 Sets the values of the smoothing_factors parameter. More...
 
(bool) - setEnableSmoothing:
 Sets the value of the enable_smoothing parameter. More...
 
(bool) - setTemporallyDenoiseInput:
 Sets the value of the temporally_denoise_input parameter. More...
 
(bool) - setVftDataPath:
 Sets the value of the vft_data_path parameter. More...
 
(bool) - setVfdDataPath:
 Sets the value of the vfd_data_path parameter. More...
 
(bool) - setPrDataPath:
 Sets the value of the pr_data_path parameter. More...
 
(bool) - setErDataPath:
 Sets the value of the er_data_path parameter. More...
 
(bool) - setProcessEyes:
 Sets the value of the process_eyes parameter. More...
 
(bool) - setRefineLandmarks:
 Sets the value of the refine_landmarks parameter. More...
 
(bool) - setRefineEars:
 Sets the value of the refine_ears parameter. More...
 
(bool) - setMinFaceScale:
 Sets the value of the min_face_scale parameter. More...
 
(bool) - setMaxFaceScale:
 Sets the value of the max_face_scale parameter. More...
 
(bool) - setFaceDetectorSensitivity:
 Sets the value of the face_detector_sensitivity parameter. More...
 
(bool) - setPoseFittingModelConfiguration:
 Sets the value of the pose_fitting_model_configuration parameter. More...
 
(bool) - setAuFittingModelConfiguration:
 Sets the value of the au_fitting_model_configuration parameter. More...
 
(bool) - setMeshFittingModelConfiguration:
 Sets the value of the mesh_fitting_model_configuration parameter. More...
 
(void) - enableAuModel
 Enables the use of the 3D model used to estimate action units (au_fitting_model configuration parameter).
 
(void) - enableMeshModel
 Enables the use of the fine 3D mesh (mesh_fitting_model configuration parameter).
 
(void) - disableAuModel
 Disables the use of the 3D model used to estimate action units (au_fitting_model configuration parameter).
 
(void) - disableMeshModel
 Disables the use of the fine 3D mesh (mesh_fitting_model configuration parameter).
 
(bool) - setConfigurationFile:
 Reads and loads values from a specified configuration (*.cfg) file. More...
 

Detailed Description

Objective-C wrapper of the native VisageSDK::VisageConfiguration class.

Definition at line 19 of file objc_VisageConfiguration.h.

Method Documentation

◆ copyWithZone:()

- (id) copyWithZone: (NSZone *)  zone

Copy operator.

Parameters
zoneZone.

◆ getAuFittingModelConfiguration()

- (NSString *) getAuFittingModelConfiguration

Returns the value of the au_fitting_model_configuration parameter.

Returns
NSString containing path of the au_fitting_model_configuration parameter.

◆ getAuModelAuCount()

- (int) getAuModelAuCount

Returns the number of action units for the action unit fitting model.

Returns
Unsigned integer value greater than 0 if the action model is succesfully loaded.

◆ getAuModelSuCount()

- (int) getAuModelSuCount

Returns the number of shape units for the action unit fitting model.

Returns
Unsigned integer value greater than 0 if the action model is succesfully loaded.

◆ getCameraFocus()

- (float) getCameraFocus

Returns the value of the camera_focus parameter.

Returns
Float value of the camera_focus parameter

◆ getEnableSmoothing()

- (int) getEnableSmoothing

Returns the value of the enable_smoothing parameter.

Returns
Unsigned integer value of the enable_smoothing parameter.

◆ getErDataPath()

- (NSString *) getErDataPath

Returns the value of the er_data_path parameter.

Returns
NSString containing the path of the er_data_path parameter.

◆ getFaceDetectorSensitivity()

- (float) getFaceDetectorSensitivity

Returns the value of the face_detector_sensitivity parameter.

Returns
Float value of the face_detector_sensitivity parameter.

◆ getMaxFaceScale()

- (float) getMaxFaceScale

Returns the value of the max_face_scale parameter.

Returns
Float value of the max_face_scale parameter.

◆ getMeshFittingModelConfiguration()

- (NSString *) getMeshFittingModelConfiguration

Returns the value of the mesh_fitting_model_configuration parameter.

Returns
NSString containing path of the mesh_fitting_model_configuration parameter.

◆ getMeshModelAuCount()

- (int) getMeshModelAuCount

Returns the number of action units for the mesh fitting model.

Returns
Unsigned integer value greater than 0 if the mesh model is succesfully loaded.

◆ getMeshModelSuCount()

- (int) getMeshModelSuCount

Returns the number of shape units for the mesh fitting model.

Returns
Unsigned integer value greater than 0 if the mesh model is succesfully loaded.

◆ getMinFaceScale()

- (float) getMinFaceScale

Returns the value of the min_face_scale parameter.

Returns
Float value of the min_face_scale parameter.

◆ getPoseFittingModelConfiguration()

- (NSString *) getPoseFittingModelConfiguration

Returns the value of the pose_fitting_model_configuration parameter.

Returns
NSString containing path of the pose_fitting_model_configuration parameter.

◆ getPoseModelAuCount()

- (int) getPoseModelAuCount

Returns the number of action units for the pose fitting model.

Returns
Unsigned integer value greater than 0 if the pose model is succesfully loaded.

◆ getPoseModelSuCount()

- (int) getPoseModelSuCount

Returns the number of shape units for the pose fitting model.

Returns
Unsigned integer value greater than 0 if the pose model is succesfully loaded.

◆ getPrDataPath()

- (NSString *) getPrDataPath

Returns the value of the pr_data_path parameter.

Returns
NSString containing the path of the pr_data_path parameter.

◆ getProcessEyes()

- (int) getProcessEyes

Returns the value of the process_eyes parameter.

Returns
Unsigned integer value of the process_eyes parameter.

◆ getRecoveryTimeout()

- (float) getRecoveryTimeout

Returns the value of the recovery_timeout parameter.

Returns
Float value of the recovery_timeout parameter.

◆ getRefineEars()

- (int) getRefineEars

Returns the value of the refine_ears parameter.

Returns
Unsigned integer value of the refine_ears parameter.

◆ getRefineLandmarks()

- (int) getRefineLandmarks

Returns the value of the refine_landmarks parameter.

Returns
Unsigned integer value of the refine_landmarks parameter.

◆ getSmoothingFactors()

- (NSArray *) getSmoothingFactors

Returns the value of the smoothing_factors parameter.

Returns
NSArray containing float values of the smoothing_factors parameter.

◆ getTemporallyDenoiseInput()

- (int) getTemporallyDenoiseInput

Returns the value of the temporally_denoise_input parameter.

Returns
Unsigned integer value of the temporally_denoise_input parameter.

◆ getVfdDataPath()

- (NSString *) getVfdDataPath

Returns the value of the vfd_data_path parameter.

Returns
NSString containing the path of the vfd_data_path parameter.

◆ getVftDataPath()

- (NSString *) getVftDataPath

Returns the value of the vft_data_path parameter.

Returns
NSString containing the path of the vft_data_path parameter.

◆ initWithConfigFile:()

- (VisageConfiguration *) initWithConfigFile: (NSString *)  configFile

Constructor.

Creates a new instance of the VisageConfiguration class by reading a specified configuration (*.cfg) file.

Parameters
configFilePath to a specified configuration (*.cfg) file.

◆ initWithConfiguration:()

- (VisageConfiguration *) initWithConfiguration: (VisageConfiguration *)  configuration

Copy constructor.

Creates a new instance of the VisageConfiguration class by copying an already existing instance.

Parameters
configurationReference to pre-existing VisageConfiguration object.

◆ setAuFittingModelConfiguration:()

- (bool) setAuFittingModelConfiguration: (NSString *)  au_fitting_model_configuration

Sets the value of the au_fitting_model_configuration parameter.

This function sets the .cfg (au_fitting_model_configuration) file used for action unit fitting. The path to the model configuration must be relative to the configuration file used for tracker initialization. The model will be disabled if the passed string is empty ("") or "none".

NOTE: Changing the model configuration affects the sizes of arrays in the FaceData object populated with values from the model file.

Parameters
au_fitting_model_configurationNSString path to the model configuration file
Returns
True if the parameter was changed, false if the input file does not exist

◆ setCameraFocus:()

- (bool) setCameraFocus: (float)  camera_focus

Sets the value of the camera_focus parameter.

Value must be greater than zero.

Parameters
camera_focusFloat value
Returns
True if the parameter was changed, false if the input was invalid

◆ setConfigurationFile:()

- (bool) setConfigurationFile: (NSString *)  trackerConfigFile

Reads and loads values from a specified configuration (*.cfg) file.

Parameters
trackerConfigFilePath to a configuration (*.cfg) file

◆ setEnableSmoothing:()

- (bool) setEnableSmoothing: (int)  enable_smoothing

Sets the value of the enable_smoothing parameter.

Value can be 0, 1.

Parameters
enable_smoothingInteger value
Returns
True if the parameter was changed, false if the input was invalid

◆ setErDataPath:()

- (bool) setErDataPath: (NSString *)  er_data_path

Sets the value of the er_data_path parameter.

The path must be relative to the configuration file used for tracker initialization and not empty.

Parameters
er_data_pathNSString path to the folder containing ears' refinement data files
Returns
True if the parameter was changed, false if the input was invalid

◆ setFaceDetectorSensitivity:()

- (bool) setFaceDetectorSensitivity: (float)  face_detector_sensitivity

Sets the value of the face_detector_sensitivity parameter.

Value must be greater than 0.0 and less than or equal to 1.0.

Parameters
face_detector_sensitivityFloat value
Returns
True if the parameter was changed, false if the input was invalid

◆ setMaxFaceScale:()

- (bool) setMaxFaceScale: (float)  max_face_scale

Sets the value of the max_face_scale parameter.

Value must be greater than 0.0 and less than or equal to 1.0.

Parameters
max_face_scaleFloat value
Returns
True if the parameter was changed, false if the input was invalid

◆ setMeshFittingModelConfiguration:()

- (bool) setMeshFittingModelConfiguration: (NSString *)  mesh_fitting_model_configuration

Sets the value of the mesh_fitting_model_configuration parameter.

This function sets the .cfg (mesh_fitting_model_configuration) file used for mesh fitting. The path to the model configuration must be relative to the configuration file used for tracker initialization. The model will be disabled if the passed string is empty ("") or "none".

NOTE: Changing the model configuration affects the sizes of arrays in the FaceData object populated with values from the model file.

Parameters
mesh_fitting_model_configurationNSString path to the model configuration file
Returns
True if the parameter was changed, false if the input file does not exist

◆ setMinFaceScale:()

- (bool) setMinFaceScale: (float)  min_face_scale

Sets the value of the min_face_scale parameter.

Value must be greater than 0.0 and less than or equal to 1.0.

Parameters
min_face_scaleFloat value
Returns
True if the parameter was changed, false if the input was invalid

◆ setPoseFittingModelConfiguration:()

- (bool) setPoseFittingModelConfiguration: (NSString *)  pose_fitting_model_configuration

Sets the value of the pose_fitting_model_configuration parameter.

This function sets the .cfg (pose_fitting_model_configuration) file used for pose fitting. The path to the model configuration must be relative to the configuration file used for tracker initialization. The model will be disabled if the passed string is empty ("") or "none".

NOTE: Changing the model configuration affects the sizes of arrays in the FaceData object populated with values from the model file.

Parameters
pose_fitting_model_configurationNSString path to the model configuration file
Returns
True if the parameter was changed, false if the input file does not exist

◆ setPrDataPath:()

- (bool) setPrDataPath: (NSString *)  pr_data_path

Sets the value of the pr_data_path parameter.

The path must be relative to the configuration file used for tracker initialization and not empty.

Parameters
pr_data_pathNSString path to the folder containing pupils' refinement data files
Returns
True if the parameter was changed, false if the input was invalid

◆ setProcessEyes:()

- (bool) setProcessEyes: (int)  process_eyes

Sets the value of the process_eyes parameter.

Value can only be 0, 1, 2, or 3.

Parameters
process_eyesInteger value
Returns
True if the parameter was changed, false if the input was invalid

◆ setRecoveryTimeout:()

- (bool) setRecoveryTimeout: (float)  recovery_timeout

Sets the value of the recovery_timeout parameter.

Value must be greater than or equal to zero and not a NaN value.

Parameters
recovery_timeoutFloat value
Returns
True if the parameter was changed, false if the input was invalid

◆ setRefineEars:()

- (bool) setRefineEars: (int)  refine_ears

Sets the value of the refine_ears parameter.

Value can only be 0 or 1.

Parameters
refine_earsInteger value
Returns
True if the parameter was changed, false if the input was invalid

◆ setRefineLandmarks:()

- (bool) setRefineLandmarks: (int)  refine_landmarks

Sets the value of the refine_landmarks parameter.

Value can be 0, 1.

Parameters
refine_landmarksInteger value
Returns
True if the parameter was changed, false if the input was invalid

◆ setSmoothingFactors:()

- (bool) setSmoothingFactors: (NSArray *)  smoothing_factors

Sets the values of the smoothing_factors parameter.

Values must not be a NaN value.

Parameters
smoothing_factorsReference to a NSArray containing float values
Returns
True if the parameter was changed, false if the input was invalid

◆ setTemporallyDenoiseInput:()

- (bool) setTemporallyDenoiseInput: (int)  temporally_denoise_input

Sets the value of the temporally_denoise_input parameter.

Value can be 0, 1.

Parameters
temporally_denoise_inputInteger value
Returns
True if the parameter was changed, false if the input was invalid

◆ setVfdDataPath:()

- (bool) setVfdDataPath: (NSString *)  vfd_data_path

Sets the value of the vfd_data_path parameter.

The path must be relative to the configuration file used for tracker initialization and not empty.

Parameters
vfd_data_pathNSString path to the folder containing algorithm data file required by tracker and detector
Returns
True if the parameter was changed, false if the input was invalid

◆ setVftDataPath:()

- (bool) setVftDataPath: (NSString *)  vft_data_path

Sets the value of the vft_data_path parameter.

The path must be relative to the configuration file used for tracker initialization and not empty.

Parameters
vft_data_pathNSString path to the folder containing tracking algorithm data files required by tracker
Returns
True if the parameter was changed, false if the input was invalid

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