splitraster 0.3.5__tar.gz → 0.3.6__tar.gz

{splitraster-0.3.5 → splitraster-0.3.6}/LICENSE

@@ -1,6 +1,6 @@
 
 The MIT License (MIT)
-Copyright (c) 2021, Your name (or your organization/company/team)
+Copyright (c) 2024, Caihao Cui
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

{splitraster-0.3.5/src/splitraster.egg-info → splitraster-0.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: splitraster
-Version: 0.3.5
+Version: 0.3.6
 Summary: Provide good support for deep learning and computer vision tasks by creating a tiled output from an input raster dataset.
 Home-page: https://github.com/cuicaihao/split_raster
 Author: Chris Cui
@@ -27,6 +27,12 @@ License-File: LICENSE
 
 Provide good support for deep learning and computer vision tasks by creating a tiled output from an input raster dataset.
 
+Find more details:
+
+- Document: [split_raster](https://cuicaihao.github.io/split_raster/)
+- Pypi: [splitraster](https://pypi.org/project/splitraster/)
+
+
 ## Use the packages
 
 ```bash

{splitraster-0.3.5 → splitraster-0.3.6}/README.md

@@ -2,11 +2,13 @@
 
 [![image](https://img.shields.io/pypi/pyversions/splitraster)](https://python.org/pypi/splitraster)
 [![image](https://img.shields.io/pypi/v/splitraster?color=g)](https://python.org/pypi/splitraster)
-[![CI](https://img.shields.io/github/actions/workflow/status/cuicaihao/split_raster/python-app.yml?branch=master)](https://github.com/cuicaihao/split_raster/actions/workflows/python-app.yml)
-[![image](https://img.shields.io/pypi/dm/splitraster?color=blue)](https://python.org/pypi/splitraster)
+[![CD](https://img.shields.io/github/actions/workflow/status/cuicaihao/split_raster/python-CD.yml?branch=master)](https://github.com/cuicaihao/split_raster/actions/workflows/python-CD.yml)
+[![DMonth](https://pepy.tech/badge/splitraster/month)](https://pepy.tech/project/splitraster)
+[![DTotal](https://pepy.tech/badge/splitraster?)](https://pepy.tech/project/splitraster)
 [![image](https://img.shields.io/github/license/cuicaihao/split_raster?color=blue)](https://python.org/pypi/splitraster)
 
-- Document: [split_raster](https://cuicaihao.github.io/split_raster/)
+
+- Document: [splitraster](https://cuicaihao.github.io/split_raster/)
 - Pypi: [splitraster](https://pypi.org/project/splitraster/)
 
 
@@ -34,7 +36,7 @@ This tutorial will show you how to use the package to split a large image into s
 pip install splitraster
 ```
 
-## Try Sample code
+## Try Sample code 
 
 The sample image can be found in the GitHub repo.
 
@@ -85,14 +87,39 @@ Generating: 100%|█████████████████████
 49 tiles sample of ./data/raw/GT.png are added at ./data/processed/GT
 ```
  
+Check Notebook for Details: [Tutorial](notebooks/Tutorial.ipynb)
+
+
+## GIS TIFF Image
+
 You can also work with Remote Sensing (GeoTIFF) Satellite images such as Multispectral Images which have more bands or channels. All the codes will be the same, but with a small difference. Replace the `io` with the `geo` module.
 
 This feature also needs you to install the `gdal` package with the following command in your python environment.
-This package is not in the required packages due to many users may not use this function.
 
+This package is not in the required packages due to many users may not use this function. 
+
+However, if you do, please consider create the conda environment as follows for your application.
+
+```bash
+conda create -n split_raster_py310 python=3.10 -y
+conda activate split_raster_py310
+conda install gdal -y
+conda install ipykernel -y
+pip install --upgrade pip
+pip install splitraster
+```
+
+On a Mac, you can install these using Homebrew:
 ```bash
-conda install -c conda-forge gdal
+brew install gdal
 ```
+then, you can install the Python GDAL package:
+
+```bash
+pip install GDAl
+```
+Please note that installing GDAL can be complex due to its system dependencies. If you encounter issues, you may need to consult the GDAL documentation or seek help from the community.
+
 
 Sample Code:
 
@@ -111,6 +138,9 @@ n = geo.split_image(input_image_path, save_path, crop_size,
 print(f"{n} tiles sample of {input_image_path} are added at {save_path}")
 ```
 
+Check Notebook for Details: [Tutorial_II](notebooks/Tutorial_II.ipynb)
+
+
 ## Random Sampling Code
 
 The basic implementation is still the same as the above. Just replace the 'split_image' method to 'rand_crop_image'.
@@ -142,14 +172,9 @@ n = geo.random_crop_image(input_tif_image_path, input_save_image_path,  gt_tif_i
 print(f"{n} sample paris of {input_tif_image_path, gt_tif_image_path} are added at {input_save_image_path, gt_save_image_path}.")
 
 ```
-## Future Update:
-
-- [x] Add Random Sampling feature.
-- [ ] ~~Create a GUI with Qt and generate an executable file~~ (Not a good idea, since it is not a good practice to use GUI in a package).
-- [ ] Add Sample Balancing feature, which can be used to balance the sample number of different classes, especially for the unbalanced dataset.
-
  
 ## Update Log
+- 2024-Mar-23  Update github actions enable full CI/CD workflow, also add python 3.12 for build and test (https://pypi.org/project/splitraster/0.3.5/)
 - 2023-Mar-19  Update github actions and add tutorial for the package.
 - 2022-Dec-16  Upgrade the package to support python 3.8, 3.9, 3.10, 3.11 (https://pypi.org/project/splitraster/0.3.3).
 - 2022-Jan-16  Fix bugs to make package suitable for python 3.7. Publish new version at(https://pypi.org/project/splitraster/0.3.2/) .
@@ -160,54 +185,4 @@ If you run into issues or have questions, please [open an issue](https://github.
 
 If you are interested in contributing to `splitraster`, please see our [contributing guidelines](../CONTRIBUTING.md).
   
- 
-## Project Organization
-
-    ├── LICENSE
-    ├── Makefile           <- Makefile with commands like `make data` or `make train`
-    ├── README.md          <- The top-level README for developers using this project.
-    ├── data
-    │   ├── external       <- Data from third party sources.
-    │   ├── interim        <- Intermediate data that has been transformed.
-    │   ├── processed      <- The final, canonical data sets for modeling.
-    │   └── raw            <- The original, immutable data dump.
-    │
-    ├── docs               <- A default Sphinx project; see sphinx-doc.org for details
-    │
-    ├── models             <- Trained and serialized models, model predictions, or model summaries
-    │
-    ├── notebooks          <- Jupyter notebooks. Naming convention is a number (for ordering),
-    │                         the creator's initials, and a short `-` delimited description, e.g.
-    │                         `1.0-jqp-initial-data-exploration`.
-    │
-    ├── references         <- Data dictionaries, manuals, and all other explanatory materials.
-    │
-    ├── reports            <- Generated analysis as HTML, PDF, LaTeX, etc.
-    │   └── figures        <- Generated graphics and figures to be used in reporting
-    │
-    ├── requirements.txt   <- The requirements file for reproducing the analysis environment, e.g.
-    │                         generated with `pip freeze > requirements.txt`
-    │
-    ├── setup.py           <- makes project pip installable (pip install -e .) so src can be imported
-    ├── src                <- Source code for use in this project.
-    │   ├── __init__.py    <- Makes src a Python module
-    │   │
-    │   ├── data           <- Scripts to download or generate data
-    │   │   └── make_dataset.py
-    │   │
-    │   ├── features       <- Scripts to turn raw data into features for modeling
-    │   │   └── build_features.py
-    │   │
-    │   ├── models         <- Scripts to train models and then use trained models to make
-    │   │   │                 predictions
-    │   │   ├── predict_model.py
-    │   │   └── train_model.py
-    │   │
-    │   └── visualization  <- Scripts to create exploratory and results oriented visualizations
-    │       └── visualize.py
-    │
-    └── tox.ini            <- tox file with settings for running tox; see tox.readthedocs.io
-
----
-
 <p><small>Project based on the <a target="_blank" href="https://drivendata.github.io/cookiecutter-data-science/">cookiecutter data science project template</a>. #cookiecutterdatascience</small></p>

{splitraster-0.3.5 → splitraster-0.3.6}/setup.py

@@ -1,9 +1,16 @@
 from setuptools import find_packages, setup
 from pathlib import Path
 
+
+def read_requirements():
+    with open("requirements.txt", "r") as req_file:
+        requirements = req_file.read().splitlines()
+    return requirements
+
+
 setup(
     name="splitraster",
-    version="0.3.5",
+    version="0.3.6",
     author="Chris Cui",
     license="MIT",
     platforms="any",
@@ -19,12 +26,7 @@ setup(
     ),
     python_requires=">=3.7, <3.13",
     keywords="split raster tiling ",
-    install_requires=[
-        "tqdm>=4.40.0, <5.0.0",
-        "numpy>=1.19.0, <2.0.0",
-        "scikit-image>=0.18.0, <1.0.0",
-        # 'gdal>=3.3.0' # too many local issues for this gdal python binding.
-    ],
+    install_requires=read_requirements(),
     classifiers=[
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",

{splitraster-0.3.5 → splitraster-0.3.6}/src/splitraster/geo.py

@@ -1,14 +1,12 @@
 from tqdm import tqdm
-
-from osgeo import gdal
-from osgeo import gdal_array
-
+from osgeo import gdal, gdal_array
 import numpy as np
 from pathlib import Path
 import random
+from typing import Tuple, Optional
 
 
-def read_rasterArray(image_path):
+def read_rasterArray(image_path: str) -> Tuple[np.ndarray, Tuple[float, ...], str]:
     dataset = gdal.Open(image_path, gdal.GA_ReadOnly)
     image = dataset.ReadAsArray()  # get the rasterArray
     # convert 2D raster to [1, H, W] format
@@ -19,7 +17,9 @@ def read_rasterArray(image_path):
     return image, geotrans, proj
 
 
-def save_rasterGeoTIF(im_data, im_geotrans, im_proj, file_name):
+def save_rasterGeoTIF(
+    im_data: np.ndarray, im_geotrans: Tuple[float, ...], im_proj: str, file_name: str
+) -> None:
     if Path(file_name).is_file():
         print(f"Overwrite existing file: {file_name}")
 
@@ -40,7 +40,7 @@ def save_rasterGeoTIF(im_data, im_geotrans, im_proj, file_name):
     dataset = driver.Create(
         file_name, int(im_width), int(im_height), int(im_bands), datatype
     )
-    if dataset != None:
+    if dataset is not None:
         dataset.SetGeoTransform(im_geotrans)
         dataset.SetProjection(im_proj)
     for i in range(im_bands):
@@ -48,33 +48,20 @@ def save_rasterGeoTIF(im_data, im_geotrans, im_proj, file_name):
     del dataset
 
 
-# def save_rasterArray(im_data, path, image_prototype_path):
-
-#     output = gdal_array.SaveArray(
-#         im_data, path, format="GTiff",  prototype=image_prototype_path)
-#     return True
-
-
-def save_rasterArray(im_data, file_name):
+def save_rasterArray(im_data: np.ndarray, file_name: str) -> bool:
     if Path(file_name).is_file():
         print(f"Overwrite existing file: {file_name}")
-    output = gdal_array.SaveArray(im_data, file_name, format="GTiff")
+    gdal_array.SaveArray(im_data, file_name, format="GTiff")
     return True
 
 
-def count_files(folder_path):
-    count = 0
-    for path in Path(folder_path).iterdir():
-        if path.is_file():
-            count += 1
-    return count
+def count_files(folder_path: str) -> int:
+    return sum(1 for path in Path(folder_path).iterdir() if path.is_file())
 
 
-def padding_mul_image(img, stride):
-    D = img.shape[0]  # this one is for (D, H, W) format Channel First.
-    height = img.shape[1]
-    width = img.shape[2]
-    # get the minial padding image size
+def padding_mul_image(img: np.ndarray, stride: int) -> np.ndarray:
+    D, height, width = img.shape  # (D, H, W) format Channel First.
+    # get the minimal padding image size
     H = int(np.ceil(height / stride) * stride)
     W = int(np.ceil(width / stride) * stride)
 
@@ -84,13 +71,17 @@ def padding_mul_image(img, stride):
         padded_img[d, :, :] = np.pad(
             onelayer, ((0, H - height), (0, W - width)), "reflect"
         )
-    # padded_img = np.squeeze(padded_img)  # Remove axes of length one
     return padded_img
 
 
 def split_image(
-    img_path, save_path, crop_size, repetition_rate=0, overwrite=True, ext="."
-):
+    img_path: str,
+    save_path: str,
+    crop_size: int,
+    repetition_rate: float = 0,
+    overwrite: bool = True,
+    ext: Optional[str] = ".",
+) -> Optional[int]:
     # check input image
     img, geotrans, proj = read_rasterArray(img_path)
     if img is None:
@@ -104,7 +95,7 @@ def split_image(
     print(f"Input Image File Shape (D, H, W):{ img.shape}")
 
     stride = int(crop_size * (1 - repetition_rate))
-    print(f"{crop_size=}, {stride=}")
+    print(f"crop_size = {crop_size}, stride = {stride}")
 
     padded_img = padding_mul_image(img, stride)
 
@@ -138,32 +129,36 @@ def split_image(
             crop_img = padded_img[:, h : h + crop_size, w : w + crop_size]
             crop_image_name = f"{new_name:04d}{ext}"
             crop_image_path = Path(save_path) / crop_image_name
-            # save_rasterArray(crop_img,  str(crop_image_path)) # just save the raster image
             save_rasterGeoTIF(crop_img, geotrans, proj, str(crop_image_path))
-            new_name = new_name + 1
+            new_name += 1
             pbar.update(1)
 
     return n + 1
 
 
 def random_crop_image(
-    img_path,
-    img_save_path,
-    label_path,
-    label_save_path,
-    crop_size=256,
-    crop_number=20,
-    img_ext=".tif",
-    label_ext=".tif",
-    overwrite=True,
-):
+    img_path: str,
+    img_save_path: str,
+    label_path: str,
+    label_save_path: str,
+    crop_size: int = 256,
+    crop_number: int = 20,
+    img_ext: str = ".tif",
+    label_ext: str = ".tif",
+    overwrite: bool = True,
+) -> Optional[int]:
     """Generate Random cropped image pair from the input image pairs.
 
     Args:
         img_path (str): path of input image
-        img_save_path (str):
+        img_save_path (str): path to save cropped images
+        label_path (str): path of input label
+        label_save_path (str): path to save cropped labels
         crop_size (int): image tile size (H,W), i.e., 256x256
-        overwrite (bool, optional): [overwrite existing files]. Defaults to True.
+        crop_number (int): number of crops to generate
+        img_ext (str): extension for image files
+        label_ext (str): extension for label files
+        overwrite (bool): overwrite existing files
     """
     img, geotrans, proj = read_rasterArray(label_path)
     if img is None:
@@ -231,8 +226,8 @@ def random_crop_image(
             crop_image_path = Path(label_save_path) / crop_image_name
             save_rasterGeoTIF(labelCrop, geotrans, proj, str(crop_image_path))
 
-            new_name = new_name + 1  # update image name
-            crop_cnt = crop_cnt + 1  # add crop count
+            new_name += 1  # update image name
+            crop_cnt += 1  # add crop count
             pbar.update(1)
 
     return crop_cnt  # return total crop sample pair number.

{splitraster-0.3.5 → splitraster-0.3.6/src/splitraster.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: splitraster
-Version: 0.3.5
+Version: 0.3.6
 Summary: Provide good support for deep learning and computer vision tasks by creating a tiled output from an input raster dataset.
 Home-page: https://github.com/cuicaihao/split_raster
 Author: Chris Cui
@@ -27,6 +27,12 @@ License-File: LICENSE
 
 Provide good support for deep learning and computer vision tasks by creating a tiled output from an input raster dataset.
 
+Find more details:
+
+- Document: [split_raster](https://cuicaihao.github.io/split_raster/)
+- Pypi: [splitraster](https://pypi.org/project/splitraster/)
+
+
 ## Use the packages
 
 ```bash

{splitraster-0.3.5 → splitraster-0.3.6}/src/splitraster.egg-info/requires.txt

@@ -1,3 +1,3 @@
-tqdm<5.0.0,>=4.40.0
 numpy<2.0.0,>=1.19.0
+tqdm<5.0.0,>=4.40.0
 scikit-image<1.0.0,>=0.18.0