Skip to content

Commit

Permalink
add a guide on how to upload features
Browse files Browse the repository at this point in the history
  • Loading branch information
2320sharon committed Apr 19, 2024
1 parent efd0d66 commit fee8089
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 5 deletions.
30 changes: 25 additions & 5 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ jupyter lab SDS_coastsat_classifier.ipynb
**5.Load Transects**
![load_rois_then_transects_on_map_demo](https://github.com/Doodleverse/CoastSeg/assets/61564689/d53154b0-7a63-470f-91ec-dabdf7d4a100)

- Make sure there are transects inside the ROI you have selected otherwise you won't be able to extract shorelines

**6.Modify the Settings**

- Change the satellites to L8 and L9
Expand All @@ -57,41 +59,59 @@ jupyter lab SDS_coastsat_classifier.ipynb

**7.Name the Session**

- Let's call this 'sample_session'

- This is the name of the folder that will be saved in `CoastSeg/sessions`

- It will contain a subdirectory for each ROI that shorelines will be extracted for

**8.Download the ROIs**

- Click the ROIs you want to download on the map ( they will turn blue when selected)

- Make sure there are transects inside the ROI you have selected otherwise you won't be able to extract shorelines

- If no transects or reference shorelines are available for the region you have uploaded follow the guide here

- NEVER rename your ROIs this is because CoastSeg keeps track of the filename in the 'config.json' and you won't be able to load it into CoastSeg again if you do. The ROI's ID is the filename so that information will be lost if you rename it.

**9.Extract Shorelines**
![save_settings_download_extract](https://github.com/Doodleverse/CoastSeg/assets/61564689/3548a9ce-a190-4c95-b495-0ff75484fdb2)

- Extracting shorelines works by finding the land water interface in the image and drawing a line along it

- A time series of shoreline position along each transect is generated as well

![shoreline_transect_intersection](https://github.com/SatelliteShorelines/CoastSeg/assets/61564689/e87b8d34-d9a4-4b1e-b3de-8e0be1c16ecd)

## Apply Tidal Correction to Extracted Shorelines (Optional)

**1.Download the tide model**

- Before tidal correction can be applied the tide model must be downloaded

- Follow the tutorial: [How to Download Tide Model](https://github.com/Doodleverse/CoastSeg/wiki/09.-How-to-Download-Tide-Model)
- Follow the tutorial: [How to Download Tide Model](https://satelliteshorelines.github.io/CoastSeg/How-to-Download-Tide-Model/)

**2.Load the Session with Extracted Shorelines**

- Re-open the jupyter notebook

- Under the Kernal menu Click 'restart and clear outputs of all cells'
- Under the 'Kernel' menu Click 'restart and clear outputs of all cells'

![restart kernel and clear outputs of all cells](https://github.com/SatelliteShorelines/CoastSeg/assets/61564689/a7d09bcb-6c35-48b2-b28a-a6821881e503)

- Click Load Session and load the same we made before ''
- Click 'Load Session' and load 'sample_session'

![select load session and tide correct](https://github.com/SatelliteShorelines/CoastSeg/assets/61564689/581f8b4a-062e-4326-9ae8-0145026fb9ad)

**3.Click Correct Tides**

- Click the ROI ID from the dropdown

-- You should see some extracted shorelines on the map if you don't then the ROI ID won't appear in the dropdown

- Enter Beach Slope

- Enter Beach Elevation relative to Mean Sea Level

![select roi id for tide correction](https://github.com/SatelliteShorelines/CoastSeg/assets/61564689/9e212590-1f1e-4c51-b223-2e49a329a524)

![load_session_correct_tides_demo](https://github.com/Doodleverse/CoastSeg/assets/61564689/d7a34d13-7c01-4a30-98b3-706a63195aa7)
17 changes: 17 additions & 0 deletions docs/how-to-upload-features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## How to Load Features from Geojson Files

**1.Click the dropdown from under 'Load Feature from File'**

- Select the feature you want on the map.

**2.Click the load button from under 'Load Feature from File'**

- This opens a file dialog window where you can select the geojson file you want to load on the map.

![load feature from file](https://github.com/SatelliteShorelines/CoastSeg/assets/61564689/3e314de6-a742-46e9-b390-36d66e7aaba9)

**3.Select a geoJSON file containing the feature**

- If the geojson file is too large or has too many large features the map may become very slow. It is highly recommended to only load small features onto the map.

![load_geojson_files_demo](https://github.com/SatelliteShorelines/CoastSeg/assets/61564689/4fedfb32-b36b-4203-a9af-228f927ca0a8)
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ nav:
- How to Use the Map: map_guide.md
- How to use the ROI: roi.md
- How to Download Imagery: how-to-download.md
- How to Upload Features: how-to-upload-features.md
- How to Use Sessions: sessions.md
- How to Use Extract Shoreline Area: how-to-extract-shoreline-area.md
- How to Extract Shorelines: extract_shorelines.md
Expand Down

0 comments on commit fee8089

Please sign in to comment.