.. _plugin_simaaigroupkeypoints:

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

This section describes the GStreamer plugin named |plugin|.

Brief Description
-----------------
This is a pipeline-specific plugin used in the OpenPose application. It is used for getting the pose entries from the ``heatmap`` and ``paf`` tensors.
The input vector sizes are hard-coded and not availble to the end user.

Sample Config JSON
------------------

.. code-block::

   {
  "version" : 0.1,
  "node_name" : "a65-keypoints",
  "simaai__params" : {
    "params" : 12, <========================================= Not used
    "cpu" : 0, <============================================= Memory type used by allocator
    "next_cpu" : 0, <======================================== NOT USED
    "orig_img_width" : 1280, <=============================== Original image width. Used in re-scale algorithm
    "orig_img_height" : 720, <=============================== Original image height. Used in re-scale algorithm
    "frame_width" : 164, <=================================== Frame width. Used in re-scale algorithm
    "frame_height" : 92, <=================================== Frame height. Used in re-scale algorithm
    "out_sz" : 3440064, <==================================== Output buffer size. See explanation below
    "no_of_outbuf" : 3, <==================================== How many output buffers will be created by plugin
    "qscale" : [ 208.62471656119428, 100.97018835413728 ], <= NOT USED
    "qzp" : [ -114, 9 ], <=================================== NOT USED
    "debug" : 0, <=========================================== NOT USED
    "dump_data" : 0 <======================================== Dump output buffer into file at /tmp
  }
 } 


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

.. code-block::
    :linenos:

    ... !  simaaigroupkeypoints config="/data/simaai/applications/OpenPose/etc/group_key_points_1.json" ! ...


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

.. code-block::
    :linenos:

    Plugin Details:
    Name                     simaaigroupkeypoints
    Description              GStreamer SiMa.ai OpenPose Keypoints Plugin
    Filename                 ./libgstsimaaigroupkeypoints.so
    Version                  1.18.16
    License                  LGPL
    Source module            vdp-catalog-zoo
    Binary package           GStreamer SiMa.ai Group Keypoints2 Plug-in
    Origin URL               https://bitbucket.org/sima-ai/vdp-catalog-zoo

    simaaigroupkeypoints: SiMa.ai GroupKeyPoints element

    1 features:
    +-- 1 elements


.. note::

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

.. |plugin| replace:: simaaigroupkeypoints