.. _`Draw on Image`:

.. _`syip.imagedraw`:

Draw on Image
~~~~~~~~~~~~~

.. image:: image_draw.svg
   :width: 48


Annotates an image with drawings based on tabular data.

*Algorithms*:


  - *circle*

    Draws (non-filled) circles from given X,Y points with givenradii

    **x:**
      Column name containing X-coordinates

    **y:**
      Column name containing Y-coordinates

    **radius:**
      Column name containing radii

    **red color:**
      A number (0-1) or column name containing colors for first imagechannel.

    **green color:**
      A number (0-1) or column name containing colors for second imagechannel, ignored for non RGB images

    **blue color:**
      A number (0-1) or column name containing colors for third imagechannel, ignored for non RGB images

    **alpha value:**
      A number (0-1) or column name containing alpha values used forblending the drawings over the image.

         1.0 is opaque, 0.0 transparent

    **force colors:**
      If true then forces output to be RGB


  - *filled circle*

    Draws filled circles from given X,Y points with given radii

    **x:**
      Column name containing X-coordinates

    **y:**
      Column name containing Y-coordinates

    **radius:**
      Column name containing radii

    **red color:**
      A number (0-1) or column name containing colors for first imagechannel.

    **green color:**
      A number (0-1) or column name containing colors for second imagechannel, ignored for non RGB images

    **blue color:**
      A number (0-1) or column name containing colors for third imagechannel, ignored for non RGB images

    **alpha value:**
      A number (0-1) or column name containing alpha values used forblending the drawings over the image.

         1.0 is opaque, 0.0 transparent

    **force colors:**
      If true then forces output to be RGB


  - *lines*

    Draws lines from coordinates (X,Y) to coordinates (X2,Y2)

    **x:**
      Column name containing X-coordinates

    **y:**
      Column name containing Y-coordinates

    **x2:**
      Column name containing X2-coordinates

    **y2:**
      Column name containing Y2-coordinates

    **red color:**
      A number (0-1) or column name containing colors for first imagechannel.

    **green color:**
      A number (0-1) or column name containing colors for second imagechannel, ignored for non RGB images

    **blue color:**
      A number (0-1) or column name containing colors for third imagechannel, ignored for non RGB images

    **alpha value:**
      A number (0-1) or column name containing alpha values used forblending the drawings over the image.

         1.0 is opaque, 0.0 transparent

    **force colors:**
      If true then forces output to be RGB


  - *symbols*

    Draws a symbol defined by number of vertices. Negative valuesare drawn as convex objects. Eg, triangles have N=3,squares N=4, hexagons N=6, stars N=-6

    **x:**
      Column name containing X-coordinates

    **y:**
      Column name containing Y-coordinates

    **radius:**
      Column name containing radii

    **red color:**
      A number (0-1) or column name containing colors for first imagechannel.

    **green color:**
      A number (0-1) or column name containing colors for second imagechannel, ignored for non RGB images

    **blue color:**
      A number (0-1) or column name containing colors for third imagechannel, ignored for non RGB images

    **alpha value:**
      A number (0-1) or column name containing alpha values used forblending the drawings over the image.

         1.0 is opaque, 0.0 transparent

    **N:**
      Column name containing number of vertices

    **force colors:**
      If true then forces output to be RGB



*Input ports*:
    **image** : image

        Image to draw on

    **table** : table

        Table used for drawing

*Output ports*:
    **output** : image

        Resulting image



*Configuration*:
    **Algorithm** (algorithm)
        (no description)
    **x** (x)
        (no description)
    **y** (y)
        (no description)
    **x2** (x2)
        (no description)
    **y2** (y2)
        (no description)
    **N** (N)
        (no description)
    **radius** (radius)
        (no description)
    **red color** (red color)
        (no description)
    **green color** (green color)
        (no description)
    **blue color** (blue color)
        (no description)
    **alpha value** (alpha value)
        (no description)
    **force colors** (force colors)
        (no description)

.. automodule:: node_draw

.. class:: ImageDraw