# dlib C++ Library - full_object_detection_abstract.h

    // Copyright (C) 2012  Davis E. King (davis@dlib.net)
    // License: Boost Software License   See LICENSE.txt for the full license.
    #undef DLIB_FULL_OBJECT_DeTECTION_ABSTRACT_Hh_
    #ifdef DLIB_FULL_OBJECT_DeTECTION_ABSTRACT_Hh_

    #include <vector>
    #include "../geometry.h"
    #include "../serialize.h"

    namespace dlib
    {

    // ----------------------------------------------------------------------------------------

        const static point OBJECT_PART_NOT_PRESENT(0x7FFFFFFF,
                                                   0x7FFFFFFF);

    // ----------------------------------------------------------------------------------------

        class full_object_detection
        {
            /*!
                WHAT THIS OBJECT REPRESENTS
                    This object represents the location of an object in an image along with the
                    positions of each of its constituent parts.
            !*/

        public:

            full_object_detection(
                const rectangle& rect,
                const std::vector<point>& parts
            );
            /*!
                ensures
                    - #get_rect() == rect
                    - #num_parts() == parts.size()
                    - for all valid i:
                        - part(i) == parts[i]
            !*/

            full_object_detection(
            );
            /*!
                ensures
                    - #get_rect().is_empty() == true
                    - #num_parts() == 0
            !*/

            explicit full_object_detection(
                const rectangle& rect
            );
            /*!
                ensures
                    - #get_rect() == rect
                    - #num_parts() == 0
            !*/

            const rectangle& get_rect(
            ) const;
            /*!
                ensures
                    - returns the rectangle that indicates where this object is.  In general,
                      this should be the bounding box for the object.
            !*/

            rectangle& get_rect(
            );
            /*!
                ensures
                    - returns the rectangle that indicates where this object is.  In general,
                      this should be the bounding box for the object.
            !*/

            unsigned long num_parts(
            ) const;
            /*!
                ensures
                    - returns the number of parts in this object.
            !*/

            const point& part(
                unsigned long idx
            ) const;
            /*!
                requires
                    - idx < num_parts()
                ensures
                    - returns the location of the center of the idx-th part of this object.
                      Note that it is valid for a part to be "not present".  This is indicated
                      when the return value of part() is equal to OBJECT_PART_NOT_PRESENT.
                      This is useful for modeling object parts that are not always observed.
            !*/

            point& part(
                unsigned long idx
            );
            /*!
                requires
                    - idx < num_parts()
                ensures
                    - returns the location of the center of the idx-th part of this object.
                      Note that it is valid for a part to be "not present".  This is indicated
                      when the return value of part() is equal to OBJECT_PART_NOT_PRESENT.
                      This is useful for modeling object parts that are not always observed.
            !*/

            bool operator==(
                const full_object_detection& rhs
            ) const;
            /*!
                ensures
                    - returns true if and only if *this and rhs have identical state.
            !*/
        };

    // ----------------------------------------------------------------------------------------

        void serialize (
            const full_object_detection& item,
            std::ostream& out
        );
        /*!
            provides serialization support
        !*/

        void deserialize (
            full_object_detection& item,
            std::istream& in
        );
        /*!
            provides deserialization support
        !*/

    // ----------------------------------------------------------------------------------------

        bool all_parts_in_rect (
            const full_object_detection& obj
        );
        /*!
            ensures
                - returns true if all the parts in obj are contained within obj.get_rect().
                  That is, returns true if and only if, for all valid i, the following is
                  always true:
                    obj.get_rect().contains(obj.part(i)) == true || obj.part(i) == OBJECT_PART_NOT_PRESENT
        !*/

    // ----------------------------------------------------------------------------------------
    // ----------------------------------------------------------------------------------------

        struct mmod_rect
        {
            /*!
                WHAT THIS OBJECT REPRESENTS
                    This is a simple struct that is used to give training data and receive detections
                    from the Max-Margin Object Detection loss layer loss_mmod_ object.
            !*/

            mmod_rect() = default;
            mmod_rect(const rectangle& r) : rect(r) {}
            mmod_rect(const rectangle& r, double score) : rect(r),detection_confidence(score) {}
            mmod_rect(const rectangle& r, double score, const std::string& label) : rect(r),detection_confidence(score),label(label) {}

            rectangle rect;
            double detection_confidence = 0;
            bool ignore = false;
            std::string label;

            operator rectangle() const { return rect; }

            bool operator == (const mmod_rect& rhs) const;
            /*!
                ensures
                    - returns true if and only if all the elements of this object compare equal
                      to the corresponding elements of rhs.
            !*/
        };

        mmod_rect ignored_mmod_rect(
            const rectangle& r
        );
        /*!
            ensures
                - returns a mmod_rect R such that:
                    - R.rect == r
                    - R.ignore == true
                    - R.detection_confidence == 0
                    - R.label == ""
        !*/

        void serialize(const mmod_rect& item, std::ostream& out);
        void deserialize(mmod_rect& item, std::istream& in);
        /*!
            provides serialization support
        !*/

    // ----------------------------------------------------------------------------------------

        struct yolo_rect
        {
            /*!
                WHAT THIS OBJECT REPRESENTS
                    This is a simple struct that is used to give training data and receive detections
                    from the YOLO Detection loss layer loss_yolo_ object.
            !*/

            yolo_rect() = default;
            yolo_rect(const drectangle& r) : rect(r) {}
            yolo_rect(const drectangle& r, double score) : rect(r),detection_confidence(score) {}
            yolo_rect(const drectangle& r, double score, const std::string& label) : rect(r),detection_confidence(score), label(label) {}
            yolo_rect(const mmod_rect& r) : rect(r.rect), detection_confidence(r.detection_confidence), ignore(r.ignore), label(r.label) {}

            drectangle rect;
            double detection_confidence = 0;
            bool ignore = false;
            std::string label;
            // YOLO detectors are multi label detectors: this field will contain all confidences and labels for a particular detection
            std::vector<std::pair<double, std::string>> labels;

            operator rectangle() const { return rect; }
            bool operator== (const yolo_rect& rhs) const;
            /*!
                ensures
                    - returns true if and only if rect == rhs.rect && detection_confidence == rhs.detection_confidence && label == rhs.label.
            !*/

            bool operator<(const yolo_rect& rhs) const
            /*!
                ensures
                    - returns true if and only if detection_confidence < rhs.detection_confidence.
            !*/

        };

        inline void serialize(const yolo_rect& item, std::ostream& out);
        inline void deserialize(yolo_rect& item, std::istream& in);
        /*!
            provides serialization support
        !*/

    // ----------------------------------------------------------------------------------------

    }

    #endif // DLIB_FULL_OBJECT_DeTECTION_ABSTRACT_Hh_