Skip to main content

Tool for creating patches from geo-referenced and non geo-referenced image and label pairs

Project description

GeoTIFF Tiler

A Python package for creating training patches from geospatial imagery and label pairs for machine learning applications.

Overview

GeoTIFF Tiler is designed to streamline the creation of training data patches from geo-referenced and non-geo-referenced image and label pairs. It helps prepare data for machine learning models requiring consistent input dimensions, particularly for geospatial applications.

Features

  • Create patches of specified size from image-label pairs
  • Support for various input formats:
    • Images: GeoTIFFs (geo-referenced and non-geo-referenced), STAC imagery
    • Labels: GeoTIFFs (geo-referenced and non-geo-referenced), vector data (.geojson, .gpkg, .shp)
  • Intelligent patch filtering based on label content
  • Padding for edge patches to maintain consistent dimensions
  • Automatic handling of CRS and alignment issues
  • Output in Zarr format for efficient storage and access
  • Visualization tools for quality assessment

Installation

pip install geotiff-tiler

Quick Start

from geotiff_tiler.tiler import Tiler

# Define your image-label pairs with metadata
data = [{
    "image": "./path/to/image.tif",
    "label": "./path/to/label.tif",
    "metadata": {"collection": "satellite-name", "gsd": 0.5}
}]

# Initialize the tiler with your configuration
tiler = Tiler(
    input_dict=data,
    patch_size=(256, 256),  # Height, Width
    attr_field=["class", "category"],  # Field(s) in vector data to use for labels
    attr_values=[1, 2, 3],  # Values to extract from the fields
    stride=128,             # Overlap between patches
    discard_empty=True,     # Skip patches with no labels
    label_threshold=0.05,   # Minimum non-zero label coverage
    output_dir='./output/patches'
)

# Create the patches
tiler.create_tiles()

Using STAC Items

The library supports STAC (SpatioTemporal Asset Catalog) items, making it compatible with cloud-native geospatial workflows.

Parameters

  • input_dict: List of dictionaries with "image", "label", and "metadata" keys
  • patch_size: Tuple of (height, width) for the output patches
  • attr_field: Field name(s) in vector data to use for labeling (list of strings)
  • attr_values: Values to extract from the attribute field (list of strings or numbers)
  • stride: Spacing between patches (determines overlap); if None, uses max(patch_size)
  • discard_empty: Whether to skip patches with no labels
  • label_threshold: Minimum fraction of non-zero pixels required in a label patch
  • output_dir: Directory to save the output patches

Output Format

Patches are saved in Zarr format with the following structure:

  • images: Array of image patches [N, C, H, W]
  • labels: Array of label patches [N, H, W]
  • positions: Array of patch locations [N, 2]
  • metadata: Dictionary with additional information

A csv file is created of the zarr paths.

License

MIT License

Author

Victor Alhassan (victor.alhassan@nrcan-rncan.gc.ca)

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

geotiff_tiler-0.1.5.tar.gz (22.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

geotiff_tiler-0.1.5-py3-none-any.whl (23.2 kB view details)

Uploaded Python 3

File details

Details for the file geotiff_tiler-0.1.5.tar.gz.

File metadata

  • Download URL: geotiff_tiler-0.1.5.tar.gz
  • Upload date:
  • Size: 22.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.5

File hashes

Hashes for geotiff_tiler-0.1.5.tar.gz
Algorithm Hash digest
SHA256 5980f1589412f02c5fe152efffea02a0ccb127ae27704395802cdd7ede6a0260
MD5 7fd1ecb70b98880e15596943aef2f9d2
BLAKE2b-256 ef3744f7c738c198b63088838618c7f001b2ed03be14b937e3ad215270bd7981

See more details on using hashes here.

File details

Details for the file geotiff_tiler-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: geotiff_tiler-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 23.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.5

File hashes

Hashes for geotiff_tiler-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 4d31a70bbe17f94d0dad761dab12aaae897138b1b003332cffab122b78f611d4
MD5 d002a6fa5fb656452f41e25d11b0c8f2
BLAKE2b-256 5473435872c6c67986ece1bc428a6eaf34cdbfb2f863ccfb1bbbcdb9d296c6c2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page