straditize.widgets.tutorial.hoya_del_castillo module

The tutorial of straditize

This module contains an advanced guided tour through straditize

Disclaimer

Copyright (C) 2018-2019 Philipp S. Sommer

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.

Classes

ColumnNames(filename, tutorial)	The page for recognizing column names
ColumnNamesOCR(filename, tutorial)	Tutorial page for column names with tesserocr support
EditMeta(filename, tutorial)	Tutorial page for editing the meta attributes
HoyaDelCastilloTutorial(straditizer_widgets)	A tutorial for digitizing an area diagram
LoadImage(filename, tutorial)	param filename The basename (without ending) of the RST file corresponding to this
RemoveLines(filename, tutorial)	Tutorial page for removing horizontal and vertical lines
SelectDataPart(filename, tutorial)	TutorialPage for selecting the data part
SeparateColumns(filename, tutorial)	The page for separating the columns
TranslateXAxis(filename, tutorial)	The tutorial page for translating the x-axes
TranslateYAxis(filename, tutorial)	The tutorial page for translating the y-axis
TutorialPage(filename, tutorial)	param filename The basename (without ending) of the RST file corresponding to this

class straditize.widgets.tutorial.hoya_del_castillo.ColumnNames(filename, tutorial)

Bases: straditize.widgets.tutorial.beginner.ColumnNames

The page for recognizing column names

Parameters

• filename (str) – The basename (without ending) of the RST file corresponding to this tutorial page

• tutorial (Tutorial) – The tutorial instance

Attributes

column_names	Built-in mutable sequence.
select_names_button_clicked	bool(x) -> bool

column_names = ['Charcoal', 'Pinus', 'Juniperus', 'Quercus ilex-type', 'Quercus suber-type', 'Olea', 'Betula', 'Corylus', 'Carpinus-type', 'Ericaceae', 'Ephedra distachya-type', 'Ephedra fragilis', 'Mentha-type', 'Anthemis-type', 'Artemisia', 'Caryophyllaceae', 'Chenopodiaceae', 'Cruciferae', 'Filipendula', 'Gramineae <40um', 'Gramineae >40<50um', 'Gramineae >50<60um', 'Gramineae >60um', 'Liguliflorae', 'Plantago coronopus', 'Pteridium', 'Filicales', 'Pollen Concentration']

select_names_button_clicked = False

class straditize.widgets.tutorial.hoya_del_castillo.ColumnNamesOCR(filename, tutorial)

Bases: straditize.widgets.tutorial.hoya_del_castillo.ColumnNames

Tutorial page for column names with tesserocr support

Parameters

• filename (str) – The basename (without ending) of the RST file corresponding to this tutorial page

• tutorial (Tutorial) – The tutorial instance

Attributes

colpic_extents	Built-in mutable sequence.
colpic_sizes	Built-in mutable sequence.

Methods

hint_for_start_editing()
hint_for_wrong_name(col, curr, ref)	Display a hint if a name is not correctly set

colpic_extents = [(1051, 1127, 573, 588), (1176, 1225, 704, 719), (1338, 1422, 866, 884), (1437, 1584, 964, 982), (1490, 1655, 1016, 1034), (1511, 1550, 1038, 1052), (1533, 1587, 1061, 1075), (1557, 1621, 1083, 1102), (1580, 1699, 1105, 1123), (1600, 1686, 1123, 1138), (1623, 1828, 1151, 1169), (1646, 1783, 1173, 1192), (1665, 1779, 1195, 1215), (1689, 1811, 1218, 1237), (1711, 1793, 1240, 1254), (1766, 1909, 1288, 1306), (1788, 1934, 1310, 1328), (1841, 1929, 1363, 1378), (1862, 1957, 1390, 1407), (1885, 2045, 1407, 1422), (1922, 2116, 1444, 1459), (1945, 2138, 1467, 1482), (1968, 2128, 1490, 1505), (1990, 2083, 1512, 1531), (2012, 2186, 1540, 1559), (2035, 2117, 1563, 1577), (2056, 2126, 1584, 1599), (2080, 2259, 1601, 1616)]

colpic_sizes = [(270, 88), (189, 88), (307, 109), (494, 109), (550, 109), (159, 85), (204, 85), (249, 112), (363, 60), (264, 48), (655, 109), (411, 57), (336, 69), (424, 116), (286, 85), (487, 112), (493, 109), (309, 88), (297, 51), (523, 88), (624, 89), (624, 89), (525, 89), (333, 112), (574, 109), (289, 88), (254, 88), (581, 89)]

hint_for_start_editing()

hint_for_wrong_name(col, curr, ref)

Display a hint if a name is not correctly set

class straditize.widgets.tutorial.hoya_del_castillo.EditMeta(filename, tutorial)

Bases: straditize.widgets.tutorial.hoya_del_castillo.TutorialPage

Tutorial page for editing the meta attributes

Parameters

• filename (str) – The basename (without ending) of the RST file corresponding to this tutorial page

• tutorial (Tutorial) – The tutorial instance

Methods

hint()	A method that should display a hint to the user
skip()	Skip the steps in this page

Attributes

is_finished

Boolean that is True, if the steps are all finished

hint()

A method that should display a hint to the user

property is_finished

Boolean that is True, if the steps are all finished

skip()

Skip the steps in this page

class straditize.widgets.tutorial.hoya_del_castillo.HoyaDelCastilloTutorial(straditizer_widgets)

Bases: straditize.widgets.tutorial.beginner.Tutorial

A tutorial for digitizing an area diagram

Methods

setup_tutorial_pages()	Setup the pages attribute and initialize the tutorial pages
show()	Show the documentation of the tutorial

Attributes

src_base	str(object=’’) -> str
src_dir	str(object=’’) -> str
src_file	str(object=’’) -> str

setup_tutorial_pages()

Setup the pages attribute and initialize the tutorial pages

show()

Show the documentation of the tutorial

src_base = 'hoya-del-castillo.png'

src_dir = '/home/docs/checkouts/readthedocs.org/user_builds/straditize/checkouts/stable/straditize/widgets/tutorial/hoya-del-castillo'

src_file = '/home/docs/checkouts/readthedocs.org/user_builds/straditize/checkouts/stable/straditize/widgets/tutorial/hoya-del-castillo/hoya-del-castillo.png'

class straditize.widgets.tutorial.hoya_del_castillo.LoadImage(filename, tutorial)

Bases: straditize.widgets.tutorial.beginner.LoadImage, straditize.widgets.tutorial.hoya_del_castillo.TutorialPage

Parameters

• filename (str) – The basename (without ending) of the RST file corresponding to this tutorial page

• tutorial (Tutorial) – The tutorial instance

class straditize.widgets.tutorial.hoya_del_castillo.RemoveLines(filename, tutorial)

Bases: straditize.widgets.tutorial.hoya_del_castillo.TutorialPage

Tutorial page for removing horizontal and vertical lines

Parameters

• filename (str) – The basename (without ending) of the RST file corresponding to this tutorial page

• tutorial (Tutorial) – The tutorial instance

Methods

activate()	Method that is called, when the page is activated
clicked_hlines_button()
clicked_vlines_button()
deactivate()	Method that is called, when the page is deactivated
hint()	A method that should display a hint to the user
skip()	Skip the steps in this page

Attributes

hlines_button_clicked	bool(x) -> bool
is_finished	Boolean that is True, if the steps are all finished
vlines_button_clicked	bool(x) -> bool

activate()

Method that is called, when the page is activated

clicked_hlines_button()

clicked_vlines_button()

deactivate()

Method that is called, when the page is deactivated

hint()

A method that should display a hint to the user

hlines_button_clicked = False

property is_finished

Boolean that is True, if the steps are all finished

skip()

Skip the steps in this page

vlines_button_clicked = False

class straditize.widgets.tutorial.hoya_del_castillo.SelectDataPart(filename, tutorial)

Bases: straditize.widgets.tutorial.beginner.SelectDataPart

TutorialPage for selecting the data part

Parameters

• filename (str) – The basename (without ending) of the RST file corresponding to this tutorial page

• tutorial (Tutorial) – The tutorial instance

Attributes

ref_lims	The reference x- and y- limits
remove_data_box	bool(x) -> bool
valid_xlims	Valid ranges for xmin and xmax
valid_ylims	Valid ranges for ymin and ymax

ref_lims = array([[ 315, 1946], [ 511, 1311]])

The reference x- and y- limits

remove_data_box = False

valid_xlims = array([[ 310, 319], [1928, 1960]])

Valid ranges for xmin and xmax

valid_ylims = array([[ 508, 513], [1307, 1312]])

Valid ranges for ymin and ymax

class straditize.widgets.tutorial.hoya_del_castillo.SeparateColumns(filename, tutorial)

Bases: straditize.widgets.tutorial.beginner.SeparateColumns

The page for separating the columns

Parameters

• filename (str) – The basename (without ending) of the RST file corresponding to this tutorial page

• tutorial (Tutorial) – The tutorial instance

Attributes

ncols

int([x]) -> integer

ncols = 28

class straditize.widgets.tutorial.hoya_del_castillo.TranslateXAxis(filename, tutorial)

Bases: straditize.widgets.tutorial.hoya_del_castillo.TutorialPage

The tutorial page for translating the x-axes

Parameters

• filename (str) – The basename (without ending) of the RST file corresponding to this tutorial page

• tutorial (Tutorial) – The tutorial instance

Methods

activate()	Method that is called, when the page is activated
clicked_add_reader_button()
clicked_translations_button()
deactivate()	Method that is called, when the page is deactivated
hint()	A method that should display a hint to the user
hint_for_col(col)
refresh()
skip()	Skip the steps in this page

Attributes

add_reader_button_clicked	Built-in mutable sequence.
is_finished	Boolean that is True, if the steps are all finished
xaxis_translations_button_clicked	bool(x) -> bool

activate()

Method that is called, when the page is activated

add_reader_button_clicked = []

clicked_add_reader_button()

clicked_translations_button()

deactivate()

Method that is called, when the page is deactivated

hint()

A method that should display a hint to the user

hint_for_col(col)

property is_finished

Boolean that is True, if the steps are all finished

refresh()

skip()

Skip the steps in this page

xaxis_translations_button_clicked = False

class straditize.widgets.tutorial.hoya_del_castillo.TranslateYAxis(filename, tutorial)

Bases: straditize.widgets.tutorial.hoya_del_castillo.TutorialPage

The tutorial page for translating the y-axis

Parameters

• filename (str) – The basename (without ending) of the RST file corresponding to this tutorial page

• tutorial (Tutorial) – The tutorial instance

Methods

activate()	Method that is called, when the page is activated
clicked_correct_button()
deactivate()	Method that is called, when the page is deactivated
hint()	A method that should display a hint to the user
skip()	Skip the steps in this page

Attributes

correct_button_clicked	bool(x) -> bool
is_finished	Boolean that is True, if the steps are all finished

activate()

Method that is called, when the page is activated

clicked_correct_button()

correct_button_clicked = False

deactivate()

Method that is called, when the page is deactivated

hint()

A method that should display a hint to the user

property is_finished

Boolean that is True, if the steps are all finished

skip()

Skip the steps in this page

class straditize.widgets.tutorial.hoya_del_castillo.TutorialPage(filename, tutorial)

Bases: straditize.widgets.tutorial.beginner.TutorialPage

Parameters

• filename (str) – The basename (without ending) of the RST file corresponding to this tutorial page

• tutorial (Tutorial) – The tutorial instance

Attributes

src_base	str(object=’’) -> str
src_dir	str(object=’’) -> str
src_file	str(object=’’) -> str

src_base = 'hoya-del-castillo.png'

src_dir = '/home/docs/checkouts/readthedocs.org/user_builds/straditize/checkouts/stable/straditize/widgets/tutorial/hoya-del-castillo'

src_file = '/home/docs/checkouts/readthedocs.org/user_builds/straditize/checkouts/stable/straditize/widgets/tutorial/hoya-del-castillo/hoya-del-castillo.png'