Face Engine SDK
4.6.0
A face detection, recognition and tracking engine.
|
Common interfaces and macros shared across all SDK objects. More...
Classes | |
struct | fsdk::IFaceEngineMobile |
Root LUNA SDK object interface. More... | |
struct | fsdk::IArchive |
Archive interface. More... | |
struct | fsdk::ISerializableObject |
Serializable object interface. More... | |
struct | fsdk::ErrorTraits< ISerializableObject::Error > |
Specialized for ISerializableObject::SerializationError. More... | |
struct | fsdk::IDataStorageObject |
Data storage object interface helper. More... | |
struct | fsdk::IRefCounted |
Base strong reference counted object interface. More... | |
struct | fsdk::ISettingsProvider |
SDK settings provider interface. More... | |
struct | fsdk::ErrorTraits< ISettingsProvider::Error > |
Specialized for ISettingsProvider::ParseError. More... | |
Macros | |
#define | ALIGN_UP(value, align) |
#define | ALIGNED(x) __attribute__ ((aligned(x))) |
#define | RESTRICT __restrict__ |
#define | FORCE_INLINE inline __attribute__ ((always_inline)) |
#define | DECLARE_SMARTPTR(X) struct X; using X##Ptr = fsdk::Ref<X> |
Smart ptr declaration helper macro. | |
#define | STRINGIFY2(x) #x |
Stringification helper macro. | |
#define | STRINGIFY(x) STRINGIFY2(x) |
Stringifies it's argument. | |
Functions | |
virtual IDetector * | fsdk::IFaceEngineMobile::createDetector () noexcept=0 |
Creates a detector of given type. More... | |
virtual IHeadPoseEstimator * | fsdk::IFaceEngineMobile::createHeadPoseEstimator () noexcept=0 |
Creates Head pose estimator. More... | |
virtual IAGSEstimator * | fsdk::IFaceEngineMobile::createAGSEstimator () noexcept=0 |
Creates AGS estimator. More... | |
virtual IEyeEstimator * | fsdk::IFaceEngineMobile::createEyeEstimator () noexcept=0 |
Creates Eye estimator. More... | |
virtual IBestShotQualityEstimator * | fsdk::IFaceEngineMobile::createBestShotQualityEstimator () noexcept=0 |
Creates BestShotQuality estimator. More... | |
virtual IDescriptor * | fsdk::IFaceEngineMobile::createDescriptor (uint32_t version=0) noexcept=0 |
Creates Descriptor. More... | |
virtual IDescriptor * | fsdk::IFaceEngineMobile::createDescriptor (fsdk::IArchive *archive, uint32_t flags=0) noexcept=0 |
Creates and loads Descriptor from Archive. More... | |
virtual IDescriptorBatch * | fsdk::IFaceEngineMobile::createDescriptorBatch (int32_t size, uint32_t version=0) noexcept=0 |
Creates Batch of descriptors. More... | |
virtual IDescriptorExtractor * | fsdk::IFaceEngineMobile::createExtractor (uint32_t version=0) noexcept=0 |
Creates descriptor extractor. More... | |
virtual IDescriptorMatcher * | fsdk::IFaceEngineMobile::createMatcher (uint32_t version=0) noexcept=0 |
Creates descriptor matcher. More... | |
virtual IWarper * | fsdk::IFaceEngineMobile::createWarper () noexcept=0 |
Creates warper. More... | |
virtual FaceEngineEdition | fsdk::IFaceEngineMobile::getFaceEngineEdition () const noexcept=0 |
Get LUNA SDK ditribution edition. More... | |
virtual void | fsdk::IFaceEngineMobile::setDataDirectory (const char *path) noexcept=0 |
Sets data directory. More... | |
virtual const char * | fsdk::IFaceEngineMobile::getDataDirectory () const noexcept=0 |
Gets data directory. More... | |
virtual void | fsdk::IFaceEngineMobile::setSettingsProvider (ISettingsProvider *provider) noexcept=0 |
Sets settings provider. More... | |
virtual void | fsdk::IFaceEngineMobile::setRuntimeSettingsProvider (ISettingsProvider *provider) noexcept=0 |
Sets runtime settings provider. More... | |
virtual ISettingsProvider * | fsdk::IFaceEngineMobile::getSettingsProvider () const noexcept=0 |
Gets settings provider. More... | |
virtual ISettingsProvider * | fsdk::IFaceEngineMobile::getRuntimeSettingsProvider () const noexcept=0 |
Gets runtime settings provider. More... | |
virtual ILicense * | fsdk::IFaceEngineMobile::getLicense () const noexcept=0 |
Get current License object, which was set for FaceEngine object. More... | |
FSDK_API bool | fsdk::activateLicense (ILicense *license, const char *configPath) noexcept |
Makes License activation with some platform specific manner. Network connection is required. More... | |
FSDK_API IFaceEngineMobile * | fsdk::createFaceEngineMobile (const char *dataPath=nullptr, const char *configPath=nullptr, const char *runtimePath=nullptr) noexcept |
Create the LUNA SDK root object. More... | |
FSDK_API ISettingsProvider * | fsdk::createSettingsProvider (const char *path) noexcept |
Create a settings provider. More... | |
bool | fsdk::ISettingsProvider::Value::setString (const char *string) noexcept |
Set a string value. More... | |
fsdk::ISettingsProvider::Value::Value (Value &&other) | |
Value & | fsdk::ISettingsProvider::Value::operator= (Value &&other) |
void | fsdk::ISettingsProvider::Value::swap (Value &first, Value &second) |
bool | fsdk::ISettingsProvider::Value::getString (char *string) const noexcept |
Get a string value. More... | |
void | fsdk::ISettingsProvider::Value::setRect (const Rect &rect) noexcept |
Set a rect value. More... | |
bool | fsdk::ISettingsProvider::Value::getRect (Rect *rect) const noexcept |
Get a rect value. More... | |
void | fsdk::ISettingsProvider::Value::setSize (const Size &size) noexcept |
Set a size value. More... | |
bool | fsdk::ISettingsProvider::Value::getSize (Size *size) const noexcept |
Get a size value. More... | |
void | fsdk::ISettingsProvider::Value::setPoint2i (const Point2i &point) noexcept |
Set a Point2i value. More... | |
bool | fsdk::ISettingsProvider::Value::getPoint2i (Point2i *point) const noexcept |
Get a Point2i value. More... | |
void | fsdk::ISettingsProvider::Value::setPoint2f (const Point2f &point) noexcept |
Set a setPoint2f value. More... | |
bool | fsdk::ISettingsProvider::Value::getPoint2f (Point2f *point) const noexcept |
Get a Point2f value. More... | |
void | fsdk::ISettingsProvider::Value::setBool (bool x) noexcept |
Set a bool value. More... | |
bool | fsdk::ISettingsProvider::Value::getBool (bool *x) const noexcept |
Get a bool value. More... | |
void | fsdk::ISettingsProvider::Value::setInt (int x) noexcept |
Set an int value. More... | |
bool | fsdk::ISettingsProvider::Value::getInt (int *x) const noexcept |
Get an int value. More... | |
void | fsdk::ISettingsProvider::Value::setInt (int x, int y) noexcept |
Set a 2d int value. More... | |
bool | fsdk::ISettingsProvider::Value::getInt (int *x, int *y) const noexcept |
Get a 2d int value. More... | |
void | fsdk::ISettingsProvider::Value::setInt (int x, int y, int z) noexcept |
Set a 3d int value. More... | |
bool | fsdk::ISettingsProvider::Value::getInt (int *x, int *y, int *z) const noexcept |
Get a 3d int value. More... | |
void | fsdk::ISettingsProvider::Value::setInt (int x, int y, int z, int w) noexcept |
Set a 4d int value. More... | |
bool | fsdk::ISettingsProvider::Value::getInt (int *x, int *y, int *z, int *w) const noexcept |
Get a 4d int value. More... | |
void | fsdk::ISettingsProvider::Value::setFloat (float x) noexcept |
Set a float value. More... | |
bool | fsdk::ISettingsProvider::Value::getFloat (float *x) const noexcept |
Get a float value. More... | |
void | fsdk::ISettingsProvider::Value::setFloat (float x, float y) noexcept |
Set a 2d float value. More... | |
bool | fsdk::ISettingsProvider::Value::getFloat (float *x, float *y) const noexcept |
Get a 2d float value. More... | |
void | fsdk::ISettingsProvider::Value::setFloat (float x, float y, float z) noexcept |
Set a 3d float value. More... | |
bool | fsdk::ISettingsProvider::Value::getFloat (float *x, float *y, float *z) const noexcept |
Get a 3d float value. More... | |
void | fsdk::ISettingsProvider::Value::setFloat (float x, float y, float z, float w) noexcept |
Set a 4d float value. More... | |
bool | fsdk::ISettingsProvider::Value::getFloat (float *x, float *y, float *z, float *w) const noexcept |
Get a 4d float value. More... | |
float | fsdk::ISettingsProvider::Value::asFloat (float defaultValue=0.f) const noexcept |
Safely get a float. More... | |
Point2f | fsdk::ISettingsProvider::Value::asPoint2f (const Point2f &defaultValue=Point2f()) const noexcept |
Safely get a Point2f. More... | |
bool | fsdk::ISettingsProvider::Value::asBool (bool defaultValue=false) const noexcept |
Safely get a boolean. More... | |
int | fsdk::ISettingsProvider::Value::asInt (int defaultValue=0) const noexcept |
Safely get an integer. More... | |
Size | fsdk::ISettingsProvider::Value::asSize (const Size &defaultValue=Size()) const noexcept |
Safely get a Size. More... | |
Point2i | fsdk::ISettingsProvider::Value::asPoint2i (const Point2i &defaultValue=Point2i()) const noexcept |
Safely get a Point2i. More... | |
Rect | fsdk::ISettingsProvider::Value::asRect (const Rect &defaultValue=Rect()) const noexcept |
Safely get a Rect. More... | |
const char * | fsdk::ISettingsProvider::Value::asString (const char *defaultValue="") const noexcept |
Safely get a string. More... | |
fsdk::ISettingsProvider::Key::Key () noexcept | |
Initialize an empty key. | |
fsdk::ISettingsProvider::Key::Key (const char *section, const char *parameter) noexcept | |
Initialize a key. More... | |
void | fsdk::ISettingsProvider::Key::setSection (const char *section) noexcept |
Set section name. More... | |
void | fsdk::ISettingsProvider::Key::setParameter (const char *parameter) noexcept |
Set parameter name. More... | |
bool | fsdk::ISettingsProvider::Key::operator< (const ISettingsProvider::Key &other) const noexcept |
Operator Less . More... | |
fsdk::ISettingsProvider::Desc::Desc () noexcept | |
Initialize an empty description. | |
fsdk::ISettingsProvider::Desc::Desc (const char *desc) noexcept | |
Initialize a description. More... | |
void | fsdk::ISettingsProvider::Desc::setDesc (const char *desc) noexcept |
Set description text. More... | |
fsdk::ISettingsProvider::Entry::Entry (const Desc &desc, Value &&value) noexcept | |
Initialize an entry. More... | |
void | fsdk::ISettingsProvider::Entry::setDesc (const Desc &desc) noexcept |
Set description. More... | |
void | fsdk::ISettingsProvider::Entry::setValue (Value &&value) noexcept |
Set value. More... | |
Common interfaces and macros shared across all SDK objects.
#define ALIGN_UP | ( | value, | |
align | |||
) |
|
inlinenoexcept |
Initialize a description.
desc | description text. |
Initialize an entry.
desc | description. |
value | value. |
|
inlinenoexcept |
Initialize a key.
section | section name. |
parameter | parameter name. |
|
noexcept |
Makes License activation with some platform specific manner. Network connection is required.
license | pointer to the license object which should be activated |
configPath | path to license.conf file with licensing settings. |
|
inlinenoexcept |
Safely get a boolean.
If actual value type is convertible to bool, the value is returned; if not a fallback value is returned.
defaultValue | fallback value (optional). |
|
inlinenoexcept |
Safely get a float.
If actual value type is float, the value is returned; if not a fallback value is returned.
defaultValue | fallback value (optional). |
|
inlinenoexcept |
Safely get an integer.
If actual value type is Int, the value is returned; if not a fallback value is returned.
defaultValue | fallback value (optional). |
|
inlinenoexcept |
Safely get a Point2f.
If actual value type is convertible to Point2f, the value is returned; if not a fallback value is returned.
defaultValue | fallback value (optional). |
|
inlinenoexcept |
Safely get a Point2i.
If actual value type is convertible to Point2i, the value is returned; if not a fallback value is returned.
defaultValue | fallback value (optional). |
Safely get a Rect.
If actual value type is convertible to Rect, the value is returned; if not a fallback value is returned.
defaultValue | fallback value (optional). |
Safely get a Size.
If actual value type is convertible to Size, the value is returned; if not a fallback value is returned.
defaultValue | fallback value (optional). |
|
inlinenoexcept |
Safely get a string.
If actual value type is String, the value is returned; if not a fallback value is returned.
defaultValue | fallback value (optional). |
|
pure virtualnoexcept |
Creates AGS estimator.
|
pure virtualnoexcept |
Creates BestShotQuality estimator.
|
pure virtualnoexcept |
Creates Descriptor.
face descriptor will created by default, to create human descriptor pass version, minimum version of human descriptor is DV_MIN_HUMAN_DESCRIPTOR_VERSION == 101
|
pure virtualnoexcept |
Creates and loads Descriptor from Archive.
archive | Archive with descriptor. |
flags | Archive flag. |
|
pure virtualnoexcept |
Creates Batch of descriptors.
face descriptor batch will be created by default, to create human descriptor batch you must pass version, minimum version of human descriptor is DV_MIN_HUMAN_DESCRIPTOR_VERSION == 101
[in] | size | - amount of descriptors in batch. |
[in] | version | - descriptor version in batch. If 0 - use dafault version from config. |
|
pure virtualnoexcept |
Creates a detector of given type.
|
pure virtualnoexcept |
Creates descriptor extractor.
face descriptor extractor will created by default, to create human descriptor extractor descriptor you must pass version, minimum version of human descriptor is DV_MIN_HUMAN_DESCRIPTOR_VERSION == 101
|
pure virtualnoexcept |
Creates Eye estimator.
|
noexcept |
Create the LUNA SDK root object.
[in] | dataPath | [optional] path to folder with FSDK data. Default: ./data (on windows), /opt/visionlabs/data (on linux) |
[in] | configPath | [optional] path to faceengine.conf file. Default: <dataPath>/faceengine.cong |
[in] | runtimePath | [optional] path to runtime.conf file. Default: <dataPath>/runtime.cong |
|
pure virtualnoexcept |
Creates Head pose estimator.
|
pure virtualnoexcept |
Creates descriptor matcher.
face descriptor matcher will created by default, to create human descriptor matcher you must pass version, minimum version of human descriptor is DV_MIN_HUMAN_DESCRIPTOR_VERSION == 101
|
noexcept |
Create a settings provider.
[in] | path | configuration file path. |
|
pure virtualnoexcept |
Creates warper.
|
inlinenoexcept |
Get a bool value.
[out] | x | the value. |
x
isn't modified.
|
pure virtualnoexcept |
Gets data directory.
By default is set to "./data".
|
pure virtualnoexcept |
Get LUNA SDK ditribution edition.
|
inlinenoexcept |
Get a float value.
[out] | x | the value. |
|
inlinenoexcept |
Get a 2d float value.
[out] | x | 1st value. |
[out] | y | 2nd value. |
|
inlinenoexcept |
Get a 3d float value.
[out] | x | 1st value. |
[out] | y | 2nd value. |
[out] | z | 3rd value. |
|
inlinenoexcept |
Get a 4d float value.
[out] | x | 1st value. |
[out] | y | 2nd value. |
[out] | z | 3rd value. |
[out] | w | 4th value. |
|
inlinenoexcept |
Get an int value.
[out] | x | the value. |
x
isn't modified.
|
inlinenoexcept |
Get a 2d int value.
[out] | x | 1st value. |
[out] | y | 2nd value. |
|
inlinenoexcept |
Get a 3d int value.
[out] | x | 1st value. |
[out] | y | 2nd value. |
[out] | z | 3rd value. |
|
inlinenoexcept |
Get a 4d int value.
[out] | x | 1st value. |
[out] | y | 2nd value. |
[out] | z | 3rd value. |
[out] | w | 4th value. |
|
pure virtualnoexcept |
Get current License object, which was set for FaceEngine object.
|
inlinenoexcept |
Get a Point2f value.
[out] | point | the value. |
point
isn't modified.
|
inlinenoexcept |
Get a Point2i value.
[out] | point | the value. |
point
isn't modified.
|
inlinenoexcept |
Get a rect value.
[out] | rect | the value. |
rect
isn't modified.
|
pure virtualnoexcept |
Gets runtime settings provider.
|
pure virtualnoexcept |
Gets settings provider.
|
inlinenoexcept |
Get a size value.
[out] | size | the value. |
size
isn't modified.
|
inlinenoexcept |
Get a string value.
[out] | string | the value. |
string
isn't modified.
|
inlinenoexcept |
Operator Less
.
other | other key. |
|
inlinenoexcept |
Set a bool value.
x | the value. |
|
pure virtualnoexcept |
Sets data directory.
[in] | path | path to data directory. |
|
inlinenoexcept |
Set description text.
desc | description text. |
|
inlinenoexcept |
Set description.
desc | description. |
|
inlinenoexcept |
Set a float value.
x | the value. |
|
inlinenoexcept |
Set a 2d float value.
x | 1st value. |
y | 2nd value. |
|
inlinenoexcept |
Set a 3d float value.
x | 1st value. |
y | 2nd value. |
z | 3rd value. |
|
inlinenoexcept |
Set a 4d float value.
x | 1st value. |
y | 2nd value. |
z | 3rd value. |
w | 4th value. |
|
inlinenoexcept |
Set an int value.
x | the value. |
|
inlinenoexcept |
Set a 2d int value.
x | 1st value. |
y | 2nd value. |
|
inlinenoexcept |
Set a 3d int value.
x | 1st value. |
y | 2nd value. |
z | 3rd value. |
|
inlinenoexcept |
Set a 4d int value.
x | 1st value. |
y | 2nd value. |
z | 3rd value. |
w | 4th value. |
|
inlinenoexcept |
Set parameter name.
parameter | parameter name. |
|
inlinenoexcept |
Set a setPoint2f value.
point | the value. |
|
inlinenoexcept |
Set a Point2i value.
point | the value. |
|
inlinenoexcept |
Set a rect value.
rect | the value. |
|
pure virtualnoexcept |
Sets runtime settings provider.
[in] | provider | runtime settings provider. |
|
inlinenoexcept |
Set section name.
section | section name. |
|
pure virtualnoexcept |
Sets settings provider.
[in] | provider | settings provider. |
|
inlinenoexcept |
Set a size value.
size | the value. |
|
inlinenoexcept |
Set a string value.
string | the value. |
|
inlinenoexcept |
Set value.
value | value. |