Skip to contents

a5pyramid builds level-of-detail pyramids of A5 cells, as created by a5R and a5px, and writes them with the cells they summarise to one Parquet file laid out for browsers. A web map reads the file's footer, picks the level for its zoom, and fetches only the tiles in view with HTTP range requests, for example with hyparquet and deck.gl. The engine is a Rust crate with no R dependency, built to be published on its own.

Building

  • a5_pyramid(): build the levels in memory and return them as a tibble.

  • a5_write_pyramid(): build the levels and write them to Parquet, in Rust from end to end.

  • a5_pyramid_arrow(): build the levels and return the tiles of the Parquet layout in memory, as an Arrow table, without a file.

Each coarser level groups the leaves by the coarse cell containing their centres (a5R::a5_cell_to_supercell()) and reduces each column by mean, sum, minimum, maximum, mode or a representative leaf.

Reading

Threads

a5pyramid_threads() sets how many threads builds use; the default is every available CPU. Builds can be interrupted (Ctrl-C, or Esc in an IDE).

Errors

Errors raised by a5pyramid have class a5pyramid_error and one of:

  • a5pyramid_error_input: invalid arguments or cells, such as cells at mixed resolutions or a duplicated cell.

  • a5pyramid_error_io: a file or directory that cannot be read or written.

  • a5pyramid_error_format: a file that is not a pyramid, or one written for another A5 index or a newer format version.

  • a5pyramid_error_interrupted: a build stopped by the user.

  • a5pyramid_error_internal: a fault in a5pyramid; please report it.

Author

Maintainer: Hugh Graham hugh@belian.earth

Authors:

Other contributors:

  • belian.earth [copyright holder]