Commits

Blaz Zupan  committed 86b1eb3

Added documentation on Paint Data widget.

  • Participants
  • Parent commits ca2913b

Comments (0)

Files changed (20)

File docs/widgets/rst/data/file.rst

 both :ref:`Data Table` widget and to widget that displays
 :ref:`Attribute Statistics`.
 
-.. image:: images/File_schema.png
+.. image:: images/File-Workflow.png
    :alt: Example schema with File widget

File docs/widgets/rst/data/images/DataTable-Example.png

Removed
Old image

File docs/widgets/rst/data/images/File-Workflow.png

Added
New image

File docs/widgets/rst/data/images/File_schema.png

Removed
Old image

File docs/widgets/rst/data/images/PaintData-Workflow.png

Added
New image

File docs/widgets/rst/data/images/PaintData-stamped.png

Added
New image

File docs/widgets/rst/data/images/PaintData-tags.txt

+0	328	148
+1	75	127
+2	85	419
+3	143	486
+4	96	575
+5	150	612

File docs/widgets/rst/data/images/PaintData.png

Added
New image

File docs/widgets/rst/data/images/Save-Example.png

Removed
Old image

File docs/widgets/rst/data/images/Save-Workflow.png

Added
New image

File docs/widgets/rst/data/images/SelectAttributes-Example.png

Removed
Old image

File docs/widgets/rst/data/images/SelectAttributes-Schema.png

Removed
Old image

File docs/widgets/rst/data/images/SelectAttributes-Workflow.png

Added
New image

File docs/widgets/rst/data/images/SelectData-Example.png

Removed
Old image

File docs/widgets/rst/data/images/SelectData-Workflow.png

Added
New image

File docs/widgets/rst/data/paintdata.rst

+.. _Paint Data:
+
+Paint Data
+==========
+
+.. image:: ../../../../Orange/OrangeWidgets/Data/icons/PaintData.svg
+   :alt: Paint Data widget icon
+   :class: widget-category-data widget-icon
+
+Paints the data on a 2D plane. Place individual data
+points or use brush to paint a larger data sets.
+   
+Signals
+-------
+
+Inputs:
+   - (None)
+
+Outputs:
+   - :obj:`Data`
+         Attribute-valued data set created in the widget.
+
+
+.. _my-reference-label:
+
+Description
+-----------
+
+The widget support the creation of the new data set by visually placing the
+data points on the two-dimension plane. Data points can be placed on the
+plane individually (:obj:`Put`) or in a larger number by brushing
+(:obj:`Brush`). Data points can belong to classes if the data
+is intended to be used in supervised learning.
+
+.. image:: images/PaintData-stamped.png
+   :alt: Paint Data widget
+
+.. rst-class:: stamp-list
+
+   1. A 2D drawing canvas with fixed coordinate system.
+   #. Select the class to paint its data instances. Add or remove classes.
+      Use one class only to create classless, unsupervised data sets.
+   #. Drawing tools. Paint data points with :obj:`Brush` and :obj:`Paint`.
+      Select (and then remove or relocate) them with :obj:`Select` or
+      :obj:`Lasso`. Reposition data points with :obj:`Jitter` or :obj:`Magnet`.
+   #. Each of the tools may have its own options shown in this box.
+   #. Undo or redo the editing actions.
+   #. If :obj:`Commit on change` is checked, the data would be sent to the
+      output channel of the widget upon any change. This operation could be
+      slow when data sets become large.
+
+Example
+-------
+
+In the workflow below we have painted an unsupervised (class-less) data
+set and sent it to :ref:`Data Table` and :ref:`K-Means Clustering` clustering
+widget. We have painted three clusters, which were, at least in a number
+of clusters correctly identified by the k-means clustering.
+
+.. image:: images/PaintData-Workflow.png
+   :alt: Example schema with File widget

File docs/widgets/rst/data/save.rst

 widget, where we select a subset of the data instances and push them
 to Save widget to store them in a data file.
 
-.. image:: images/Save-Example.png
+.. image:: images/Save-Workflow.png
    :alt: Schema with Save widget

File docs/widgets/rst/data/selectattributes.rst

 is fed to the Select Attributes widget, which outputs the data to
 the :ref:`Data Table`.
 
-.. image:: images/SelectAttributes-Schema.png
+.. image:: images/SelectAttributes-Workflow.png
    :alt: Select Attributes schema
 
 We used the schema to redefine the classification problem in

File docs/widgets/rst/data/selectdata.rst

 compared the prices of all the cars in the data set to those of BMW and
 Marcedes-Benz.
 
-.. image:: images/SelectData-Example.png
+.. image:: images/SelectData-Workflow.png
    :alt: A workflow with Data Sampler

File docs/widgets/rst/index.rst

     :widths: 1 1 1
     
     * - |File_icon| :ref:`File`
+      - |PaintData_icon| :ref:`Paint Data`
       - |DataTable_icon| :ref:`Data Table`
-      - |SelectAttributes_icon| :ref:`Select Attributes`
-    * - |Rank_icon| :ref:`Rank`
+    * - |SelectAttributes_icon| :ref:`Select Attributes`
+      - |Rank_icon| :ref:`Rank`
       - |PurgeDomain_icon| :ref:`Purge Domain`
-      - |MergeData_icon| :ref:`Merge Data`
-    * - |Concat_icon| :ref:`Concatenate`
+    * - |MergeData_icon| :ref:`Merge Data`
+      - |Concat_icon| :ref:`Concatenate`
       - |DataSampler_icon| :ref:`Data Sampler`
-      - |SelectData_icon| :ref:`Select Data`
-    * - |Save_icon| :ref:`Save`
+    * - |SelectData_icon| :ref:`Select Data`
+      - |Save_icon| :ref:`Save`
       - |Discretize_icon| :ref:`Discretize`
-      - |Cont_icon| :ref:`Continuize`
-    * - |Impute_icon| :ref:`Impute`
+    * - |Cont_icon| :ref:`Continuize`
+      - |Impute_icon| :ref:`Impute`
       - |Outliers_icon| :ref:`Outliers`
-      - |EditDomain_icon| :ref:`Edit Domain`
-    * - |PythonScript_icon| :ref:`Python Script`
-      -
+    * - |EditDomain_icon| :ref:`Edit Domain`
+      - |PythonScript_icon| :ref:`Python Script`
       -
 
 .. |File_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/File.svg
     :width: 36
     :height: 36
 
+.. |PaintData_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/PaintData.svg
+    :alt: File
+    :width: 36
+    :height: 36
+
 .. |DataTable_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/DataTable.svg
 	:alt: Data Table
 	:width: 36
    :maxdepth: 1
    
    data/file.rst
+   data/paintdata.rst
    data/datatable.rst
    data/selectattributes.rst
    data/rank.rst