Skip to content

Commit b78c6ac

Browse files
committed
Add docs for annotation
1 parent 7824137 commit b78c6ac

3 files changed

Lines changed: 19 additions & 6 deletions

File tree

.pre-commit-config.yaml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
ci:
22
autoupdate_schedule: quarterly
33

4+
default_language_version:
5+
python: python3.10
6+
47
# See https://pre-commit.com for more information
58
# See https://pre-commit.com/hooks.html for more hooks
69
repos:
@@ -22,13 +25,13 @@ repos:
2225
- id: rst-inline-touching-normal
2326

2427
- repo: https://github.com/codespell-project/codespell
25-
rev: v2.4.2
28+
rev: v2.4.1
2629
hooks:
2730
- id: codespell
2831
args: ["-L", "trough,troughs"]
2932

3033
- repo: https://github.com/astral-sh/ruff-pre-commit
31-
rev: v0.15.20
34+
rev: v0.14.10
3235
hooks:
3336
- id: ruff
3437
name: ruff linter

docs/user_guide/editing.rst

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,21 @@ red highlight):
4747

4848
.. image:: physio_edit.gif
4949

50+
It is also possible to annotate segments. To do so, you will need to enter the
51+
'annotation mode' by doing ``ctrl+a``. Once you are in that mode, segments could
52+
be selected (left click + drag). A yellow window will appear on your timeserie.
53+
Added segments will be track in the Physio instance history. Return back in
54+
'edit mode' (to delete peak) with ``ctrl+e``.
55+
56+
.. image:: physio_edit_segment.gif
57+
58+
NOTE: Currently overlap in segments are not permitted.
59+
5060
If you accidentally reject or delete peaks, you can undo the selection with
51-
``ctrl+z`` (or ``command+z`` if you're on a Mac). The interactive viewer will
52-
track your history of edits as long as it is open, so you can undo multiple
53-
selections, if desired. Once done, you can close the interactive viewer by
54-
pressing ``ctrl+q`` (``command+q``).
61+
``ctrl+z`` (or ``command+z`` if you're on a Mac). This is also applicable to
62+
selected segments. The interactive viewer will track your history of edits as
63+
long as it is open, so you can undo multiple selections, if desired. Once done,
64+
you can close the interactive viewer by pressing ``ctrl+q`` (``command+q``).
5565

5666
All edits performed in the editor are stored in the :py:attr:`~.Physio.history`
5767
of the data object, as with other operations, ensuring a record of your manual
1.23 MB
Loading

0 commit comments

Comments
 (0)