Skip to content

How it works#

This overview explains the system boundaries and data flow of the pyramids package.

System Context (C4: Context)#

Hold "Ctrl" to enable pan & zoom 
flowchart LR
  user(User) -->|Provides GIS data paths & commands| pyramids{{pyramids package}}
  ext1[(Raster files\nGeoTIFF/ASC/NetCDF)] --> pyramids
  ext2[(Vector files\nShapefile/GeoJSON/GeoPackage)] --> pyramids
  pyramids --> out1[(Processed rasters\nGeoTIFF/ASC)]
  pyramids --> out2[(Processed vectors\nGeoJSON/GPKG)]

Runtime Containers (C4: Containers)#

Hold "Ctrl" to enable pan & zoom 
flowchart TB
  subgraph Process
    A[Dataset]:::c --> B[_io]:::c
    C[Datacube]:::c --> B
    D[FeatureCollection]:::c --> B
    A --> E[_utils]
    C --> E
    D --> E
  end
  classDef c fill:#eef,stroke:#88f

Components (C4: Components)#

Hold "Ctrl" to enable pan & zoom 
flowchart LR
  io[_io: read_file, to_ascii, path parsing]\nutils[_utils: geometry/index helpers]
  ds[dataset.Dataset]\nabs[abstract_dataset.AbstractDataset]
  dc[datacube.Datacube]\nfc[featurecollection.FeatureCollection]

  abs --> ds
  ds --> io
  dc --> ds
  fc --> io
  ds --> utils
  fc --> utils

Data Flow#

  1. Input paths are parsed; archives (.zip/.gz/.tar) are handled in _io.
  2. Raster inputs are loaded into Dataset; vector inputs into FeatureCollection.
  3. Datacube orchestrates collections of datasets for temporal/spatial ops.
  4. Results are exported via to_file (GeoTIFF/ASCII/GeoJSON, etc.).

See the diagrams page for UML and sequence flows.