.. _plugin_simaaiboxcreator:

|plugin|
========
This section describes a GStreamer plugin named |plugin|.

Brief Description
-----------------

This plugin is an aggregator plugin designed to process a bounding box.
The plugin takes the softmax and sigmoid outputs and transforms the coordinates to create a set of BBOX structures.
These structures, representing bounding boxes with associated class IDs, scores, and coordinates, are then available for further processing.

Config JSON Parameters
----------------------

width: frame width
height: frame height
num_boxes: total data len (100)
num_classes: total number of classes (92)
car_only: Enable to detect cars only

.. code-block::

 {
  "version": 0.1,
  "node_name": "bbox",
  "memory": {
    "cpu": 0,
    "next_cpu": 0
  },
  "system": {
    "out_buf_queue": 1,
    "debug": 0,
    "dump_data": 1
  },
  "params": {
    "width": 1280,
    "height": 720,
    "num_boxes": 100,
    "num_classes": 92,
    "car_only": 1
  },
  "buffers": {
    "input": [
      {
        "name": "sigmoid",
        "size": 1600,
        "order": 0,
        "offset": 0,
        "copy_bytes": 1600
      },
      {
        "name": "softmax2d",
        "size": 36800,
        "order": 1,
        "offset": 0,
        "copy_bytes": 36800
      }
    ],
    "output": {
      "size": 2400
    }
  }
 }

Example Usage
-------------

.. code-block::
    :linenos:

    typedef struct { unsigned int x1; // top-left unsigned int y1; unsigned int w; // width and height unsigned int h; float score; unsigned int class_id; // channel in heatmap } BBOX;


``gst-inspect-1.0`` Output
---------------------------

.. code-block::
    :linenos:

    Plugin Details:
    Name                     simaaiboxcreator
    Description              
    Filename                 
    Version                  
    License                  LGPL
    Source module            gst-plugins-sima
    Binary package           
    Origin URL               https://bitbucket.org/sima-ai/gst-plugins-sima

    simaaiboxcreator: SiMa.ai simaaiboxcreator element

    1 features:
    +-- 1 elements


.. note::

    Please refer to |plugin|'s README file for more information.

.. |plugin| replace:: simaaiboxcreator