digiKam
Loading...
Searching...
No Matches
Digikam::FacePipelineFaceTagsIface Class Reference

#include <facepipelinepackage.h>

+ Inheritance diagram for Digikam::FacePipelineFaceTagsIface:

Public Types

enum  Role {
  NoRole = 0 , GivenAsArgument = 1 << 0 , ReadFromDatabase = 1 << 1 , DetectedFromImage = 1 << 2 ,
  ForRecognition = 1 << 10 , ForConfirmation = 1 << 11 , ForTraining = 1 << 12 , ForEditing = 1 << 13 ,
  Confirmed = 1 << 20 , Trained = 1 << 21 , Edited = 1 << 22
}
 
enum  Type {
  InvalidFace = 0 , UnknownName = 1 << 0 , UnconfirmedName = 1 << 1 , IgnoredName = 1 << 2 ,
  ConfirmedName = 1 << 3 , FaceForTraining = 1 << 4 , UnconfirmedTypes = UnknownName | UnconfirmedName , NormalFaces = UnknownName | UnconfirmedName | IgnoredName | ConfirmedName ,
  AllTypes = UnknownName | UnconfirmedName | IgnoredName | ConfirmedName | FaceForTraining , TypeFirst = UnknownName , TypeLast = FaceForTraining
}
 

Public Member Functions

 FacePipelineFaceTagsIface ()=default
 
 FacePipelineFaceTagsIface (const FaceTagsIface &face)
 
QString getAutodetectedPersonString () const
 
const QString hash () const
 
qlonglong imageId () const
 
bool isConfirmedName () const
 
bool isForTraining () const
 
bool isIgnoredName () const
 
bool isInvalidFace () const
 
bool isNull () const
 
bool isUnconfirmedName () const
 
bool isUnconfirmedType () const
 
bool isUnknownName () const
 
FacePipelineFaceTagsIfaceoperator= (const FacePipelineFaceTagsIface &other)
 
bool operator== (const FaceTagsIface &other) const
 
TagRegion region () const
 
void removeFaceTraining () const
 
void setRegion (const TagRegion &region)
 
void setTagId (int tagId)
 
void setType (Type type)
 
int tagId () const
 
QVariant toVariant () const
 
Type type () const
 
 ~FacePipelineFaceTagsIface ()=default
 

Static Public Member Functions

static QString attributeForType (Type type)
 
static QStringList attributesForFlags (TypeFlags flags)
 
static FaceTagsIface fromListing (qlonglong imageid, const QList< QVariant > &values)
 
static FaceTagsIface fromVariant (const QVariant &var)
 
static Type typeForAttribute (const QString &attribute, int tagId=0)
 
static Type typeForId (int tagId)
 

Public Attributes

TagRegion assignedRegion
 
int assignedTagId = 0
 
Roles roles = NoRole
 

Protected Attributes

qlonglong m_imageId = 0
 
TagRegion m_region
 
int m_tagId = 0
 
Type m_type = InvalidFace
 

Member Enumeration Documentation

◆ Role

Enumerator
NoRole 
GivenAsArgument 

Source.

ReadFromDatabase 
DetectedFromImage 
ForRecognition 

Task.

ForConfirmation 
ForTraining 
ForEditing 
Confirmed 

Executed action (task is cleared).

Trained 
Edited 

◆ Type

Enumerator
InvalidFace 
UnknownName 
UnconfirmedName 
IgnoredName 
ConfirmedName 
FaceForTraining 
UnconfirmedTypes 
NormalFaces 
AllTypes 
TypeFirst 
TypeLast 

Constructor & Destructor Documentation

◆ FacePipelineFaceTagsIface() [1/2]

Digikam::FacePipelineFaceTagsIface::FacePipelineFaceTagsIface ( )
default

◆ FacePipelineFaceTagsIface() [2/2]

Digikam::FacePipelineFaceTagsIface::FacePipelineFaceTagsIface ( const FaceTagsIface face)
explicit

◆ ~FacePipelineFaceTagsIface()

Digikam::FacePipelineFaceTagsIface::~FacePipelineFaceTagsIface ( )
default

Member Function Documentation

◆ attributeForType()

◆ attributesForFlags()

◆ fromListing()

FaceTagsIface Digikam::FaceTagsIface::fromListing ( qlonglong  imageid,
const QList< QVariant > &  values 
)
staticinherited

◆ fromVariant()

FaceTagsIface Digikam::FaceTagsIface::fromVariant ( const QVariant &  var)
staticinherited

◆ getAutodetectedPersonString()

◆ hash()

const QString Digikam::FaceTagsIface::hash ( ) const
inherited

Generate a hash based on the imageId, tagId, and rect to uniquely identify this entry in the face training DB.

References Digikam::FaceTagsIface::m_imageId, Digikam::FaceTagsIface::m_region, Digikam::FaceTagsIface::m_tagId, and Digikam::TagRegion::toXml().

Referenced by Digikam::FaceTagsIface::removeFaceTraining().

◆ imageId()

◆ isConfirmedName()

◆ isForTraining()

bool Digikam::FaceTagsIface::isForTraining ( ) const
inlineinherited

◆ isIgnoredName()

bool Digikam::FaceTagsIface::isIgnoredName ( ) const
inlineinherited

◆ isInvalidFace()

bool Digikam::FaceTagsIface::isInvalidFace ( ) const
inlineinherited

◆ isNull()

◆ isUnconfirmedName()

bool Digikam::FaceTagsIface::isUnconfirmedName ( ) const
inlineinherited

◆ isUnconfirmedType()

bool Digikam::FaceTagsIface::isUnconfirmedType ( ) const
inlineinherited

◆ isUnknownName()

bool Digikam::FaceTagsIface::isUnknownName ( ) const
inlineinherited

◆ operator=()

◆ operator==()

bool Digikam::FaceTagsIface::operator== ( const FaceTagsIface other) const
inherited

◆ region()

◆ removeFaceTraining()

void Digikam::FaceTagsIface::removeFaceTraining ( ) const
inherited

Remove the face from face training based on the current imageId, tagId, and rect hash.

References Digikam::FaceTagsIface::ConfirmedName, Digikam::FaceTagsIface::hash(), Digikam::FaceTagsIface::m_type, and Digikam::RecognitionTrainingUpdateQueue::push().

Referenced by Digikam::FaceTagsEditor::removeFaceAndTag().

◆ setRegion()

void Digikam::FaceTagsIface::setRegion ( const TagRegion region)
inherited

◆ setTagId()

void Digikam::FaceTagsIface::setTagId ( int  tagId)
inherited

◆ setType()

void Digikam::FaceTagsIface::setType ( Type  type)
inherited

◆ tagId()

◆ toVariant()

◆ type()

◆ typeForAttribute()

◆ typeForId()

Member Data Documentation

◆ assignedRegion

◆ assignedTagId

◆ m_imageId

◆ m_region

◆ m_tagId

◆ m_type

◆ roles


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