coastseg 0.0.72.dev6__tar.gz → 0.0.72.dev8__tar.gz

{coastseg-0.0.72.dev6/src/coastseg.egg-info → coastseg-0.0.72.dev8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: coastseg
-Version: 0.0.72.dev6
+Version: 0.0.72.dev8
 Summary: An interactive jupyter notebook for downloading satellite imagery
 Author-email:  Sharon Fitzpatrick <sharon.fitzpatrick23@gmail.com>
 License: MIT License
@@ -37,6 +37,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 
 # CoastSeg
+
 [![image](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/2320sharon/CoastSeg/blob/main/coastseg_for_google_colab.ipynb)
 
 [![image](https://img.shields.io/pypi/v/coastseg.svg?color=%23ec3dc8)](https://pypi.python.org/pypi/coastseg)
@@ -56,8 +57,8 @@ License-File: LICENSE
 
 ![official_coastseg](https://user-images.githubusercontent.com/61564689/212394936-263ec9fc-fb82-45b8-bc79-bc57dafdae73.gif)
 
-
 ## What is CoastSeg?
+
 Coastseg stands for Coastal Segmentation, it is an interactive jupyter notebook for downloading satellite imagery with [CoastSat](https://github.com/kvos/CoastSat) and applying image segmentation models to satellite imagery. CoastSeg provides an interactive interface for drawing Regions of Interest (ROIs) on a map, downloading satellite imagery, loading geojson files, extracting shorelines from satellite imagery, and more.
 
 - A mapping extension for [CoastSat](https://github.com/kvos/CoastSat) using [Segmentation Zoo](https://github.com/Doodleverse/segmentation_zoo) models.
@@ -66,27 +67,31 @@ Coastseg stands for Coastal Segmentation, it is an interactive jupyter notebook
 - An interactive interface to apply segmentation models to satellite imagery
 
 ![gif of map with rectangles on it](https://github.com/SatelliteShorelines/CoastSeg/blob/main/docs/gifs/create_rois_demo.gif)
+
 - Create ROIs(regions of interest) along the coast and automatically load shorelines on the map.
-- Use Google Earth Engine to automatically download satellite imagery for each ROI clicked on the map. 
+- Use Google Earth Engine to automatically download satellite imagery for each ROI clicked on the map.
 
 ![gif of map with extracted shorelines on it](https://github.com/SatelliteShorelines/CoastSeg/blob/main/docs/gifs/extract_shorelines_and_transects.gif)
+
 - Coastseg can automatically extract shorelines from downloaded satellite imagery.
 
-## Table of Contents 
-- [Installation Instructions](#installation-instructions)  
+## Table of Contents
+
+- [Installation Instructions](#installation-instructions)
 - [Getting Started](#getting-tarted)
 
 ## Useful Links
+
 - [Wiki](https://github.com/SatelliteShorelines/CoastSeg/wiki)
 - [Discussion](https://github.com/SatelliteShorelines/CoastSeg/discussions)
 - [Contribution Guide](https://github.com/SatelliteShorelines/CoastSeg/wiki/Contribution-Guide)
 
-
 ## Installation Instructions
 
 In order to use Coastseg you need to install Python packages in an environment. We recommend you use [Anaconda](https://www.anaconda.com/products/distribution) to install the python packages in an environment for Coastseg. After you install Anaconda on your PC, open the Anaconda prompt or Terminal in Mac and Linux and use the `cd` command (change directory) to go the folder where you have downloaded the Coastseg repository.
 
 1. Create an Anaconda environment
+
 - This command creates an anaconda environment named `coastseg` and installs `python 3.10` in it.
   ```bash
   conda create --name coastseg python=3.10 -y
@@ -117,10 +122,22 @@ In order to use Coastseg you need to install Python packages in an environment.
    ```
 5. Uninstall the h5py installed by pip and reinstall with conda-forge
    ```bash
-   pip uninstall h5py
-   conda install -c conda-forge h5py
+   pip uninstall h5py -y
+   conda install -c conda-forge h5py -y
    ```
 
+## How to Update
+
+### Update to a specific version
+
+- To update coastseg to a specific version specify the version after the `==`
+
+`pip install coastseg==0.0.72.dev6`
+
+### Update to the latest version
+
+`pip install coastseg --upgrade`
+
 ## **Having Installation Errors?**
 
 Use the command `conda clean --all` to clean old packages from your anaconda base environment. Ensure you are not in your coastseg environment or any other environment by running `conda deactivate`, to deactivate any environment you're in before running `conda clean --all`. It is recommended that you have Anaconda prompt (terminal for Mac and Linux) open as an administrator before you attempt to install `coastseg` again.
@@ -138,7 +155,6 @@ conda clean --all
 
 First, you need to request access to Google Earth Engine at https://signup.earthengine.google.com/. It takes about 1 day for Google to approve requests.
 
-
 2. Activate your conda environment
 
    ```bash
@@ -157,14 +173,13 @@ Once you’ve created the coastseg environment you’ll need to run `git clone`
 4. Launch Jupyter Lab
 
 - Run this command in the coastseg directory to launch the notebook `SDS_coastsat_classifier`
-   ```bash
-   jupyter lab SDS_coastsat_classifier.ipynb
-   ```
-
-5. Use the `SDS_coastsat_classifier` to Download Imagery 
+  ```bash
+  jupyter lab SDS_coastsat_classifier.ipynb
+  ```
 
-Check out the wiki guide  [How to Download Imagery](https://github.com/Doodleverse/CoastSeg/wiki/2.-How-to-Download-Imagery) for comprehensive guides for how to use coastseg to download imagery and apply image segmentation models to the imagery you download. 
+5. Use the `SDS_coastsat_classifier` to Download Imagery
 
+Check out the wiki guide [How to Download Imagery](https://github.com/Doodleverse/CoastSeg/wiki/2.-How-to-Download-Imagery) for comprehensive guides for how to use coastseg to download imagery and apply image segmentation models to the imagery you download.
 
 # Authors
 
@@ -179,7 +194,9 @@ Contributions:
 - [@kvos](https://github.com/kvos)
 
 ## Citations
+
 Thank you to all the amazing research who contributed their transects to coastseg.
+
 1. Hawaii small islands https://pubs.usgs.gov/of/2011/1009/data.html
 2. Barter Island, Alaska https://www.sciencebase.gov/catalog/item/5fa1f10ad34e198cb793cee4
 3. Pacific Northwest, Gulf, and SE USA: Dr Sean Vitousek, USGS-PCMSC, based on DSAS transects

{coastseg-0.0.72.dev6 → coastseg-0.0.72.dev8}/README.md

@@ -1,4 +1,5 @@
 # CoastSeg
+
 [![image](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/2320sharon/CoastSeg/blob/main/coastseg_for_google_colab.ipynb)
 
 [![image](https://img.shields.io/pypi/v/coastseg.svg?color=%23ec3dc8)](https://pypi.python.org/pypi/coastseg)
@@ -18,8 +19,8 @@
 
 ![official_coastseg](https://user-images.githubusercontent.com/61564689/212394936-263ec9fc-fb82-45b8-bc79-bc57dafdae73.gif)
 
-
 ## What is CoastSeg?
+
 Coastseg stands for Coastal Segmentation, it is an interactive jupyter notebook for downloading satellite imagery with [CoastSat](https://github.com/kvos/CoastSat) and applying image segmentation models to satellite imagery. CoastSeg provides an interactive interface for drawing Regions of Interest (ROIs) on a map, downloading satellite imagery, loading geojson files, extracting shorelines from satellite imagery, and more.
 
 - A mapping extension for [CoastSat](https://github.com/kvos/CoastSat) using [Segmentation Zoo](https://github.com/Doodleverse/segmentation_zoo) models.
@@ -28,27 +29,31 @@ Coastseg stands for Coastal Segmentation, it is an interactive jupyter notebook
 - An interactive interface to apply segmentation models to satellite imagery
 
 ![gif of map with rectangles on it](https://github.com/SatelliteShorelines/CoastSeg/blob/main/docs/gifs/create_rois_demo.gif)
+
 - Create ROIs(regions of interest) along the coast and automatically load shorelines on the map.
-- Use Google Earth Engine to automatically download satellite imagery for each ROI clicked on the map. 
+- Use Google Earth Engine to automatically download satellite imagery for each ROI clicked on the map.
 
 ![gif of map with extracted shorelines on it](https://github.com/SatelliteShorelines/CoastSeg/blob/main/docs/gifs/extract_shorelines_and_transects.gif)
+
 - Coastseg can automatically extract shorelines from downloaded satellite imagery.
 
-## Table of Contents 
-- [Installation Instructions](#installation-instructions)  
+## Table of Contents
+
+- [Installation Instructions](#installation-instructions)
 - [Getting Started](#getting-tarted)
 
 ## Useful Links
+
 - [Wiki](https://github.com/SatelliteShorelines/CoastSeg/wiki)
 - [Discussion](https://github.com/SatelliteShorelines/CoastSeg/discussions)
 - [Contribution Guide](https://github.com/SatelliteShorelines/CoastSeg/wiki/Contribution-Guide)
 
-
 ## Installation Instructions
 
 In order to use Coastseg you need to install Python packages in an environment. We recommend you use [Anaconda](https://www.anaconda.com/products/distribution) to install the python packages in an environment for Coastseg. After you install Anaconda on your PC, open the Anaconda prompt or Terminal in Mac and Linux and use the `cd` command (change directory) to go the folder where you have downloaded the Coastseg repository.
 
 1. Create an Anaconda environment
+
 - This command creates an anaconda environment named `coastseg` and installs `python 3.10` in it.
   ```bash
   conda create --name coastseg python=3.10 -y
@@ -79,10 +84,22 @@ In order to use Coastseg you need to install Python packages in an environment.
    ```
 5. Uninstall the h5py installed by pip and reinstall with conda-forge
    ```bash
-   pip uninstall h5py
-   conda install -c conda-forge h5py
+   pip uninstall h5py -y
+   conda install -c conda-forge h5py -y
    ```
 
+## How to Update
+
+### Update to a specific version
+
+- To update coastseg to a specific version specify the version after the `==`
+
+`pip install coastseg==0.0.72.dev6`
+
+### Update to the latest version
+
+`pip install coastseg --upgrade`
+
 ## **Having Installation Errors?**
 
 Use the command `conda clean --all` to clean old packages from your anaconda base environment. Ensure you are not in your coastseg environment or any other environment by running `conda deactivate`, to deactivate any environment you're in before running `conda clean --all`. It is recommended that you have Anaconda prompt (terminal for Mac and Linux) open as an administrator before you attempt to install `coastseg` again.
@@ -100,7 +117,6 @@ conda clean --all
 
 First, you need to request access to Google Earth Engine at https://signup.earthengine.google.com/. It takes about 1 day for Google to approve requests.
 
-
 2. Activate your conda environment
 
    ```bash
@@ -119,14 +135,13 @@ Once you’ve created the coastseg environment you’ll need to run `git clone`
 4. Launch Jupyter Lab
 
 - Run this command in the coastseg directory to launch the notebook `SDS_coastsat_classifier`
-   ```bash
-   jupyter lab SDS_coastsat_classifier.ipynb
-   ```
-
-5. Use the `SDS_coastsat_classifier` to Download Imagery 
+  ```bash
+  jupyter lab SDS_coastsat_classifier.ipynb
+  ```
 
-Check out the wiki guide  [How to Download Imagery](https://github.com/Doodleverse/CoastSeg/wiki/2.-How-to-Download-Imagery) for comprehensive guides for how to use coastseg to download imagery and apply image segmentation models to the imagery you download. 
+5. Use the `SDS_coastsat_classifier` to Download Imagery
 
+Check out the wiki guide [How to Download Imagery](https://github.com/Doodleverse/CoastSeg/wiki/2.-How-to-Download-Imagery) for comprehensive guides for how to use coastseg to download imagery and apply image segmentation models to the imagery you download.
 
 # Authors
 
@@ -141,7 +156,9 @@ Contributions:
 - [@kvos](https://github.com/kvos)
 
 ## Citations
+
 Thank you to all the amazing research who contributed their transects to coastseg.
+
 1. Hawaii small islands https://pubs.usgs.gov/of/2011/1009/data.html
 2. Barter Island, Alaska https://www.sciencebase.gov/catalog/item/5fa1f10ad34e198cb793cee4
 3. Pacific Northwest, Gulf, and SE USA: Dr Sean Vitousek, USGS-PCMSC, based on DSAS transects

{coastseg-0.0.72.dev6 → coastseg-0.0.72.dev8}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "coastseg"
 dynamic = ["readme"]
-version = "0.0.72.dev6" 
+version = "0.0.72.dev8" 
 authors = [
   { name=" Sharon Fitzpatrick", email="sharon.fitzpatrick23@gmail.com" },
 ]

{coastseg-0.0.72.dev6 → coastseg-0.0.72.dev8}/src/coastseg/coastseg_map.py

@@ -3,7 +3,7 @@ import os
 import json
 import logging
 import glob
-from typing import List, Optional, Tuple, Union
+from typing import Dict, List, Optional, Tuple, Union
 from collections import defaultdict
 
 from coastseg.bbox import Bounding_Box
@@ -33,6 +33,8 @@ from ipyleaflet import GeoJSON
 
 logger = logging.getLogger(__name__)
 
+SELECTED_LAYER_NAME = "Selected Shorelines"
+
 
 class CoastSeg_Map:
     def __init__(self):
@@ -58,6 +60,7 @@ class CoastSeg_Map:
 
         # ids of the selected rois
         self.selected_set = set()
+        self.selected_shorelines_set = set()
 
         # map objects
         self.rois = None
@@ -1602,7 +1605,6 @@ class CoastSeg_Map:
             f"layer_name {layer_name} \non_hover {on_hover}\n on_click {on_click}"
         )
         self.remove_layer_by_name(layer_name)
-        exception_handler.check_empty_layer(new_layer, layer_name)
         # when feature is hovered over on_hover function is called
         if on_hover is not None:
             new_layer.on_hover(on_hover)
@@ -1623,6 +1625,36 @@ class CoastSeg_Map:
         del self.rois
         self.rois = None
 
+    def remove_selected_shorelines(self) -> None:
+        """Removes all the unselected rois from the map"""
+        logger.info("Removing selected shorelines from map")
+        # Remove the selected and unselected rois
+        self.remove_layer_by_name(SELECTED_LAYER_NAME)
+        self.remove_layer_by_name(Shoreline.LAYER_NAME)
+        # delete selected ROIs from dataframe
+        if self.shoreline:
+            self.shoreline.remove_by_id(self.selected_shorelines_set)
+        # clear all the ids from the selected set
+        self.selected_shorelines_set = set()
+        # reload rest of ROIs on map
+        self.load_feature_on_map(
+            "shoreline", gdf=self.shoreline.gdf, zoom_to_bounds=True
+        )
+
+    def remove_selected_rois(self) -> None:
+        """Removes all the unselected rois from the map"""
+        logger.info("Removing selected ROIs from map")
+        # Remove the selected and unselected rois
+        self.remove_layer_by_name(ROI.SELECTED_LAYER_NAME)
+        self.remove_layer_by_name(ROI.LAYER_NAME)
+        # delete selected ROIs from dataframe
+        if self.rois:
+            self.rois.remove_by_id(self.selected_set)
+        # clear all the ids from the selected set
+        self.selected_set = set()
+        # reload rest of ROIs on map
+        self.load_feature_on_map("roi", gdf=self.rois.gdf, zoom_to_bounds=True)
+
     def create_DrawControl(self, draw_control: "ipyleaflet.leaflet.DrawControl"):
         """Modifies given draw control so that only rectangles can be drawn
 
@@ -1880,6 +1912,8 @@ class CoastSeg_Map:
         on_click = None
         if "roi" in feature_name.lower():
             on_click = self.geojson_onclick_handler
+        elif "shoreline" in feature_name.lower():
+            on_click = self.shoreline_onclick_handler
         return on_click
 
     def get_on_hover_handler(self, feature_name: str) -> callable:
@@ -1944,24 +1978,17 @@ class CoastSeg_Map:
         """
         if properties is None:
             return
-        logger.info(f"properties : {properties}")
-        logger.info(f"ROI_id : {properties['id']}")
-        logger.info(type(event))
-        logger.info(type(id))
-        logger.info(id)
         # Add id of clicked ROI to selected_set
-        ROI_id = str(properties["id"])
-        self.selected_set.add(ROI_id)
-        logger.info(f"Added ID to selected set: {self.selected_set}")
+        self.selected_set.add(str(properties["id"]))
         # remove old selected layer
         self.remove_layer_by_name(ROI.SELECTED_LAYER_NAME)
-
         selected_layer = GeoJSON(
-            data=self.convert_selected_set_to_geojson(self.selected_set),
+            data=self.convert_selected_set_to_geojson(
+                self.selected_set, ROI.LAYER_NAME
+            ),
             name=ROI.SELECTED_LAYER_NAME,
             hover_style={"fillColor": "blue", "fillOpacity": 0.1, "color": "aqua"},
         )
-        logger.info(f"selected_layer: {selected_layer}")
         self.replace_layer_by_name(
             ROI.SELECTED_LAYER_NAME,
             selected_layer,
@@ -1969,6 +1996,77 @@ class CoastSeg_Map:
             on_hover=self.update_roi_html,
         )
 
+    def shoreline_onclick_handler(
+        self,
+        event: str = None,
+        id: int = None,
+        properties: dict = None,
+        **args,
+    ):
+        """On click handler for when unselected geojson is clicked.
+
+        Adds object's id to selected_objects_set. Replaces current selected layer with a new one that includes
+        recently clicked geojson.
+
+        Args:
+            event (str, optional): event fired ('click'). Defaults to None.
+            id (NoneType, optional):  Defaults to None.
+            properties (dict, optional): geojson dict for clicked geojson. Defaults to None.
+        """
+        if properties is None:
+            return
+        # Add id of clicked shape to selected_set
+        self.selected_shorelines_set.add(str(properties["id"]))
+        # remove old selected layer
+        self.remove_layer_by_name(SELECTED_LAYER_NAME)
+        selected_layer = GeoJSON(
+            data=self.convert_selected_set_to_geojson(
+                self.selected_shorelines_set, Shoreline.LAYER_NAME
+            ),
+            name=SELECTED_LAYER_NAME,
+            hover_style={"fillColor": "orange", "fillOpacity": 0.1, "color": "orange"},
+        )
+        self.replace_layer_by_name(
+            SELECTED_LAYER_NAME,
+            selected_layer,
+            on_click=self.selected_shoreline_onclick_handler,
+            on_hover=None,
+        )
+
+    def selected_shoreline_onclick_handler(
+        self, event: str = None, id: "NoneType" = None, properties: dict = None, **args
+    ):
+        """On click handler for selected geojson layer.
+
+        Removes clicked layer's cid from the selected_set and replaces the select layer with a new one with
+        the clicked layer removed from select_layer.
+
+        Args:
+            event (str, optional): event fired ('click'). Defaults to None.
+            id (NoneType, optional):  Defaults to None.
+            properties (dict, optional): geojson dict for clicked selected geojson. Defaults to None.
+        """
+        if properties is None:
+            return
+
+        # Remove the current layers cid from selected set
+        self.selected_shorelines_set.remove(str(properties["id"]))
+        self.remove_layer_by_name(SELECTED_LAYER_NAME)
+        # Recreate selected layers without layer that was removed
+        selected_layer = GeoJSON(
+            data=self.convert_selected_set_to_geojson(
+                self.selected_shorelines_set, Shoreline.LAYER_NAME
+            ),
+            name=SELECTED_LAYER_NAME,
+            hover_style={"fillColor": "orange", "fillOpacity": 0.1, "color": "orange"},
+        )
+        self.replace_layer_by_name(
+            SELECTED_LAYER_NAME,
+            selected_layer,
+            on_click=self.selected_shoreline_onclick_handler,
+            on_hover=None,
+        )
+
     def selected_onclick_handler(
         self, event: str = None, id: "NoneType" = None, properties: dict = None, **args
     ):
@@ -1985,16 +2083,13 @@ class CoastSeg_Map:
         if properties is None:
             return
         # Remove the current layers cid from selected set
-        logger.info(f"selected_onclick_handler: properties : {properties}")
-        logger.info(f"selected_onclick_handler: ROI_id to remove : {properties['id']}")
-        cid = properties["id"]
-        self.selected_set.remove(cid)
-        logger.info(f"selected set after ID removal: {self.selected_set}")
+        self.selected_set.remove(properties["id"])
         self.remove_layer_by_name(ROI.SELECTED_LAYER_NAME)
         # Recreate selected layers without layer that was removed
-
         selected_layer = GeoJSON(
-            data=self.convert_selected_set_to_geojson(self.selected_set),
+            data=self.convert_selected_set_to_geojson(
+                self.selected_set, ROI.LAYER_NAME
+            ),
             name=ROI.SELECTED_LAYER_NAME,
             hover_style={"fillColor": "blue", "fillOpacity": 0.1, "color": "aqua"},
         )
@@ -2034,32 +2129,46 @@ class CoastSeg_Map:
             else:
                 print(f"Empty {feature.LAYER_NAME} cannot be saved to file")
 
-    def convert_selected_set_to_geojson(self, selected_set: set) -> dict:
+    def convert_selected_set_to_geojson(
+        self, selected_set: set, layer_name: str, style: Optional[Dict] = None
+    ) -> Dict:
         """Returns a geojson dict containing a FeatureCollection for all the geojson objects in the
         selected_set
         Args:
             selected_set (set): ids of selected geojson
+            layer_name (str): name of the layer to get geometries from
+            style (Optional[Dict]): style dictionary to be applied to each selected feature.
+                If no style is provided then a default style is used:
+                style = {
+                    "color": "blue",
+                    "weight": 2,
+                    "fillColor": "blue",
+                    "fillOpacity": 0.1,
+                }
         Returns:
-           dict: geojson dict containing FeatureCollection for all geojson objects in selected_set
+            Dict: geojson dict containing FeatureCollection for all geojson objects in selected_set
         """
-        # create a new geojson dictionary to hold selected ROIs
-        selected_rois = {"type": "FeatureCollection", "features": []}
-        roi_layer = self.map.find_layer(ROI.LAYER_NAME)
-        # if ROI layer does not exist throw an error
-        if roi_layer is not None:
-            exception_handler.check_empty_layer(roi_layer, "ROI")
-        # Copy only selected ROIs with id in selected_set
-        selected_rois["features"] = [
-            feature
-            for feature in roi_layer.data["features"]
-            if feature["properties"]["id"] in selected_set
-        ]
-        # Each selected ROI will be blue and unselected rois will appear black
-        for feature in selected_rois["features"]:
-            feature["properties"]["style"] = {
+        # create a new geojson dictionary to hold selected shapes
+        if style is None:
+            style = {
                 "color": "blue",
                 "weight": 2,
                 "fillColor": "blue",
                 "fillOpacity": 0.1,
             }
-        return selected_rois
+        selected_shapes = {"type": "FeatureCollection", "features": []}
+        layer = self.map.find_layer(layer_name)
+        # if ROI layer does not exist throw an error
+        if layer is not None:
+            exception_handler.check_empty_layer(layer, layer_name)
+        # Copy only selected features with id in selected_set
+        selected_features = [
+            feature
+            for feature in layer.data["features"]
+            if feature["properties"]["id"] in selected_set
+        ]
+        selected_shapes["features"] = [
+            {**feature, "properties": {**feature["properties"], "style": style}}
+            for feature in selected_features
+        ]
+        return selected_shapes