Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]
| ►Nstd | STL namespace |
| CPAlarm | Toolbox to send alarms (text, images) by email |
| CPAlarmVerificationAnalytics | Performs alarm validation on an incoming video |
| CPAnalytics | 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 |
| CPapillonSDK | Global functions to initialise and finalise the Papillon SDK |
| CPBoxing | Generic container to box primitive data types, like int (PInt32), bool (PBool) or double (PDouble), so that they can be used as PObject; PBoxing instances are immutable (thread-safe) |
| CPByteArray | Resizable array of bytes |
| CPByteStream | Generic byte stream (can be a memory stream or a file stream) |
| CPByteStreamImpl | Common interface to all PByteStream |
| CPClassifierInfo | Holds information about classifier and designed for conversion between class indexes and class labels |
| CPColour3i | Red-Green-Blue color (RGB), each channel encoded with one 32-bit int |
| CPComparer | Algorithm used to compare two PDescription (typically two biometric templates) and return a PMatchScore |
| CPConcurrentQueue | Concurrent bounded queue of PObject, thread-safe |
| CPConcurrentRawBufferQueue | Concurrent bounded queue of raw buffers, thread-safe |
| CPConcurrentThread | Thread, a sequence of instructions that can be executed concurrently with other such sequences in multi-threading environments, while sharing a same address space |
| CPConfigurationFile | Friendly interface for handling .ini configuration files |
| CPDatabaseStore | PStore with a database backend (either SQLite or Postgres) (a container to store an heterogeneous collection of Papillon objects into a database) |
| CPDatabaseStoreIterator | Iterator over a PDatabaseStore container which allows to get stored objects |
| CPDate | Calendar date (year, month, and day numbers) in the Gregorian calendar; PDate instances are immutable (thread-safe) |
| CPDateTime | Date and time functions, including time-zone management and UTC conversions; PDateTime instances are immutable (thread-safe) |
| CPDescriber | Parent class for all describer algorithms which turns an object detected in an image coming from a detector (PDetector) into a description (PDescription); |
| CPDescriberInterface | PDescriberInterface is an interface you can use to implement your own PDescriber |
| CPDescription | Set of features that have been computed on an identity (it is a biometric template when it is used for Face Recognition) |
| CPDescriptionList | Nothing more than a collection of descriptions (PDescription), Typically PDescriptionList's are returned from a PDescriber |
| CPDescriptor | Single descriptor of an object, for example a feature vector, an image, or feature-points |
| CPDetection | Something that has been detected by a PDetector |
| CPDetectionList | Nothing more than a collection of detections (PDetection), Typically PDetectionList's are returned from a PDetector |
| CPDetector | Parent class for all detection algorithms which analyse an image or a video stream and return a list of detected objects (PDetectionList); typical instances are MotionDetector or FaceDetector |
| CPEnrollment | Helper class for face recognition, used to enroll people from a video or some images and save to a watchlist |
| CPEntity | Used to wrap any PObject and store it into a PStore (for example, a database) |
| CPEvent | Event detected by a video analytics algorithm (PAnalytics); NOT thread-safe |
| CPEventBuilder | Helper class used to build PEvent objects |
| CPExampleSet | Collection of PDetection's of the same identity (unknown or known); thread-safe |
| CPFaceLog6Parameters | Configuration class for PFaceLog6 |
| CPFaceMetaData | Meta-data information (for example, gender) about a face |
| CPFeatureMap | Collection of PFeaturePoint's or PFeatureRectangle's |
| CPFeaturePoint | Sub-pixel accurate 2D location on an image; PFeaturePoint instances are immutable (thread-safe) |
| CPFeatureRectangle | Sub-pixel accurate 2D area on an image; PFeatureRectangle instances are immutable (thread-safe) |
| CPFeverCamAnalytics | Analytics functions to process FeverCam images (change detection and black body localization) |
| CPFeverCamCalibration | Methods to associate images produced by DigitalBarriers FeverCam color and thermal camera heads |
| CPFeverCamProcessor | Main class for handling FeverCam processing for person temperature reading |
| CPFeverCamTemperatureCorrection | Human skin temperature correction function for feverCam readings |
| CPFeverCamTemperatureImagesHandler | FeverCam temperature images capture, processing and handling |
| CPFile | Helper class for file management |
| CPFileIO | Generic functions to read/write Papillon objects from/to binary files |
| CPFileStream | PByteStream whose backing store is a binary file |
| CPFileWatcher | Allows monitoring files for changes (listeners are notified each time the specified file is modified) |
| CPFrame | Any 2D-image (RGB, gray-scale, ...) with a container of additional data pertaining to that image |
| CPFrameToFrameTracker | Process that tracks, frame by frame, generic objects; not thread-safe |
| CPGPSLocation | GPS location; PGPSLocation instances are immutable (thread-safe) |
| CPGuid | Globally Unique Identifier (GUID); PGuid instances are immutable (thread-safe) |
| CPHttpRequest | Ease handling HTTP requests |
| CPHttpResponse | Used to ease processing HTTP responses |
| CPIAsynchronousWatchlistUpdater | The interface to implement to get an Asynchronous Updater used to be used with PWatchlist::SetAsynchonousUpdater() |
| CPIdentifyResult | Result returned by searching a PWatchlist |
| CPIdentifyResults | Collection of identification results (see PIdentifyResult) |
| CPImage | 2D-image; several pixel format and number of channels are supported (BGR, grey-scale, ...) |
| CPImageFilter | Image filter |
| CPInputVideoStream | Input video streams like a video file, a webcam or a RTSP stream; NOT thread-safe |
| CPKamCheckAnalytics | Three static methods for performing a KamCheck camera tampering analysis and one static method for obtaining a good reference image from a video clip |
| CPLicense | |
| CPLicensing | License manager (singleton) used to manage Papillon licenses for both Core and plugins; thread-safe |
| CPList | Generic container which handle an ordered collection of PObject; NOT thread-safe |
| CPLocation | |
| CPLog | Log system (singleton) used by Papillon; thread-safe |
| CPLogStream | Log stream used by log macros (should not be used directly, see P_LOG_INFO and related) |
| CPMap | Generic (templated) associative container; NOT thread-safe |
| CPMapIterator | Iterator on a PMap |
| CPMatchScore | Used to represent a score between two descriptions |
| CPMath | Toolbox to do some standard numeric operations (clamp, NaN handling, linear interpolation, random numbers...) |
| CPMemoryStream | Byte stream whose backing store is a PByteArray |
| CPMutex | Access serialization between threads |
| CPMutexLocker | Convenience class that simplifies locking and unlocking mutexes |
| CPObject | Root class of all Papillon classes; all PObject behaves like shared references |
| CPObjectMonitoring | Singleton used to monitor Papillon Core |
| CPObjectType | Type of object found in a video stream (can be Face, Person, Motion, etc); PObjectType instances are immutable (thread-safe) |
| CPOption | Command line parser |
| CPOutputVideoStream | Output video streams like a video file, a network socket or simply a screen display |
| CPPath | Helper class to get handle paths |
| CPPlugin | Papillon plugin (input video source, detector, describer, ...); thread-safe |
| CPPluginInstance | Super class for PAnalytics, PDetector, PDescriber which handle the data structure dynamically created by a Papillon plugin |
| CPPluginManager | Manager for all Papillon plugins (singleton); thread-safe |
| CPPoint2Df | 2D-point with float coordinates; PPoint2Df instances are immutable (thread-safe) |
| CPPoint2DfList | List of PPoint2Df |
| CPPoint2Di | 2D-point with 32-bit int coordinates; PPoint2Di instances are immutable (thread-safe) |
| CPPolygonf | 2D closed polygon with float coordinates |
| CPPolygoni | 2D closed polygon with 32-bit int coordinates |
| CPProcess | Toolbox to ease process spawning and management |
| CPProperties | Container of properties; each property has a name (PString) and a value which can be any Papillon object (PObject) |
| CPReadLocker | Convenience class that simplifies locking and unlocking read-write locks for read access |
| CPReadWriteLock | Access serialization between threads |
| CPRectanglef | Axis-aligned rectangle with float coordinates; PRectanglef instances are immutable (thread-safe) |
| CPRectanglei | Axis-aligned rectangle with 32-bit int coordinates; PRectanglei instances are immutable (thread-safe) |
| CPResult | Result returned by most of Papillon functions; this class is used to replace standard integer error code |
| CPRtti | |
| CPRunnable | Interface to inherit to get a task that will be executed by a concurrent thread |
| CPSearchList | Watchlist optimised for searching; for example, it is used Face Recognition to quickly find matches for a unknown face |
| CPSighting | |
| CPSingleInstance | Simple mechanism to check if several instances of the same application are running simultaneously |
| CPSizef | Size of an image or a rectangle: width (float) and height (float); PSizef instances are immutable (thread-safe) |
| CPSizei | Size of an image or a rectangle: width (int) and height (int); PSizei instances are immutable (thread-safe) |
| CPSocket | Network socket which relies on 0-MQ distributed messaging library; NOT thread-safe |
| CPSqlDatabase | Connection to a SQL database (typically SQLite3 or PostgreSQL) |
| CPSqlQuery | SQL query and can execute and manipulate SQL statements |
| CPStore | Interface to store an heterogeneous collection of PObject into a container (typically a database) |
| CPStoreEventListener | Interface to be notified when an event occurs on a PStore |
| CPStoreIterator | Iterator on a PStore container; can be used to get PObject stored on a database |
| CPString | Unicode character strings |
| CPStringList | List of PString; NOT thread-safe |
| CPSWatchlistSingleUpdate | A structure to hold all information related to a single change in the watchlist (add or remove one description) |
| CPSystemInfo | Helper class to determine capabilities (CPU, RAM, GPU) of the host system |
| CPTag | |
| CPTextFile | DEPRECATED, use PStringList::FromTextFile() instead; The PTextFile class can be used to read text file line by line; NOT thread-safe |
| CPTime | Clock time functions; PTime instances are immutable (thread-safe) |
| CPTimer | High precision chronometer (highest precision available on the host) |
| CPTrack | Track of object as face or person |
| CPUri | Unified Resource Identifier (URI), this class can also be used to handle URL; NOT thread-safe |
| CPUtils | Toolbox of common helper functions |
| CPVector | Dense numeric vector (templated) used for linear algebra; specialised versions are PIntVector, PFloatVector and PDoubleVector; NOT thread-safe |
| CPVerify | Face Recognition helper class which allows for easy verification/authentication of faces from descriptions, images and videos |
| CPVersion | Software version number: major.minor[.maintenance[.build]]; immutable, so thread-safe |
| CPVideoTools | Some helper functions to easily manipulate video files |
| CPWatchlist | Collection of PDescription typically used to detect a face from a list ok known people in Face Recognition; thread-safe |
| CPWatchlist2 | Collection of subjects/objects typically used to detect a face from a list ok known people in Face Recognition; thread-safe |
| CPWatchlistInfo | Additional data associated with a watchlist (do not contain biometric templates) |
| CPWatchlistOptions | Used for holding common watchlist options and determine how a specific PWatchlist is run |
| CPWriteLocker | Convenience class that simplifies locking and unlocking read-write locks for write access |