.. _plugin_simaaimrcnnmaskfiltering:

|plugin|
====================

This section describes the GStreamer plugin named |plugin|.

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

This plugin is used to get the correct mask from the MLA which returns mask prediction
to the proper class ID and concatenates it with the corresponding BBOX.

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

.. code-block:: 

    {
      "version": 0.1,
      "node_name": "mask_filtering",
      "memory": {
        "cpu": 0, <================================================== NOT USED
        "next_cpu": 0 <============================================== Memory type used by allocator. 0 means A65 memory will be used
      },
      "system": {
        "out_buf_queue": 1,
        "debug": 0, <================================================ NOT USED
        "dump_data": 0 <============================================= Dump the output buffer into file at /tmp
      },
      "buffers": {
        "input": [
          {
            "name": "bbox", <======================================== Input buffer 0 name
            "size": 604     <======================================== Input buffer 0 size
          },
          {
            "name": "masks", <======================================= Input buffer 1 name
            "size": 28537600 <======================================= Input buffer 1 size
          }
        ],
        "output": {
          "size": 362400 <=========================================== Output buffer size
        }
      },
      "num_of_classes": 90 <========================================= Number of classes based on coco_labels.txt
    }


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

.. code-block::

    GST_DEBUG=2 gst-launch-1.0 --gst-plugin-path=/data/simaai/applications/Mask_RCNN/lib simaaisrc location=/data/ev_kernel.out delay=1000 ! mask_filtering config="/data/mask_filtering_config.json" ! fakesink


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

.. code-block::
    :linenos:

    Plugin Details:
    Name                     simaaimrcnnmaskfiltering
    Description              GStreamer SiMa.ai Simaaimrcnnmaskfiltering Plugin
    Filename                 ./libgstsimaaimrcnnmaskfiltering.so
    Version                  1.18.16
    License                  LGPL
    Source module            gst-plugins-sima
    Binary package           GStreamer SiMa.ai gstsimaaimrcnnmaskfiltering Plug-in
    Origin URL               https://bitbucket.org/sima-ai/gst-plugins-sima

    simaaimrcnnmaskfiltering: SiMa.AI Simaaimrcnnmaskfiltering Plugin

    1 features:
    +-- 1 elements


.. note::

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

.. |plugin| replace:: simaaimrcnnmaskfiltering