PFaceMetaData.h

Go to the documentation of this file.

/*
 * Copyright (C) 2015-2018 Digital Barriers plc. All rights reserved.
 * Contact: http://www.digitalbarriers.com/
 *
 * This file is part of the Papillon SDK.
 *
 * You can't use, modify or distribute any part of this file without
 * the explicit written agreements of Digital Barriers.
 */

#pragma once
#include <PClassifierInfo.h>
#include <PObject.h>
#include <PVector.h>

PAPILLON_BEGIN_NAMESPACE

class PDescription;

class PAPILLON_API_CORE PFaceMetaData : public PObject {
 public:
    enum
        PAPILLON_DEPRECATED("This functionality will be removed in Papillon 5")
        EGenderType { E_GENDER_UNKNOWN = -1, E_GENDER_FEMALE = 0, E_GENDER_MALE = 1 };

    PFaceMetaData();

    PAPILLON_SUPPRESS_DEPRECATED_START
    PAPILLON_DEPRECATED("Use PFaceMetaData::SetClassification. This functionality will be removed in Papillon 5")
    PFaceMetaData(EGenderType gender, double genderConfidence);
    PAPILLON_SUPPRESS_DEPRECATED_END

    PFaceMetaData(const PFaceMetaData& other);

    static PFaceMetaData FromDescription(const PDescription& description);

    ~PFaceMetaData() override;

    PFaceMetaData& operator=(const PFaceMetaData& other);

    bool operator==(const PFaceMetaData& other) const;

    void SetClassification(const PString&         classificationName,
                           const PClassifierInfo& classifierInfo,
                           const PFloatVector&    classificationVector,
                           int32                  classIndex = -2,
                           float                  confidence = 0.f);
    void SetClassification(const PString&         classificationName,
                           const PClassifierInfo& classifierInfo,
                           int32                  classIndex,
                           float                  confidence);

    PResult DeleteClassification(const PString& classificationName);

    PStringList GetClassificationNames() const;

    PResult GetClassifierInfo(const PString& classificationName, PClassifierInfo& classifierInfo) const;

    PResult GetClassIndex(const PString& classificationName, int32& classIndex) const;

    PResult GetClassIndex(const PString& classificationName, int32& classIndex, float& confidence) const;

    PResult GetClassLabel(const PString& classificationName, PString& classLabel) const;

    PResult GetClassLabel(const PString& classificationName, PString& classLabel, float& confidence) const;

    PResult GetClassConfidence(const PString& classificationName, float& confidence) const;

    PResult GetClassificationVector(const PString& classificationName, PFloatVector& classificationVector) const;

    PAPILLON_SUPPRESS_DEPRECATED_START
    PAPILLON_DEPRECATED("Use PFaceMetaData::GetClassification. This functionality will be removed in Papillon 5")
    EGenderType GetGender() const;
    PAPILLON_SUPPRESS_DEPRECATED_END

    PAPILLON_DEPRECATED("Use PFaceMetaData::GetClassification. This functionality will be removed in Papillon 5")
    PString GetGenderAsString() const;

    PAPILLON_DEPRECATED("Use PFaceMetaData::GetClassification. This functionality will be removed in Papillon 5")
    double GetGenderConfidence() const;

    PAPILLON_DEPRECATED("This functionality will be removed in Papillon 5")
    PString ToStringOSD() const;

    PString ToJSON() const;
};

PAPILLON_END_NAMESPACE