diff --git a/docs/source/user_interface/images/casern_visualization.png b/docs/source/user_interface/images/casern_visualization.png new file mode 100644 index 0000000000000000000000000000000000000000..d9684dcf97733bfe8832a6e32d0dafc10b2f5924 Binary files /dev/null and b/docs/source/user_interface/images/casern_visualization.png differ diff --git a/docs/source/user_interface/images/current_point.png b/docs/source/user_interface/images/current_point.png new file mode 100644 index 0000000000000000000000000000000000000000..816cec68e13152f43a9366be3804a29a76acb23b Binary files /dev/null and b/docs/source/user_interface/images/current_point.png differ diff --git a/docs/source/user_interface/images/frames_before_after.png b/docs/source/user_interface/images/frames_before_after.png new file mode 100644 index 0000000000000000000000000000000000000000..f1408495b5daa5e03b6d47526b8f3ffc5caec72c Binary files /dev/null and b/docs/source/user_interface/images/frames_before_after.png differ diff --git a/docs/source/user_interface/images/ground_path.png b/docs/source/user_interface/images/ground_path.png new file mode 100644 index 0000000000000000000000000000000000000000..7066c213b6c3681ce6411ea903cdb53956d1597d Binary files /dev/null and b/docs/source/user_interface/images/ground_path.png differ diff --git a/docs/source/user_interface/images/ground_projection.png b/docs/source/user_interface/images/ground_projection.png new file mode 100644 index 0000000000000000000000000000000000000000..ba8352b70bbe2d17c78fcca0f2b4c03713b7316b Binary files /dev/null and b/docs/source/user_interface/images/ground_projection.png differ diff --git a/docs/source/user_interface/images/only_visible_example.webp b/docs/source/user_interface/images/only_visible_example.webp new file mode 100644 index 0000000000000000000000000000000000000000..9b20bb533e048312cf4e613e1e669be54eebcf91 Binary files /dev/null and b/docs/source/user_interface/images/only_visible_example.webp differ diff --git a/docs/source/user_interface/images/past_future_path.png b/docs/source/user_interface/images/past_future_path.png new file mode 100644 index 0000000000000000000000000000000000000000..3eec49a39fff0cf3f12a6edb8f22b26e028a31f6 Binary files /dev/null and b/docs/source/user_interface/images/past_future_path.png differ diff --git a/docs/source/user_interface/images/past_path.png b/docs/source/user_interface/images/past_path.png new file mode 100644 index 0000000000000000000000000000000000000000..e5689e2e7ba388636295ed26a389b7f181bf7dbf Binary files /dev/null and b/docs/source/user_interface/images/past_path.png differ diff --git a/docs/source/user_interface/images/show_color.png b/docs/source/user_interface/images/show_color.png new file mode 100644 index 0000000000000000000000000000000000000000..0df29885cbc4f59f729ab5e7003f02d04a764229 Binary files /dev/null and b/docs/source/user_interface/images/show_color.png differ diff --git a/docs/source/user_interface/images/show_height.png b/docs/source/user_interface/images/show_height.png new file mode 100644 index 0000000000000000000000000000000000000000..dbea0a044ac083e918ace424df9deee1e252d5eb Binary files /dev/null and b/docs/source/user_interface/images/show_height.png differ diff --git a/docs/source/user_interface/images/show_marker_id.png b/docs/source/user_interface/images/show_marker_id.png new file mode 100644 index 0000000000000000000000000000000000000000..8e3f54a0a3bb64f6edc9053d6d5f76256841c556 Binary files /dev/null and b/docs/source/user_interface/images/show_marker_id.png differ diff --git a/docs/source/user_interface/images/show_number.png b/docs/source/user_interface/images/show_number.png new file mode 100644 index 0000000000000000000000000000000000000000..8c79c20529c319e55b390f7aa4a391a47f763937 Binary files /dev/null and b/docs/source/user_interface/images/show_number.png differ diff --git a/docs/source/user_interface/images/show_only_list_example.png b/docs/source/user_interface/images/show_only_list_example.png new file mode 100644 index 0000000000000000000000000000000000000000..0956da4748fc7590187d3e3b6799e5abba711480 Binary files /dev/null and b/docs/source/user_interface/images/show_only_list_example.png differ diff --git a/docs/source/user_interface/images/show_only_people_list_widget.png b/docs/source/user_interface/images/show_only_people_list_widget.png new file mode 100644 index 0000000000000000000000000000000000000000..56789f81e6a038ad8b81e99bc6687a8a054a6f2d Binary files /dev/null and b/docs/source/user_interface/images/show_only_people_list_widget.png differ diff --git a/docs/source/user_interface/images/show_points_with_color.png b/docs/source/user_interface/images/show_points_with_color.png new file mode 100644 index 0000000000000000000000000000000000000000..e5b42f41709f53530f67f09831ca72e8b43a220a Binary files /dev/null and b/docs/source/user_interface/images/show_points_with_color.png differ diff --git a/docs/source/user_interface/images/show_points_wo_color.png b/docs/source/user_interface/images/show_points_wo_color.png new file mode 100644 index 0000000000000000000000000000000000000000..04330d398105f42f3aded97cfeda7a8f0b80dc37 Binary files /dev/null and b/docs/source/user_interface/images/show_points_wo_color.png differ diff --git a/docs/source/user_interface/images/visualization_options.png b/docs/source/user_interface/images/visualization_options.png new file mode 100644 index 0000000000000000000000000000000000000000..55e8c472afdb2888f8e934ec6fb61e4677953d3c Binary files /dev/null and b/docs/source/user_interface/images/visualization_options.png differ diff --git a/docs/source/user_interface/visualization.md b/docs/source/user_interface/visualization.md index 6b15e617d79fde722fc98fd5311fb58c6f86474e..1b5c857f25b9f9c3184d8f8207150cd5771b249c 100644 --- a/docs/source/user_interface/visualization.md +++ b/docs/source/user_interface/visualization.md @@ -2,5 +2,149 @@ Options for the visualization of points and trajectories are included in the tracking tab. -**TODO: image of viz options, followed by explanation (or explanation without image? Could open PeTrack to the side instead as user...)** + +:::{tip} +If you want to use PeTrack visualizations in your publication export the view of PeTrack instead of taking a screenshot. This will result in a higher-quality image. See [here](../export/video.md#export) for more info. +::: + +## Options + +show +: Enables or disabled all of the following visualizations + +### Trajectory visualizations + +Trajectory visualizations are visualizations that show not only information about the current point, but also about the future and past trajectory. + +frames before/after actual position +: These two spin-boxes allow to select how many frames into the future and past all different trajectory visualizations are supposed to draw. + + :::{image} images/frames_before_after.png + ::: + +show path +: Shows the trajectory as a line. Note that during the first playback, only the past trajectory is drawn, since the future has not been tracked yet + + :::{image} images/past_path.png + :width: 50% + ::: + + After tracking the whole video, the trajectory will be drawn in both, past and future directions + + :::{image} images/past_future_path.png + :width: 50% + ::: + + +show ground path +: The head position can be projected down to the ground. This options draws the trajectory of this projection to the ground. + :::{image} images/ground_path.png + :width: 50% + ::: + +show points +: Shows the detected points. + + :::{image} images/show_points_wo_color.png + :width: 50% + ::: + If the `colored` checkbox is checked, the color of the TrackPoint is used to fill it out + + :::{image} images/show_points_with_color.png + :width: 50% + ::: + +### Point visualizations + +Point visualizations only visualize information about the currently displayed frame. + +show current point +: Shows the point from the currently displayed frame. The line is colored green, if the point was created as the result of recognition or manually. It is colored blue if the point is the result of tracking only. + + Checking `head size` will set the size of the point heuristically to the avg. head size of a person. + + :::{image} images/current_point.png + :width: 50% + ::: + +show height/col. color/marker ID +: This option enables two different visualizations. Note that `individual` does not do anything for the currently recommended markers. + + A colored blob, next to the person, showing which color is assigned to person. + :::{image} images/show_color.png + :width: 50% + ::: + + A marker ID from an aruco marker (note that a color blob is visualized as well here) + :::{image} images/show_marker_id.png + :width: 50% + ::: + +show number +: Shows the PeTrack id of a person + :::{image} images/show_number.png + :width: 50% + ::: + +show ground position +: Shows the projection of the head position to the ground + + :::{image} images/ground_projection.png + :width: 50% +::: + +### Show only + +There are a few options which allow to select people for visualization and consequently disable visualization for all other pedestrians. + +show only visible +: This option shows disables the visualization for all people that are not visible in the current frame. This way, the past trajectories of these pedestrians is not visible and does not clutter up the image. This option does not count as *selecting*, i.e. `show complete path` and `only selected` do not change their behavior due to this option. + + :::{image} images/only_visible_example.webp + :width: 80% + ::: + +select only people +: This spinbox allows to select a person by their PeTrack id. This person is then the only person visualized. If `only selected` is checked for tracking, only this person will get tracked as well. + + :::{warning} + If `only selected` is not checked, all pedestrians are tracked, even though only one is visualized! + ::: + + The buttons next to the spinbox allow to jump to certain frames. `goto` jumps into the middle of the trajectory. `begin` jumps to the first frame of the trajectory and `end` jumps to the last frame of the trajectory. + +show only people list +: Select multiple people. One can use a comma-separated list of id's or a range of id's written as e.g. `10-15`. Only the selected people are visualized anymore and if `only selected` is checked for tracking, only the selected people are tracked + + :::{image} images/show_only_people_list_widget.png + ::: + <br> + + :::{image} images/show_only_list_example.png + :width: 80% + ::: + + :::{warning} + If `only selected` is not checked, all pedestrians are tracked, even though only a few are visualized! + ::: + +show complete path +: This option changes `show path` to show the complete path (i.e. *all* past and future frames), if and only if there is an active selection (i.e. `show only people` or `show only people list` is active). If there is no active selection, this option does nothing. + +## Other Options + +Here some information on visualization options which are mostly for old markers. Mostly for completeness sake. This section can be skipped for most people. + +show color marker +: Helpful option for markers that include the color as extra point, e.g. the casern marker. The circle drawn by this is colored in the color that was detected and drawn around the colored portion of the marker. + :::{image} images/casern_visualization.png + :width: 50% + ::: + +show height/col. color/marker ID +: The height part of this visualization is for stereo cameras, which can measure the height of a person directly. If ``individual`` is selected, two height values are shown. The height measured in the current frame and the avg. height of the all frames. If `individual` is not selected, only the avg. is shown. + + :::{image} images/show_height.png + :width: 50% + ::: \ No newline at end of file