PAnalytics Class Reference

Detailed Description

The PAnalytics class is the parent class for all video analytics algorithms which analyse a video stream and return a list of events (PEvent); typical instances are a face logger.

Definition at line 38 of file PAnalytics.h.

#include <PAnalytics.h>

Constructor & Destructor Documentation

◆ PAnalytics() [1/2]

PAnalytics::PAnalytics ( )

Construct an empty analytics; use PAnalytics::Create() factory to instantiate an analytics.

◆ PAnalytics() [2/2]

PAnalytics::PAnalytics ( const PAnalytics other)

Constructs a shared copy of other.

◆ ~PAnalytics()

virtual PAnalytics::~PAnalytics ( )
virtual

Destroys this object.

Member Function Documentation

◆ Apply()

PResult PAnalytics::Apply ( const PFrame frame,
PList events 
) const

Applies this analytics to the specified frame and returns a list of events.

Returns PResult::C_OK if success, another result otherwise.

◆ Create() [1/2]

static PResult PAnalytics::Create ( const PString productName,
const PProperties parameters,
PAnalytics analytics 
)
static

Factory: creates a PAnalytics from the specified plugin and parameters (factory).

Returns PResult::C_OK if success, another result otherwise.

◆ Create() [2/2]

static PResult PAnalytics::Create ( const PPlugin plugin,
const PProperties parameters,
PAnalytics analytics 
)
static

Factory: creates a PAnalytics from the specified plugin and parameters (factory).

Returns PResult::C_OK if success, another result otherwise.

◆ DrawOSD()

PResult PAnalytics::DrawOSD ( PImage image) const

Draws OSD (On-Screen-Display) on top of the specified image.

The image should be the same that the original one passed to Apply(). This method is optional; it might not be available. Returns PResult::C_OK if success, another result otherwise.

◆ Finish()

PResult PAnalytics::Finish ( PList events) const

Finishes the analytics and releases any stored events.

Returns PResult::C_OK if success, another result otherwise.

◆ GetMinimumInputResolution()

PSizei PAnalytics::GetMinimumInputResolution ( ) const

Returns minimum input resolution required by analytics to perform correctly.

◆ operator=()

PAnalytics& PAnalytics::operator= ( const PAnalytics other)

Performs a shared copy of other to this object.