Skip to content

API Reference

This section provides detailed documentation for the classes, methods, and functions available in the package.

The API is divided into the following core modules:

  • Retrieval: Tools for interfacing with Google Earth Engine (BlackMarbleRetriever) and downloading raw datasets.
  • Preprocessing Methods: The individual filtering, correction, and imputation methods available for cleaning the NTL data.
  • Pipeline: The NTLPipeline orchestration class, responsible for running sequences of transformations and caching intermediate steps.
  • Aggregation: Functions for rasterizing vector shapes and performing memory-safe spatial aggregations using Dask.
  • Visualization: Tools for plotting multi-step aggregated NTL time-series data.

For higher-level workflows and practical examples of how these components fit together, please see the User Guide.