Skip to content

GitLab

Bathymetry · Changes

Page history
Update Bathymetry authored by Ramicés dos Santos Silva's avatar Ramicés dos Santos Silva
Hide whitespace changes
Inline Side-by-side
Bathymetry.md
View page @ 683d90c0
<details>
<summary>
[[_TOC_]]
</summary></details>
# Activity Documentation for Bathymetry Module
</summary>
This documentation provides a detailed explanation of the user interaction pages in the Bathymetry module.
## Diagram
[1100x1100px](arquivo:Bathmetry_Diagram.png "wikilink")
</details>
## MainPage(match)
_`This is the main page of the application. It handles the routes and redirects the user to the correct page according to the URL.`_
......@@ -108,13 +109,8 @@ This file represents the page that shows the results of the processing. It displ
The components folder contains various reusable components used throughout the application. These components may include UI elements, input fields, buttons, etc., which are utilized in the above-mentioned pages.
<details>
<summary>
## Code Used in Bathymetry
</summary>
### **MainPage**
This is the main page of the application. It contains the routes for the application and renders the appropriate components based on the route.
......@@ -205,7 +201,11 @@ Renders the bathymetry analysis workflow.
#### **Use**
This function is used to handle the bathymetry analysis workflow. It contains the steps required for bathymetry analysis like:1. Area of interest selection 2. Image selection 3. Bands and algorithm selection 4. Threshold selectionIt navigates between these steps based on the route and ensures the pre-requisites for each step are met before rendering them.
This function is used to handle the bathymetry analysis workflow. It contains the steps required for bathymetry analysis like:
1\. Area of interest selection 2. Image selection 3. Bands and algorithm selection 4. Threshold selection
It navigates between these steps based on the route and ensures the pre-requisites for each step are met before rendering them.
### **ProcessingBathemetryPage**
......@@ -244,7 +244,11 @@ Renders the results of the bathymetry analysis like the predicted bathymetry ima
#### **Use**
This function is used to display the results of the bathymetry analysis. It shows:1. The predicted bathymetry image 2. Statistics like RMSE, bias, slope etc. 3. Options to download the bathymetry image and statisticsIt handles processing the bathymetry analysis based on the inputs provided in the previous steps and displays the results to the user.
This function is used to display the results of the bathymetry analysis. It shows:
1\. The predicted bathymetry image 2. Statistics like RMSE, bias, slope etc. 3. Options to download the bathymetry image and statistics
It handles processing the bathymetry analysis based on the inputs provided in the previous steps and displays the results to the user.
### **ProcessingPage**
......@@ -278,7 +282,11 @@ Renders the results of the shoreline change analysis like shoreline change maps,
#### **Use**
This function is used to display the results of the shoreline change analysis. It shows:1. Shoreline change maps 2. Transect report 3. Transect evolution graphs 4. Options to download the resultsIt handles processing the shoreline change analysis based on the inputs provided in the previous steps and displays the results to the user.
This function is used to display the results of the shoreline change analysis. It shows:
1\. Shoreline change maps 2. Transect report 3. Transect evolution graphs 4. Options to download the results
It handles processing the shoreline change analysis based on the inputs provided in the previous steps and displays the results to the user.
### **SelectionPage**
......@@ -311,7 +319,11 @@ Renders the landing page of the application with options to start bathymetry ana
#### **Use**
This function is used to render the landing page of the application. It shows:1. An overview of the capabilities of the application like bathymetry analysis, shoreline change analysis and coastal squeeze. 2. Options to start bathymetry analysis, shoreline change analysis and coastal squeeze.When the user selects an option, they are navigated to the corresponding workflow.
This function is used to render the landing page of the application. It shows:
1\. An overview of the capabilities of the application like bathymetry analysis, shoreline change analysis and coastal squeeze. 2. Options to start bathymetry analysis, shoreline change analysis and coastal squeeze.
When the user selects an option, they are navigated to the corresponding workflow.
### **BathymetryBandsAndAlgorithmSelection**
......@@ -343,7 +355,9 @@ Renders options to select bands and graphs to select the algorithm for bathymetr
#### **Use**
This function is used to select bands and algorithm for bathymetry analysis. It shows:1. Options to select two bands for the analysis. 2. Graphs showing the relationship between the selected bands and depth. The user can select an algorithm by clicking on a graph. 3. It handles updating the store with the selected bands and algorithm so they can be used for bathymetry analysis.
This function is used to select bands and algorithm for bathymetry analysis. It shows:
1\. Options to select two bands for the analysis. 2. Graphs showing the relationship between the selected bands and depth. The user can select an algorithm by clicking on a graph. 3. It handles updating the store with the selected bands and algorithm so they can be used for bathymetry analysis.
### **AOIChooser**
......@@ -372,6 +386,4 @@ No input parameters for this function.
#### **Output:**
Renders a map to select the
</details>
Renders a map to select the
\ No newline at end of file