Skip to content

Commit

Permalink
#212 how to load an extracted shoreline session from a user who didn'…
Browse files Browse the repository at this point in the history
…t download your data
  • Loading branch information
2320sharon committed Apr 19, 2024
1 parent ca149ef commit dd211ae
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 1 deletion.
37 changes: 37 additions & 0 deletions docs/how-to-use-a-session-another-user.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
If you have a session from another user you want to load into CoastSeg follow these steps

## Guide 1 : You have the downloaded ROI imagery and the extracted shoreline session

**1.Move the ROI folders containing the imagery into CoastSeg/data**

**2.Move the new session folder(s) into CoastSeg/sessions**

**3.Click 'Load Session' and load the session folder from CoastSeg/sessions**

## Guide 2: You DO NOT have the downloaded ROI Imagery but DO have the extracted shoreline session

**1.Move the new session folder(s) into CoastSeg/sessions**

**2.Click 'Load Session' and load the session folder from CoastSeg/sessions**

**3.Get the Warning Message**

- A warning called 'Warning Missing Data' will appear listing the missing ROI IDs. In this case is ROI 'fvk3'

- Hover over the ROIs on the map (in red) and check the ROI drop download on the upper right to see the ID (hovering over ROI 'fvk3' in the screenshot )

**4.Download the ALL the ROIs**

- Click the ALL the ROIs and click 'Download Imagery' to download the data for these missing ROIs

-- Don't worry the code will automatically detect the ROI you already downloaded and won't download it, but you must select ALL the ROIs. This is because under the hood this creates a new session containing only the ROIs you have selected.

-- The download settings for the session will already have been loaded into so don't worry about changing them

![warning missing rois loaded from session](https://github.com/SatelliteShorelines/CoastSeg/assets/61564689/2c67676e-cf86-4493-884d-452bda356d26)


- As you can see in the screenshot below the first ROI downloads all the missing imagery, while the second ROI which we had the downloaded data for only downloads a single image because 5 images already exist.

![partial download 2 rois](https://github.com/SatelliteShorelines/CoastSeg/assets/61564689/86de7b4a-51de-47b8-9a00-b9d903aded39)

11 changes: 10 additions & 1 deletion docs/sessions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ Config files are used to save the current state of the map and all the data down
Under the `data` directory where all the downloaded ROIs are stored. Within each ROI's directory you will find a `config.geojson` file and a `config.json` file.

- `config.geojson` file that contains contains a geodataframe ( crs `espg 4326`) with all the ROIs, shorelines, transects, and the bounding box that were loaded on the map at the time the ROI was downloaded.

**Example: Loading the config.geojson into QGIS**

- You can see the Bounding Box, ROI, reference shorelines and transects for this session

![config_gdf_qgis](https://github.com/SatelliteShorelines/CoastSeg/assets/61564689/0fab574b-3714-46d2-bf78-c3bc9cb0622f)

- `config.json` file contains the settings that were used to download the imagery from Google Earth Engine(GEE).

# How to Save a New Session
Expand Down Expand Up @@ -40,7 +47,7 @@ To load config files for ROIs that have been downloaded before go to the `data`
2. Select a directory from the sessions directory
![load_extracted_shorelines_session](https://github.com/SatelliteShorelines/CoastSeg/assets/61564689/4d3ba936-3d86-48e1-9d2d-ea67a355c71d)

## Understanding config.json
## Config.json

config.json files can be found in session directories as well as within ROI directories within the data directory.

Expand All @@ -53,6 +60,8 @@ The config files are organized into 2 sections:

a. Settings used to download each ROI organized by each ROI's id

- One setting to pay attention to is the `output epsg` this is the CRS the ROI and all its features are re-projected features into and these re-projected features are the ones used to calculate the shoreline transect intersections.

- The following settings are associated with ROI 0:
- ROI 0 has imagery for dates "2018-01-01" - "2019-01-01" and it was saved to the `ID_0_datetime03-22-23__07_29_15` directory at
`C:\\1_CoastSeg\\1_official_CoastSeg_repo\\CoastSeg\\data`.
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ nav:
- Download Settings Guide: download_settings.md
- How to Upload Features: how-to-upload-features.md
- How to Use Sessions: sessions.md
- How to Use Sessions from Another User: how-to-use-a-session-another-user.md
- How to Use Extract Shoreline Area: how-to-extract-shoreline-area.md
- How to Extract Shorelines: extract_shorelines.md
- Extract Shorelines Settings Guide: extract_shoreline_settings.md
Expand Down

0 comments on commit dd211ae

Please sign in to comment.