From cf5fe7179840e54c9e0fb924abdd4e6d4fe99451 Mon Sep 17 00:00:00 2001 From: Daniel Schadt Date: Fri, 21 Apr 2023 23:02:53 +0200 Subject: docs: add remove breaks documentation --- CHANGELOG.rst | 1 + doc/user/transformers.rst | 15 +++++++++++++++ 2 files changed, 16 insertions(+) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index b1e573b..4ce963a 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -10,6 +10,7 @@ Added - Profile pages with "milestone tracks" (longest, shortest, ...). - Integration with ``hittekaart`` for heatmaps on the profile. - A data version check at startup. +- The *Remove Breaks* transformer. Changed ^^^^^^^ diff --git a/doc/user/transformers.rst b/doc/user/transformers.rst index c8ddf01..d053052 100644 --- a/doc/user/transformers.rst +++ b/doc/user/transformers.rst @@ -43,3 +43,18 @@ point. To fix those points, the transformer will find the first correct point, and copy its elevation to the wrong points. + +Remove Breaks +------------- + +The *remove breaks* transformer removes longer breaks of inactivity by deleting +the points and shifting the following points back in time. This is useful e.g. +if you are waiting at a single spot for a while, and you would like that to be +removed for a cleaner log. + +Note that this transformer modifies the track's timings. Therefore, the +recording will end earlier than it did in reality, and the stopped time will be +reduced. + +A break is removed if the speed is below 1 kilometer per hour (approx. 0.28 +meters per second) for more than 5 minutes. -- cgit v1.2.3