From 926a95ba6143809ccffe40037b8f0afca5601df8 Mon Sep 17 00:00:00 2001 From: Alicia Westad Rasmussen Date: Wed, 29 Oct 2025 14:21:08 +0100 Subject: [PATCH] Co-authored-by: klein2303 --- README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/README.md b/README.md index 7b38baf..5b80ae5 100644 --- a/README.md +++ b/README.md @@ -63,3 +63,62 @@ Then in a new terminal run the tests: ```bash npm run test ``` + + +## Purpose + +## Functionalities +### Moving the viewpoint +Left click and hold anywhere on the screen, while moving the mouse or use a second finger on the touchpad to dynamically move the viewpoint. By doing this you can tilt and rotate the viewpoint. + +### Zoom +To zoom in and out the user can either: +1. Utilize the scroll wheel on a mouse. +2. Drag two fingers on the touchpad towards each other or away from each other. + +### Move +To move within the application, double click on a point and you will automatically be moved to that point. +If you want to move across larger distances, for example look at a point from a different point cloud, it is recommended to zoom out first and then choose a point closer to where you want to be positioned. +###Coordinates +In the bottom right corner there is a black box that lists coordinates. These coordinates correspond to the target point, which is continuously updated to be the most resent point the user has clicked on. Latitude and longitude are measured in degrees, while elevation is measured in metres from the surface level. + +### Menu Bar +The icon of three vertical lines stacked in the top left corner show and collapses the sidebar where most of the functionalities are located. + +### Minimap +The map icon below the menu bar icon in the top left corner, will show and collapse a minimap. +In the minimap you can zoom using the mouse, touchpad or the icons in the top left corner. +You can move around by clicking and moving the mouse around simultaneously. + +### Points +Points can be saved by clicking on the icon in the image below in the Measurements tab, then clicking on the point in the point cloud. +A point will show up under list of measurements and points in a list. +XYZ values ask Klein +The x y z coordinates at the top are Earth Cantered Earth Fixed(ECEF) coordinates, EPSG 4978. +The data for each point in the table below is: latitude and longitude in degrees, elevation measured from the sea level, point source, accepted status, Total Vertical Uncertainty(TVU) and Total Horizontal Uncertainty(THU). +To delete a point, click on the red x to the right of the point in the List of measurements. +There is added toggle functionality below the list of points to hide and show all point labels on the point cloud, see image below. + +### Annotations +Annotations can be created under the Saved Locations section in the side bar. Click the Add a location button, then click on a point in the point cloud. As you hover over points in the point cloud, there should be an annotation label above the cursor to confirm that you can choose a point now. +The annotation will be added to a list below the add a location button upon creation. +There are three icons on the annotation. The pen icon allows you to rename the annotation, the arrow icon allows you to lerp to the annotation from anywhere on the map and the red x icon will delete the annotation. +When pressing the annotation text on the saved annotation, you can add a description by clicking the pen icon to the right of Annotation Description. The point coordinates and the camera coordinates will be displayed below the annotation description. +There is added toggle functionality below the list of annotations to hide and show all annotation labels on the point cloud, see image below. + +### Compass +Under Tools in the menu bar, there is a compass icon that will display a compass in the top right corner when you press it. Collapse it by clicking once more on the compass icon in the menu bar. + +### Colour scale +There are nine different gradient schemes to choose from under the Elevation Control tab. You change the colour scale for all the point clouds by clicking them. + +### Elevation Control +Elevation control applies gradient based on the elevation of the data points, and can be adjusted on the elevation range slider under the elevation control tab. + +### Height Profile +Under Measurements in the menu bar there is functionality to create a height profile. Click the 2D height profile icon showed in the image below. Now you can click on the desired points in the point cloud. The order you click on the points matter, start with clicking on the first point you want to show up in the diagram, move to the second point and so on. When you have clicked on all the points you want to include, you can right click anywhere in the point cloud to exit this add point mode. Go back to the menu bar, the points will be saved under List of Measurements for the profile you made. Display the height profile by clicking the show 2d profile button at the bottom of the measurements section. If nothing shows up, make sure that your desired profile is selected first under list of measurements and profile, by clicking on it. When you chow the height profile, you can hover over the 2D profile and see a marker in the point cloud move, visualizing where the points are taken from. Collapse the height profile by clicking at the black x in the top right corner of the pop-up window. + +### Filtering for accepted points +Under the Accepted Filter tab in the menu bar there is a button for Activate accepted filter. When pressing this button, all the points in the point clouds will be displayed as either black: for not accepted or white: for accepted. The acceptance data of a point is an attribute that shows whether the point is accepted as part of the seabed. +To display the point cloud with colour again, go to the elevation control tab and press the activate elevation control button. +