geoai-py 0.5.0__py2.py3-none-any.whl → 0.5.2__py2.py3-none-any.whl

geoai/__init__.py

@@ -2,7 +2,7 @@
 
 __author__ = """Qiusheng Wu"""
 __email__ = "giswqs@gmail.com"
-__version__ = "0.5.0"
+__version__ = "0.5.2"
 
 
 import os

geoai/geoai.py

@@ -1,6 +1,7 @@
 """Main module."""
 
 import leafmap
+import leafmap.maplibregl as maplibregl
 
 from .download import (
     download_naip,
@@ -17,7 +18,7 @@ from .classify import train_classifier, classify_image, classify_images
 from .extract import *
 from .hf import *
 from .segment import *
-from .train import object_detection, train_MaskRCNN_model
+from .train import object_detection, object_detection_batch, train_MaskRCNN_model
 from .utils import *
 
 
@@ -27,3 +28,180 @@ class Map(leafmap.Map):
     def __init__(self, *args, **kwargs):
         """Initialize the Map class."""
         super().__init__(*args, **kwargs)
+
+
+class MapLibre(maplibregl.Map):
+    """A subclass of maplibregl.Map for GeoAI applications."""
+
+    def __init__(self, *args, **kwargs):
+        """Initialize the MapLibre class."""
+        super().__init__(*args, **kwargs)
+
+
+def create_vector_data(
+    m: Optional[Map] = None,
+    properties: Optional[Dict[str, List[Any]]] = None,
+    time_format: str = "%Y%m%dT%H%M%S",
+    column_widths: Optional[List[int]] = (9, 3),
+    map_height: str = "600px",
+    out_dir: Optional[str] = None,
+    filename_prefix: str = "",
+    file_ext: str = "geojson",
+    add_mapillary: bool = False,
+    style: str = "photo",
+    radius: float = 0.00005,
+    width: int = 300,
+    height: int = 420,
+    frame_border: int = 0,
+    **kwargs: Any,
+):
+    """Generates a widget-based interface for creating and managing vector data on a map.
+
+    This function creates an interactive widget interface that allows users to draw features
+    (points, lines, polygons) on a map, assign properties to these features, and export them
+    as GeoJSON files. The interface includes a map, a sidebar for property management, and
+    buttons for saving, exporting, and resetting the data.
+
+    Args:
+        m (Map, optional): An existing Map object. If not provided, a default map with
+            basemaps and drawing controls will be created. Defaults to None.
+        properties (Dict[str, List[Any]], optional): A dictionary where keys are property names
+            and values are lists of possible values for each property. These properties can be
+            assigned to the drawn features. Defaults to None.
+        time_format (str, optional): The format string for the timestamp used in the exported
+            filename. Defaults to "%Y%m%dT%H%M%S".
+        column_widths (Optional[List[int]], optional): A list of two integers specifying the
+            relative widths of the map and sidebar columns. Defaults to (9, 3).
+        map_height (str, optional): The height of the map widget. Defaults to "600px".
+        out_dir (str, optional): The directory where the exported GeoJSON files will be saved.
+            If not provided, the current working directory is used. Defaults to None.
+        filename_prefix (str, optional): A prefix to be added to the exported filename.
+            Defaults to "".
+        file_ext (str, optional): The file extension for the exported file. Defaults to "geojson".
+        add_mapillary (bool, optional): Whether to add a Mapillary image widget that displays the
+            nearest image to the clicked point on the map. Defaults to False.
+        style (str, optional): The style of the Mapillary image widget. Can be "classic", "photo",
+            or "split". Defaults to "photo".
+        radius (float, optional): The radius (in degrees) used to search for the nearest Mapillary
+            image. Defaults to 0.00005 degrees.
+        width (int, optional): The width of the Mapillary image widget. Defaults to 300.
+        height (int, optional): The height of the Mapillary image widget. Defaults to 420.
+        frame_border (int, optional): The width of the frame border for the Mapillary image widget.
+            Defaults to 0.
+        **kwargs (Any): Additional keyword arguments that may be passed to the function.
+
+    Returns:
+        widgets.VBox: A vertical box widget containing the map, sidebar, and control buttons.
+
+    Example:
+        >>> properties = {
+        ...     "Type": ["Residential", "Commercial", "Industrial"],
+        ...     "Area": [100, 200, 300],
+        ... }
+        >>> widget = create_vector_data(properties=properties)
+        >>> display(widget)  # Display the widget in a Jupyter notebook
+    """
+    return maplibregl.create_vector_data(
+        m=m,
+        properties=properties,
+        time_format=time_format,
+        column_widths=column_widths,
+        map_height=map_height,
+        out_dir=out_dir,
+        filename_prefix=filename_prefix,
+        file_ext=file_ext,
+        add_mapillary=add_mapillary,
+        style=style,
+        radius=radius,
+        width=width,
+        height=height,
+        frame_border=frame_border,
+        **kwargs,
+    )
+
+
+def edit_vector_data(
+    m: Optional[Map] = None,
+    filename: str = None,
+    properties: Optional[Dict[str, List[Any]]] = None,
+    time_format: str = "%Y%m%dT%H%M%S",
+    column_widths: Optional[List[int]] = (9, 3),
+    map_height: str = "600px",
+    out_dir: Optional[str] = None,
+    filename_prefix: str = "",
+    file_ext: str = "geojson",
+    add_mapillary: bool = False,
+    style: str = "photo",
+    radius: float = 0.00005,
+    width: int = 300,
+    height: int = 420,
+    frame_border: int = 0,
+    controls: Optional[List[str]] = None,
+    position: str = "top-right",
+    fit_bounds_options: Dict = None,
+    **kwargs: Any,
+):
+    """Generates a widget-based interface for creating and managing vector data on a map.
+
+    This function creates an interactive widget interface that allows users to draw features
+    (points, lines, polygons) on a map, assign properties to these features, and export them
+    as GeoJSON files. The interface includes a map, a sidebar for property management, and
+    buttons for saving, exporting, and resetting the data.
+
+    Args:
+        m (Map, optional): An existing Map object. If not provided, a default map with
+            basemaps and drawing controls will be created. Defaults to None.
+        filename (str or gpd.GeoDataFrame): The path to a GeoJSON file or a GeoDataFrame
+            containing the vector data to be edited. Defaults to None.
+        properties (Dict[str, List[Any]], optional): A dictionary where keys are property names
+            and values are lists of possible values for each property. These properties can be
+            assigned to the drawn features. Defaults to None.
+        time_format (str, optional): The format string for the timestamp used in the exported
+            filename. Defaults to "%Y%m%dT%H%M%S".
+        column_widths (Optional[List[int]], optional): A list of two integers specifying the
+            relative widths of the map and sidebar columns. Defaults to (9, 3).
+        map_height (str, optional): The height of the map widget. Defaults to "600px".
+        out_dir (str, optional): The directory where the exported GeoJSON files will be saved.
+            If not provided, the current working directory is used. Defaults to None.
+        filename_prefix (str, optional): A prefix to be added to the exported filename.
+            Defaults to "".
+        file_ext (str, optional): The file extension for the exported file. Defaults to "geojson".
+        add_mapillary (bool, optional): Whether to add a Mapillary image widget that displays the
+            nearest image to the clicked point on the map. Defaults to False.
+        style (str, optional): The style of the Mapillary image widget. Can be "classic", "photo",
+            or "split". Defaults to "photo".
+        radius (float, optional): The radius (in degrees) used to search for the nearest Mapillary
+            image. Defaults to 0.00005 degrees.
+        width (int, optional): The width of the Mapillary image widget. Defaults to 300.
+        height (int, optional): The height of the Mapillary image widget. Defaults to 420.
+        frame_border (int, optional): The width of the frame border for the Mapillary image widget.
+            Defaults to 0.
+        controls (Optional[List[str]], optional): The drawing controls to be added to the map.
+            Defaults to ["point", "polygon", "line_string", "trash"].
+        position (str, optional): The position of the drawing controls on the map. Defaults to "top-right".
+        **kwargs (Any): Additional keyword arguments that may be passed to the function.
+
+    Returns:
+        widgets.VBox: A vertical box widget containing the map, sidebar, and control buttons.
+    """
+    return maplibregl.edit_vector_data(
+        m=m,
+        filename=filename,
+        properties=properties,
+        time_format=time_format,
+        column_widths=column_widths,
+        map_height=map_height,
+        out_dir=out_dir,
+        filename_prefix=filename_prefix,
+        file_ext=file_ext,
+        add_mapillary=add_mapillary,
+        style=style,
+        radius=radius,
+        width=width,
+        height=height,
+        frame_border=frame_border,
+        controls=controls,
+        position=position,
+        fit_bounds_options=fit_bounds_options,
+        **kwargs,
+    )

geoai/train.py

@@ -1,3 +1,4 @@
+import glob
 import math
 import os
 import random
@@ -20,6 +21,8 @@ from torchvision.models.detection.faster_rcnn import FastRCNNPredictor
 from torchvision.models.detection.mask_rcnn import MaskRCNNPredictor
 from tqdm import tqdm
 
+from .utils import download_model_from_hf
+
 
 def get_instance_segmentation_model(num_classes=2, num_channels=3, pretrained=True):
     """
@@ -352,7 +355,9 @@ def collate_fn(batch):
     return tuple(zip(*batch))
 
 
-def train_one_epoch(model, optimizer, data_loader, device, epoch, print_freq=10):
+def train_one_epoch(
+    model, optimizer, data_loader, device, epoch, print_freq=10, verbose=True
+):
     """
     Train the model for one epoch.
 
@@ -363,6 +368,7 @@ def train_one_epoch(model, optimizer, data_loader, device, epoch, print_freq=10)
         device (torch.device): Device to train on.
         epoch (int): Current epoch number.
         print_freq (int): How often to print progress.
+        verbose (bool): Whether to print detailed progress.
 
     Returns:
         float: Average loss for the epoch.
@@ -392,9 +398,10 @@ def train_one_epoch(model, optimizer, data_loader, device, epoch, print_freq=10)
         # Print progress
         if i % print_freq == 0:
             elapsed_time = time.time() - start_time
-            print(
-                f"Epoch: {epoch}, Batch: {i}/{len(data_loader)}, Loss: {losses.item():.4f}, Time: {elapsed_time:.2f}s"
-            )
+            if verbose:
+                print(
+                    f"Epoch: {epoch}, Batch: {i}/{len(data_loader)}, Loss: {losses.item():.4f}, Time: {elapsed_time:.2f}s"
+                )
             start_time = time.time()
 
     # Calculate average loss
@@ -579,6 +586,8 @@ def train_MaskRCNN_model(
     val_split=0.2,
     visualize=False,
     resume_training=False,
+    print_freq=10,
+    verbose=True,
 ):
     """Train and evaluate Mask R-CNN model for instance segmentation.
 
@@ -605,7 +614,8 @@ def train_MaskRCNN_model(
             Defaults to False.
         resume_training (bool): If True and pretrained_model_path is provided,
             will try to load optimizer and scheduler states as well. Defaults to False.
-
+        print_freq (int): Frequency of printing training progress. Defaults to 10.
+        verbose (bool): If True, prints detailed training progress. Defaults to True.
     Returns:
         None: Model weights are saved to output_dir.
 
@@ -756,7 +766,9 @@ def train_MaskRCNN_model(
     # Training loop
     for epoch in range(start_epoch, num_epochs):
         # Train one epoch
-        train_loss = train_one_epoch(model, optimizer, train_loader, device, epoch)
+        train_loss = train_one_epoch(
+            model, optimizer, train_loader, device, epoch, print_freq, verbose
+        )
 
         # Update learning rate
         lr_scheduler.step()
@@ -1107,6 +1119,13 @@ def object_detection(
     model = get_instance_segmentation_model(
         num_classes=2, num_channels=num_channels, pretrained=pretrained
     )
+
+    if not os.path.exists(model_path):
+        try:
+            model_path = download_model_from_hf(model_path)
+        except Exception as e:
+            raise FileNotFoundError(f"Model file not found: {model_path}")
+
     model.load_state_dict(torch.load(model_path, map_location=device))
     model.to(device)
     model.eval()
@@ -1123,3 +1142,93 @@ def object_detection(
         device=device,
         **kwargs,
     )
+
+
+def object_detection_batch(
+    input_paths,
+    output_dir,
+    model_path,
+    filenames=None,
+    window_size=512,
+    overlap=256,
+    confidence_threshold=0.5,
+    batch_size=4,
+    num_channels=3,
+    pretrained=True,
+    device=None,
+    **kwargs,
+):
+    """
+    Perform object detection on a GeoTIFF using a pre-trained Mask R-CNN model.
+
+    Args:
+        input_paths (str or list): Path(s) to input GeoTIFF file(s). If a directory is provided,
+            all .tif files in that directory will be processed.
+        output_dir (str): Directory to save output mask GeoTIFF files.
+        model_path (str): Path to trained model weights.
+        filenames (list, optional): List of output filenames. If None, defaults to
+            "<input_filename>_mask.tif" for each input file.
+            If provided, must match the number of input files.
+        window_size (int): Size of sliding window for inference.
+        overlap (int): Overlap between adjacent windows.
+        confidence_threshold (float): Confidence threshold for predictions (0-1).
+        batch_size (int): Batch size for inference.
+        num_channels (int): Number of channels in the input image and model.
+        pretrained (bool): Whether to use pretrained backbone for model loading.
+        device (torch.device, optional): Device to run inference on. If None, uses CUDA if available.
+        **kwargs: Additional arguments passed to inference_on_geotiff.
+
+    Returns:
+        None: Output mask is saved to output_path.
+    """
+    # Load your trained model
+    if device is None:
+        device = (
+            torch.device("cuda") if torch.cuda.is_available() else torch.device("cpu")
+        )
+    model = get_instance_segmentation_model(
+        num_classes=2, num_channels=num_channels, pretrained=pretrained
+    )
+
+    if not os.path.exists(output_dir):
+        os.makedirs(output_dir, exist_ok=True)
+
+    if not os.path.exists(model_path):
+        try:
+            model_path = download_model_from_hf(model_path)
+        except Exception as e:
+            raise FileNotFoundError(f"Model file not found: {model_path}")
+
+    model.load_state_dict(torch.load(model_path, map_location=device))
+    model.to(device)
+    model.eval()
+
+    if isinstance(input_paths, str) and (not input_paths.endswith(".tif")):
+        files = glob.glob(os.path.join(input_paths, "*.tif"))
+        files.sort()
+    elif isinstance(input_paths, str):
+        files = [input_paths]
+
+    if filenames is None:
+        filenames = [
+            os.path.join(output_dir, os.path.basename(f).replace(".tif", "_mask.tif"))
+            for f in files
+        ]
+    else:
+        if len(filenames) != len(files):
+            raise ValueError("Number of filenames must match number of input files.")
+
+    for index, file in enumerate(files):
+        print(f"Processing file {index + 1}/{len(files)}: {file}")
+        inference_on_geotiff(
+            model=model,
+            geotiff_path=file,
+            output_path=filenames[index],
+            window_size=window_size,  # Adjust based on your model and memory
+            overlap=overlap,  # Overlap to avoid edge artifacts
+            confidence_threshold=confidence_threshold,
+            batch_size=batch_size,  # Adjust based on your GPU memory
+            num_channels=num_channels,
+            device=device,
+            **kwargs,
+        )

geoai/utils.py

@@ -6215,3 +6215,37 @@ def mosaic_geotiffs(input_dir, output_file, mask_file=None):
 
     print(f"Cloud Optimized GeoTIFF mosaic created successfully: {output_file}")
     return True
+
+
+def download_model_from_hf(model_path, repo_id=None):
+    """
+    Download the object detection model from Hugging Face.
+
+    Args:
+        model_path: Path to the model file.
+        repo_id: Hugging Face repository ID.
+
+    Returns:
+        Path to the downloaded model file
+    """
+    from huggingface_hub import hf_hub_download
+
+    try:
+
+        # Define the repository ID and model filename
+        if repo_id is None:
+            print(
+                "Repo is is not specified, using default Hugging Face repo_id: giswqs/geoai"
+            )
+            repo_id = "giswqs/geoai"
+
+        # Download the model
+        model_path = hf_hub_download(repo_id=repo_id, filename=model_path)
+        print(f"Model downloaded to: {model_path}")
+
+        return model_path
+
+    except Exception as e:
+        print(f"Error downloading model from Hugging Face: {e}")
+        print("Please specify a local model path or ensure internet connectivity.")
+        raise

{geoai_py-0.5.0.dist-info → geoai_py-0.5.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geoai-py
-Version: 0.5.0
+Version: 0.5.2
 Summary: A Python package for using Artificial Intelligence (AI) with geospatial data
 Author-email: Qiusheng Wu <giswqs@gmail.com>
 License: MIT License
@@ -25,6 +25,7 @@ Requires-Dist: jupyter-server-proxy
 Requires-Dist: leafmap
 Requires-Dist: localtileserver
 Requires-Dist: mapclassify
+Requires-Dist: maplibre
 Requires-Dist: overturemaps
 Requires-Dist: planetary-computer
 Requires-Dist: pystac-client
@@ -143,3 +144,10 @@ We welcome contributions of all kinds! See our [contributing guide](https://geoa
 ## 📄 License
 
 GeoAI is free and open source software, licensed under the MIT License.
+
+## Acknowledgments
+
+We gratefully acknowledge the support of the following organizations:
+
+-   [NASA](https://www.nasa.gov): This research is partially supported by the National Aeronautics and Space Administration (NASA) through Grant No. 80NSSC22K1742, awarded under the [Open Source Tools, Frameworks, and Libraries Program](https://bit.ly/3RVBRcQ).
+-   [AmericaView](https://americaview.org): This work is also partially supported by the U.S. Geological Survey through Grant/Cooperative Agreement No. G23AP00683 (GY23-GY27) in collaboration with AmericaView.

geoai_py-0.5.2.dist-info/RECORD

@@ -0,0 +1,16 @@
+geoai/__init__.py,sha256=0Q6M9_AJdoXX-sWjkXWJLrghRAP41WNAA6AT_mn-_Rk,3765
+geoai/classify.py,sha256=_e-193QzAx3pIxUflPIsIs1qZevQx5ADu7i3bOL1G70,35055
+geoai/download.py,sha256=lJ1GsJOZsKc2i6_dQyPV-XXIXmlADOpmSBo-wha4DEU,40892
+geoai/extract.py,sha256=GocJufMmrwEWxNBL1J91EXXHL8AKcO8m_lmtUF5AKPw,119102
+geoai/geoai.py,sha256=41ppSiGizvXf-b773QrBzjOlQe0VfHMRJnqQDF22RVY,9199
+geoai/hf.py,sha256=mLKGxEAS5eHkxZLwuLpYc1o7e3-7QIXdBv-QUY-RkFk,17072
+geoai/segment.py,sha256=g3YW17ftr--CKq6VB32TJEPY8owGQ7uQ0sg_tUT2ooE,13681
+geoai/segmentation.py,sha256=AtPzCvguHAEeuyXafa4bzMFATvltEYcah1B8ZMfkM_s,11373
+geoai/train.py,sha256=mQXat2yuddT-2rME4xnX_m3SkY23E_-zdxLnBIKxw8o,44091
+geoai/utils.py,sha256=5BZTL9QlJGEs9uw5w6i_aZ4s8SH_FGvb6ZFlIyEHEZI,239703
+geoai_py-0.5.2.dist-info/licenses/LICENSE,sha256=vN2L5U7cZ6ZkOHFmc8WiGlsogWsZc5dllMeNxnKVOZg,1070
+geoai_py-0.5.2.dist-info/METADATA,sha256=QT135XcjnpSQWchbm-_kB2F4PesM-BJCzkkz8nxiozk,6637
+geoai_py-0.5.2.dist-info/WHEEL,sha256=MAQBAzGbXNI3bUmkDsiV_duv8i-gcdnLzw7cfUFwqhU,109
+geoai_py-0.5.2.dist-info/entry_points.txt,sha256=uGp3Az3HURIsRHP9v-ys0hIbUuBBNUfXv6VbYHIXeg4,41
+geoai_py-0.5.2.dist-info/top_level.txt,sha256=1YkCUWu-ii-0qIex7kbwAvfei-gos9ycyDyUCJPNWHY,6
+geoai_py-0.5.2.dist-info/RECORD,,

geoai_py-0.5.0.dist-info/RECORD

@@ -1,16 +0,0 @@
-geoai/__init__.py,sha256=jGJl23LMoJDPdWTrlWAPxXK8cjwWllGQcFQ5IJOJ0s0,3765
-geoai/classify.py,sha256=_e-193QzAx3pIxUflPIsIs1qZevQx5ADu7i3bOL1G70,35055
-geoai/download.py,sha256=lJ1GsJOZsKc2i6_dQyPV-XXIXmlADOpmSBo-wha4DEU,40892
-geoai/extract.py,sha256=GocJufMmrwEWxNBL1J91EXXHL8AKcO8m_lmtUF5AKPw,119102
-geoai/geoai.py,sha256=5zXt7WQ0FbiksXKQ9fBNnfa9dhJ3QVd8LXicMxyynTg,698
-geoai/hf.py,sha256=mLKGxEAS5eHkxZLwuLpYc1o7e3-7QIXdBv-QUY-RkFk,17072
-geoai/segment.py,sha256=g3YW17ftr--CKq6VB32TJEPY8owGQ7uQ0sg_tUT2ooE,13681
-geoai/segmentation.py,sha256=AtPzCvguHAEeuyXafa4bzMFATvltEYcah1B8ZMfkM_s,11373
-geoai/train.py,sha256=-l2j1leTxDnFDLaBslu1q6CobXjm3LEdiQwUWOU8P6M,40088
-geoai/utils.py,sha256=xxhIkNFFtv-s_tzrlAyD4qIOaxo2JtKJEzG6vFgA5y8,238737
-geoai_py-0.5.0.dist-info/licenses/LICENSE,sha256=vN2L5U7cZ6ZkOHFmc8WiGlsogWsZc5dllMeNxnKVOZg,1070
-geoai_py-0.5.0.dist-info/METADATA,sha256=tzHz2Q1iTpCO25T8W3N2RtyaHdwdb9umS9YIgCciFdo,6049
-geoai_py-0.5.0.dist-info/WHEEL,sha256=MAQBAzGbXNI3bUmkDsiV_duv8i-gcdnLzw7cfUFwqhU,109
-geoai_py-0.5.0.dist-info/entry_points.txt,sha256=uGp3Az3HURIsRHP9v-ys0hIbUuBBNUfXv6VbYHIXeg4,41
-geoai_py-0.5.0.dist-info/top_level.txt,sha256=1YkCUWu-ii-0qIex7kbwAvfei-gos9ycyDyUCJPNWHY,6
-geoai_py-0.5.0.dist-info/RECORD,,