Skip to content

API Reference

Complete API documentation for SensingPy modules, classes, and functions.

Core Modules

Image

Core image class for handling geospatial raster data with metadata and coordinate systems.

Reader

Functions to read geospatial data from various file formats (TIFF, NetCDF).

Selector

Tools for selecting and extracting subsets of data based on spatial or attribute criteria.

Masks

Functions to create and apply masks for water bodies, land areas, and other features.

Plot

Visualization utilities for displaying geospatial data with maps and custom styling.

Enums

Enumeration types used throughout the package for consistent parameter handling.

Preprocessing

preprocessing

Image preprocessing and enhancement techniques:

Bathymetry

bathymetry

Satellite-derived bathymetry models and analysis:

  • Models: Bathymetry estimation models (Stumpf, etc.)
  • Metrics: Validation metrics and error analysis
  • Plot: Specialized plotting for bathymetry results

Quick Navigation

Use the sidebar navigation to browse through the API documentation. Each page includes:

  • Function/class signatures
  • Detailed descriptions
  • Parameter specifications
  • Return value descriptions
  • Usage examples (where available)
  • Source code links