PFaceLog6Parameters Class Reference

Detailed Description

Configuration class for PFaceLog6.

Definition at line 82 of file PFaceLog6Parameters.h.

#include <PFaceLog6Parameters.h>

Constructor & Destructor Documentation

◆ PFaceLog6Parameters() [1/2]

PFaceLog6Parameters::PFaceLog6Parameters ( const papillon::PString &  parametersPrefix = papillon::PString())
inline

Constructs a default set of parameters for FaceLog6.

Definition at line 89 of file PFaceLog6Parameters.h.

◆ PFaceLog6Parameters() [2/2]

PFaceLog6Parameters::PFaceLog6Parameters ( const papillon::PProperties &  properties,
const papillon::PString &  parametersPrefix 
)
inline

Constructs an parameters with prefix.

Definition at line 96 of file PFaceLog6Parameters.h.

◆ ~PFaceLog6Parameters()

virtual PFaceLog6Parameters::~PFaceLog6Parameters ( )
inlinevirtual

Destroys this object.

Definition at line 103 of file PFaceLog6Parameters.h.

Member Function Documentation

◆ BuildDefaultParameters()

static PFaceLog6Parameters PFaceLog6Parameters::BuildDefaultParameters ( const papillon::PString &  parametersPrefix = papillon::PString())
inlinestatic

DEPRECATED: Builds default set of parameters.

Use default constructor instead.

Definition at line 109 of file PFaceLog6Parameters.h.

◆ FromAnalytics()

static PFaceLog6Parameters PFaceLog6Parameters::FromAnalytics ( const papillon::PAnalytics &  analytics)
inlinestatic

Retrieves parameters from a FaceLog6 analytics instance.

If the specified analytics is not a FaceLog6 analytics, then returned parameters will be an empty container.

Definition at line 119 of file PFaceLog6Parameters.h.

◆ GetFaceDetector()

papillon::PString PFaceLog6Parameters::GetFaceDetector ( ) const
inline

Get the name of the face-detector we are using.

Definition at line 147 of file PFaceLog6Parameters.h.

◆ GetFaceDetectorGpuId()

papillon::int32 PFaceLog6Parameters::GetFaceDetectorGpuId ( ) const
inline

Returns the minimum detection size in pixels for a face (face detector parameter) or -1 if this parameter is not.

Definition at line 163 of file PFaceLog6Parameters.h.

◆ GetFaceDetectorParametersPrefix()

static papillon::PString PFaceLog6Parameters::GetFaceDetectorParametersPrefix ( )
inlinestatic

Definition at line 131 of file PFaceLog6Parameters.h.

◆ GetFaceDetectorThreshold()

double PFaceLog6Parameters::GetFaceDetectorThreshold ( ) const
inline

Returns the threshold parameter for the face detector.

Definition at line 215 of file PFaceLog6Parameters.h.

◆ GetFaceRecognition()

bool PFaceLog6Parameters::GetFaceRecognition ( ) const
inline

Returns status on whether face-recognition is being performed.

Definition at line 299 of file PFaceLog6Parameters.h.

◆ GetFaceRecognitionModel()

papillon::PString PFaceLog6Parameters::GetFaceRecognitionModel ( ) const
inline

Returns status on whether face-recognition is being performed.

Definition at line 313 of file PFaceLog6Parameters.h.

◆ GetGenderDetection()

bool PFaceLog6Parameters::GetGenderDetection ( ) const
inline

Returns status on whether gender detection is being performed.

Definition at line 271 of file PFaceLog6Parameters.h.

◆ GetGenderDetectionThreshold()

float PFaceLog6Parameters::GetGenderDetectionThreshold ( ) const
inline

Returns threshold to use for gender-detector.

Definition at line 285 of file PFaceLog6Parameters.h.

◆ GetGpuId()

papillon::int32 PFaceLog6Parameters::GetGpuId ( ) const
inline

Returns the GPU used for the meta-classifiers and face-recognition describers.

Definition at line 471 of file PFaceLog6Parameters.h.

◆ GetMaskDetection()

bool PFaceLog6Parameters::GetMaskDetection ( ) const
inline

Returns status on whether mask-detection is being performed.

Definition at line 243 of file PFaceLog6Parameters.h.

◆ GetMaskDetectionThreshold()

float PFaceLog6Parameters::GetMaskDetectionThreshold ( ) const
inline

Returns threshold to use for mask-detector.

Definition at line 257 of file PFaceLog6Parameters.h.

◆ GetMaxDetectionSize()

papillon::int32 PFaceLog6Parameters::GetMaxDetectionSize ( ) const
inline

Returns the maximum detection size in pixels for a face (face detector parameter) or -1 if this parameter is not available.

Definition at line 198 of file PFaceLog6Parameters.h.

◆ GetMaxFaceDetectorFR()

double PFaceLog6Parameters::GetMaxFaceDetectorFR ( ) const
inline

Returns the Maximum Face Detector FR parameter.

Definition at line 455 of file PFaceLog6Parameters.h.

◆ GetMaxGap()

papillon::int32 PFaceLog6Parameters::GetMaxGap ( ) const
inline

Returns maximum number of frames in with no detections to stop track (-1 - is error)

Definition at line 420 of file PFaceLog6Parameters.h.

◆ GetMaxLength()

papillon::int32 PFaceLog6Parameters::GetMaxLength ( ) const
inline

Returns the mmaximum number of detections allowed in a single sighting.

Definition at line 388 of file PFaceLog6Parameters.h.

◆ GetMinDetectionSize()

papillon::int32 PFaceLog6Parameters::GetMinDetectionSize ( ) const
inline

Returns the minimum detection size in pixels for a face (face detector parameter).

Definition at line 180 of file PFaceLog6Parameters.h.

◆ GetMinLength()

papillon::int32 PFaceLog6Parameters::GetMinLength ( ) const
inline

Returns the minimum number of detections required to create sighting event.

Definition at line 404 of file PFaceLog6Parameters.h.

◆ GetParametersPrefix()

const papillon::PString& PFaceLog6Parameters::GetParametersPrefix ( ) const
inline

Definition at line 477 of file PFaceLog6Parameters.h.

◆ GetRoi()

papillon::PRectanglei PFaceLog6Parameters::GetRoi ( ) const
inline

Returns region of interest.

Definition at line 229 of file PFaceLog6Parameters.h.

◆ GetSightingSimilarity()

double PFaceLog6Parameters::GetSightingSimilarity ( ) const
inline

Deprecated: Returns the recognition threshold parameter to use when considering to join two tracks together or NaN if this parameter is not available.

Definition at line 438 of file PFaceLog6Parameters.h.

◆ GetTracker()

PString PFaceLog6Parameters::GetTracker ( ) const
inline

Returns the name of the tracker that is currently being used.

Definition at line 357 of file PFaceLog6Parameters.h.

◆ GetTrackerThreshold()

float PFaceLog6Parameters::GetTrackerThreshold ( ) const
inline

Returns threshold to use for tracker.

Definition at line 371 of file PFaceLog6Parameters.h.

◆ GetWatchlist()

papillon::PWatchlist PFaceLog6Parameters::GetWatchlist ( ) const
inline

Returns the watchlist parameters or an empty watchlist if this parameter is not available.

Definition at line 327 of file PFaceLog6Parameters.h.

◆ GetWatchlistOptions()

papillon::PWatchlistOptions PFaceLog6Parameters::GetWatchlistOptions ( ) const
inline

Returns the watchlist options parameters or a default PWatchlistOption object if this parameter is not available.

Definition at line 343 of file PFaceLog6Parameters.h.

◆ SetFaceDetector()

void PFaceLog6Parameters::SetFaceDetector ( papillon::PString &  faceDetector)
inline

Set the face-detector we are using by product name, e.g.

FaceDetector6 or FaceDetector5

Definition at line 140 of file PFaceLog6Parameters.h.

◆ SetFaceDetectorGpuId()

void PFaceLog6Parameters::SetFaceDetectorGpuId ( papillon::int32  faceDetectorGpuId)
inline

Set the GPU-ID for the face-detector to use.

Definition at line 156 of file PFaceLog6Parameters.h.

◆ SetFaceDetectorThreshold()

void PFaceLog6Parameters::SetFaceDetectorThreshold ( double  faceDetectorThreshold)
inline

Sets the face detector threshold.

If a face has been detected with a score smaller than this threshold, then this face is rejected.

Definition at line 208 of file PFaceLog6Parameters.h.

◆ SetFaceRecognition()

void PFaceLog6Parameters::SetFaceRecognition ( bool  faceRecognition)
inline

Perform face-recognition when running FaceLog6.

Definition at line 294 of file PFaceLog6Parameters.h.

◆ SetFaceRecognitionModel()

void PFaceLog6Parameters::SetFaceRecognitionModel ( const papillon::PString &  faceRecognitionModel)
inline

Perform face-recognition when running FaceLog6.

Definition at line 308 of file PFaceLog6Parameters.h.

◆ SetGenderDetection()

void PFaceLog6Parameters::SetGenderDetection ( bool  genderDetection)
inline

Perform gender-detection when running FaceLog6.

Definition at line 266 of file PFaceLog6Parameters.h.

◆ SetGenderDetectionThreshold()

void PFaceLog6Parameters::SetGenderDetectionThreshold ( float  genderDetectionThreshold)
inline

Set threshold to use for gender-detector.

Definition at line 280 of file PFaceLog6Parameters.h.

◆ SetGpuId()

void PFaceLog6Parameters::SetGpuId ( papillon::int32  gpuId)
inline

Sets the GPU to use for the meta-classifiers and face-recognition describers.

Definition at line 464 of file PFaceLog6Parameters.h.

◆ SetMaskDetection()

void PFaceLog6Parameters::SetMaskDetection ( bool  maskDetection)
inline

Perform mask-detection when running FaceLog6.

Definition at line 238 of file PFaceLog6Parameters.h.

◆ SetMaskDetectionThreshold()

void PFaceLog6Parameters::SetMaskDetectionThreshold ( float  maskDetectionThreshold)
inline

Set threshold to use for mask-detector.

Definition at line 252 of file PFaceLog6Parameters.h.

◆ SetMaxDetectionSize()

void PFaceLog6Parameters::SetMaxDetectionSize ( papillon::int32  maxDetectionSize)
inline

Sets the maximum detection size in pixels for a face (face detector parameter).

Faces with a width greater than this value won't be detected.

Definition at line 190 of file PFaceLog6Parameters.h.

◆ SetMaxFaceDetectorFR()

void PFaceLog6Parameters::SetMaxFaceDetectorFR ( double  frameRate)
inline

Sets the Maximum Face Detector FR: maximum rate for feeding frames to the face detector.

Right value is 8 for a live stream (8 frames per second). If you want to process a video file (offline processing), you should use -1 to avoid skipping frames. For live camera streams we recommend a minimum of 8 frames-per-second.

Definition at line 450 of file PFaceLog6Parameters.h.

◆ SetMaxGap()

void PFaceLog6Parameters::SetMaxGap ( papillon::int32  v)
inline

Sets maximum number of frames in with no detections to stop track.

Definition at line 413 of file PFaceLog6Parameters.h.

◆ SetMaxLength()

void PFaceLog6Parameters::SetMaxLength ( papillon::int32  maxLength)
inline

Sets the maximum number of detections in sightings for it to be reported.

Definition at line 381 of file PFaceLog6Parameters.h.

◆ SetMinDetectionSize()

void PFaceLog6Parameters::SetMinDetectionSize ( papillon::int32  minDetectionSize)
inline

Sets the minimum detection size in pixels for a face (face detector parameter).

Faces with a width smaller than this value won't be detected.

Definition at line 173 of file PFaceLog6Parameters.h.

◆ SetMinLength()

void PFaceLog6Parameters::SetMinLength ( papillon::int32  minLength)
inline

Sets the minimum number of detections for a sighting event to be raised.

Definition at line 397 of file PFaceLog6Parameters.h.

◆ SetRoi()

void PFaceLog6Parameters::SetRoi ( const papillon::PRectanglei &  roi)
inline

Sets region of interest.

Definition at line 224 of file PFaceLog6Parameters.h.

◆ SetSightingSimilarity()

void PFaceLog6Parameters::SetSightingSimilarity ( double  threshold)
inline

Deprecated: Sets the recognition threshold to use when considering to join two tracks together.

Definition at line 431 of file PFaceLog6Parameters.h.

◆ SetTracker()

void PFaceLog6Parameters::SetTracker ( const PString tracker)
inline

Set tracker to use.

Advanced use only!

Definition at line 352 of file PFaceLog6Parameters.h.

◆ SetTrackerThreshold()

void PFaceLog6Parameters::SetTrackerThreshold ( float  trackerThreshold)
inline

Set threshold to use for tracker.

Definition at line 366 of file PFaceLog6Parameters.h.

◆ SetWatchlist()

void PFaceLog6Parameters::SetWatchlist ( const papillon::PWatchlist &  watchlist)
inline

Sets the watchlist of identities.

If not present no face-rec performed.

Definition at line 322 of file PFaceLog6Parameters.h.

◆ SetWatchlistOptions()

void PFaceLog6Parameters::SetWatchlistOptions ( const papillon::PWatchlistOptions &  watchlistOptions)
inline

Sets the watchlist options.

This includes the threshold to use when performing face-rec.

Definition at line 336 of file PFaceLog6Parameters.h.

Member Data Documentation

◆ m_parametersPrefix

papillon::PString PFaceLog6Parameters::m_parametersPrefix
protected

Definition at line 480 of file PFaceLog6Parameters.h.