Skip to content

Commit

Permalink
Merge pull request #5 from Chilipp/tutorial-doc-fix
Browse files Browse the repository at this point in the history
Tutorial doc fix
  • Loading branch information
Chilipp committed Feb 13, 2019
2 parents 71372f6 + a86ce67 commit 967002e
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 17 deletions.
33 changes: 23 additions & 10 deletions straditize/widgets/docs/selection_toolbar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,10 @@ select a rectangle or point |rect|
a single point
select a polygon |poly|
This tool can be accessed through the context menu of the |rect|
tool. If activated and you click on the image, hold the mouse
button and drag it around the features you want to select.
Everything that is in the shape you draw while pressing the mouse
button will be selected.
tool (click and hold this button to open the menu). If activated and you
click on the image, hold the mouse button and drag it around the features
you want to select. Everything that is in the shape you draw while pressing
the mouse button will be selected.
select based on connectivity or functionality |wand|
This tool selects entire features in the image. The exact
behaviour depends on what you are doing at the moment. If you
Expand All @@ -64,12 +64,19 @@ select based on connectivity or functionality |wand|
binary image.
select based on color |color-wand|
This tool can be accessed through the context menu of the |wand|
tool. If activated and you click on the image, all connected cells
that have the same color are selected. You can also relax this a bit,
such that all colors that are close to the selected color will be
selected. Furthermore, you can choose the select the colors in the
`whole plot`, i.e. all pixels that have the same (or similar) color
as the selected cell will be selected.
tool (click and hold this button to open the menu). If activated and you
click on the image, all connected cells that have the same color are
selected. You can also relax this a bit, such that all colors that are
close to the selected color will be selected. Furthermore, you can choose
the select the colors in the `whole plot`, i.e. all pixels that have the
same (or similar) color as the selected cell will be selected.
select the entire pixel row |row-wand|
This tool also can be accessed through the context menu of the |wand|
tool (click and hold this button to open the menu). If you click on the
image, all selectable features on this horizontal level (i.e. on this
pixel row in the image) are selected.
select the entire pixel column |col-wand|
The same as the |row-wand| tool but for the vertical columns.

.. |rect| image:: select.png
:width: 1.3em
Expand All @@ -83,6 +90,12 @@ select based on color |color-wand|
.. |color-wand| image:: color_select.png
:width: 1.3em

.. |row-wand| image:: row_select.png
:width: 1.3em

.. |col-wand| image:: col_select.png
:width: 1.3em

.. _selection-mode:

Selection mode
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@ the automatic recognition functionalities.

For this, we use the selection toolbar:

i. from the |wand| menu, select the `column selection` tool
i. from the |wand| menu, select the `column selection` tool (click and hold
the button to the right of the |rect_select| button in the selection
toolbar to open the menu)

.. image:: column-selection-tool.png

Expand All @@ -37,5 +39,8 @@ the automatic recognition functionalities.
.. |wand| image:: wand_select.png
:width: 1.3em

.. |rect_select| image:: select.png
:width: 1.3em

.. |new-select| image:: new_selection.png
:width: 1.3em
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@ is provided by matplotlib
.. image:: matplotlib-navigation-toolbar.png

Especially the Pan/Zoom button |pan| and the zoom-to-rectangle button |zoom|
are of interest for you. The `matplotlib docs`_ provide guidance:
are of interest for you. You can enable and disable them by clicking on the
corresponding button in the toolbar.

The `matplotlib docs`_ provide further guidance:

.. image:: move_large.png

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,32 @@ the automatic digitization.

1. Click the :guilabel:`Select data part` button in the digitization control.
2. Straditize automatically recognizes the data part. But you can change this
by moving the crosses around with your mouse.
by moving the crosses around with your mouse (see the note below).
3. Click the :guilabel:`Apply` button at the bottom
4. Done! You now see a red rectangle in your diagram the marks the data part.
You can hide it using the `Plot control` section in the straditizer control.
For the sake of this tutorial, expand the `Plot control` section and remove
the rectangle by clicking the |invalid| icon for the `Diagram part`


.. |invalid| image:: invalid.png
:width: 1.3em


.. note::

These marks are very common in straditize. In general, you can
left-click on a mark to move it around, right-click to delete it, and
Shift+left-click on the plot to create a new one.

Note that you need to disable the |pan| and |zoom| tools in the navigation
to interact with the marks, by clicking on the corresponding button!

If you want to change the appearance of the marks, see the `Marker control`
section in the straditizer control panel.


.. |invalid| image:: invalid.png
:width: 1.3em

.. |pan| image:: move_large.png
:width: 1.3em

.. |zoom| image:: zoom_to_rect_large.png
:width: 1.3em

0 comments on commit 967002e

Please sign in to comment.