PDetector.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 <PPluginInstance.h>
#include <PProperties.h>

PAPILLON_BEGIN_NAMESPACE

class PDetection;
class PDetectionList;
class PFrame;
class PPlugin;
class PRectanglei;
class PSizei;


class PAPILLON_API_CORE PDetector : public PPluginInstance {
 public:
    static const PString C_PARAM_FLOAT_THRESHOLD;           
    static const PString C_PARAM_RECTI_REGION_OF_INTEREST;  
    static const PString C_PARAM_SIZEI_MIN_DETECTION_SIZE;  
    static const PString C_PARAM_SIZEI_MAX_DETECTION_SIZE;  
    static const PString C_PARAM_INT32_MAX_DETECTIONS;      
    static const PString C_PARAM_BOOL_LOCALISER;            
    static const PString C_PARAM_DETECTOR_LOCALISER;        

 public:
    static PResult Create(const PString& productName, const PProperties& parameters, PDetector& detector);

    static PResult Create(const PPlugin& plugin, const PProperties& parameters, PDetector& detector);

    static PResult Create(const PString& productName, const PProperties& parameters, const PString& parametersPrefix, PDetector& detector);

    static PResult Create(const PPlugin& plugin, const PProperties& parameters, const PString& parametersPrefix, PDetector& detector);

    PDetector();

    PDetector(const PDetector& other);

    virtual ~PDetector();

    PDetector& operator=(const PDetector& other);

    PResult Detect(const PFrame& frame, PDetectionList& detectionList) const;

    PResult Detect(const PFrame&      frame,
                   const PProperties& parameters,
                   const PString&     parametersPrefix,
                   PDetectionList&    detectionList) const;

    PResult Localise(PDetectionList& detectionList) const;

    PResult SetThreshold(float threshold);

    float GetThreshold() const;

    PResult SetRegionOfInterest(const PRectanglei& roi);

    PRectanglei GetRegionOfInterest() const;

    PResult SetMinDetectionSize(const papillon::int32 minDetectionSize);

    PResult SetMinDetectionSize(const PSizei& minDetectionSize);

    PSizei GetMinDetectionSize() const;

    PResult SetMaxDetectionSize(const papillon::int32 maxDetectionSize);

    PResult SetMaxDetectionSize(const PSizei& maxDetectionSize);

    PSizei GetMaxDetectionSize() const;

    PResult SetMaxDetections(papillon::int32 maxDetections);

    papillon::int32 GetMaxDetections() const;

    PResult EnableLocaliser(bool enabled);

    bool IsLocaliserEnabled() const;

    PResult SetLocaliser(const PString& localiserName = PString());

    PResult SetLocaliser(const PDetector& localiser);

    PDetector GetLocaliser() const;
};


PAPILLON_END_NAMESPACE