Skip to content
Draft
Binary file modified documentation/assets/images/automatic-tracking-session.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/assets/images/maximum-distance-tolerance.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/assets/images/qfield-tracking-session.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/assets/images/tracking-badge.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/assets/images/tracking-layer-properties.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/assets/images/tracking-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/assets/images/tracking-stop.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
120 changes: 56 additions & 64 deletions documentation/how-to/tracking.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,99 +5,91 @@ tx_slug: documentation_how-to_tracking

# Tracking

QField allows you to create points, lines, and polygons from tracking your position.
## General Settings
:material-tablet: Fieldwork

## Activate tracking
QField allows you to track your position through the creation of points, lines or polygons while browsing the map, working on other features and layers, or in the background while having the device in your pocket.
To enable tracking, you need to ensure that your positioning is activated.

:material-tablet: Fieldwork
You can choose between two options for the recording interval of vertices during the tracking session:

To activate tracking, you must first make sure the positioning is active. Then,
open the side "Dashboard", long-press on a legend layer within which you want to
save your tracks to, and select the *Setup tracking* button to configure
the tracking session.
- **Time Requirements:** This option records your position at a regular rate (e.g., every 30 seconds), which is ideal for consistent logs and saving battery.
- **Distance requirement:** This option records a new vertice or feature only after you move a minimum distance.
This keeps your track clean by ignoring movement when you are stationary.
To capture fine detail on steep or winding terrain, use a shorter distance, for straight routes, a longer distance is better.

!![](../assets/images/tracking-layer-properties.png)
!![](../assets/images/tracking-settings.png,350px)

Two constraints are available to limit the number of vertices recorded
during tracking:
- **Erroneous distance:** This option can be used as a safeguard to insure sporadic that bad GNSS readings are not tracked.
This functionality relies on providing a maximum tolerated distance from the last recorded position beyond which readings will be skipped.
To prevent the next vertex from being set too far from the most recent one (e.g., in steep terrain where elevation matters), set a maximum tolerance distance.

- A minimum time interval
- A minimum distance
!![](../assets/images/maximum-distance-tolerance.png,350px)

!![](../assets/images/tracking-settings.png)
For line and polygon layers, a single feature will be created per tracking session, with its geometry formed from the recorded positions.
For point layers, a new feature will be created for each recorded position, and the attribute values entered in the form will be remembered for subsequent points.

Once you have finished configuring your tracking session, hit the *Start tracking*
button to begin recording. At this stage, a feature form will appear, which allows
you to define the attributes of the feature(s) that will be created while QField
tracks your position.
Once a tracking session is set up, a badge appears in the Side Dashboard next to the tracked layers.

For line and polygon layers, a single feature - its geometry formed of vertices
from the recorded positions - will be create per tracking session. For point
layers, a feature will be created for each recorded position, with attribute
values entered in the form remembered across features.
!!! tip
You can simultanously record multiple trackings sessions across several layers.

To prevent overlapping, you have the option to set a maximum distance tolerance between the last and next tracked point/vertices.
This ensures that if the position exceeds this defined distance, it is considered as an erroneous entry.
!![](../assets/images/tracking-badge.png)

!!! note
QField will skip the feature form step if the layer is configured to hide all attributes or if form has been set to hide on feature addition in the attribute form settings.
This can streamline the process of starting tracking sessions.
The features created by the tracking session are saved on every vertex recorded.
During a tracking session, a rubberband line appears on the map to visualize the recorded path.

!!! note
QField offers the capability to resume tracking sessions seamlessly, even if the application has been restarted or the device has been rebooted.
This ensures continuity by allowing previously started tracking sessions to be reactivated without loss progress.

!![](../assets/images/maximum-distance-tolerance.png,550px)
If the layer linked to a tracking session supports the M dimension, QField will store the time passed since the first vertex recorded in each vertex's M value.

## Tracking underway
!!! Workflow

Once a tracking session has been setup, a badge will appear in the side "Dashboard"
legend next to the layer(s) against which tracking is being recorded.
1. Open the Side Dashboard and long-press on the layer which you want to use for tracking.
2. Tap **Setup tracking** and a new window will appear showing the configuration settings.

!![](../assets/images/tracking-badge.png)
!![](../assets/images/tracking-layer-properties.png,350px)

The features created by the tracking session are saved on every vertex recorded.
A rubber band line overlaid onto the map is attached to each tracking session,
allowing you to glance at what has been recorded.
3. Tap the **Start tracking** button to begin the tracking.
4. Enter the attributes for the feature(s) about to be created.
5. Once finished open the Side Dashboard and long-press on the layer's tracking badge you want to stop.
6. Tap **Stop tracking** to finish the.

If the layer linked to a tracking session supports the M dimension, QField will store
the time passed since the first vertex recorded in each vertex's M value.

!!! note
You can simultaneously record multiple trackings sessions across several layers.
!![](../assets/images/tracking-stop.png)

!!! note
While the tracking session is active the layer is still editable, but the tracked feature can't be edited or deleted until the tracking session is stopped over the legend again.

## Terminate tracking
## Resume to a Previous Session

To terminate tracking, simply open the side "Dashboard". From there, long-press
on a legend layer linked to an active tracking session and select the
*Stop tracking* button.
If you did not explicitly terminate your tracking session (for example, you closed the app), QField allows you to continue where you left off.
A prompt will appear asking whether to **resume the last session** or **start a new one**.

!![](../assets/images/tracking-stop.png)
- **Resuming:** A session for a line or polygon layer will continue adding vertices to the feature from the previous session.
This allows you to simply continue across app restarts.

## Predefined Project Tracking Sessions
- **Starting a new session:** This option will discard the incomplete feature from the previous session and begin a new one.


## Automatic Tracking Session

This functionality enables one or more position tracking sessions to automatically start upon project load.
Users will be presented with a feature form popup as the tracking session begins to fill in attributes.
If the vector layer used to track has the "Hide Form on Add Feature" mode selected, the feature form will be skipped.
The feature form of the layer will immediately open asking you for the attributes.
If the tracked vector layer has the "Hide Form on Add Feature" mode selected, the feature form will be skipped.

- **Efficiency**: Automation saves time and effort in the field.
- **Flexibility**: Users can customize sessions and start sessions without entering any attribute information by customising the feature with default values.


!!! Workflow

!![Hide Form on Added Feature](../assets/images/hide-form-on-add-feature.png)
:material-monitor: Desktop

### Configure a Project Tracking Session
:material-monitor: Desktop preparation
1. In QGIS for your tracking layer direct to *Layer Properties* > *QField*
2. Activate "Tracking Session" and specify the tracking requirements.

You can configure a tracking session in QGIS.
Open and direct to *Layer Properties* > *QField*.
There, you can activate "Tracking Session" and specify the tracking requirements.
Note that the QField panel is only available when the QFieldSync plugin is installed in your QGIS profile.
!![Activating automatic "Tracking Sessions" in QFieldSync](../assets/images/automatic-tracking-session.png)

!![Activating automatic "Tracking Sessions" in QFieldSync](../assets/images/automatic-tracking-session.png)
!![Tracking activated automatically in QField](../assets/images/qfield-tracking-session.png,350px)

!![Tracking activated automatically in QField](../assets/images/qfield-tracking-session.png,300px)
3. (Optional) hide your attribute form when automatically starting a session by directing to *Layer Properties* > *Attribute form* and selecting the "Hide Form on Add feature" option.

!!! note
### Benefits
- **Efficiency**: Automation saves time and effort in the field.
- **Flexibility**: Users can customize sessions and opt for automatic initiation with default values.
!![Hide Form on Added Feature](../assets/images/hide-form-on-add-feature.png)