View source on GitHub

TileLoader

Bases: Iterable[Tiles]

A tile loader is an iterable that yields tiles from the tile set.

Example

Assume the tile set is already created.

You can create a tile loader and iterate over the tiles.

tile_loader = TileLoader(
    tile_set=tile_set,
    batch_size=1,
    max_num_threads=None,
    num_prefetched_tiles=0,
)

for tiles in tile_loader:
    ...

PARAMETER	DESCRIPTION
tile_set	Tile set TYPE: TileSet
batch_size	Batch size TYPE: int DEFAULT: 1
max_num_threads	Maximum number of threads TYPE: int | None DEFAULT: None
num_prefetched_tiles	Number of prefetched tiles TYPE: int DEFAULT: 0

__len__

Computes the number of tiles.

RETURNS	DESCRIPTION
int	Number of tiles

__iter__

Iterates over the tiles.

YIELDS	DESCRIPTION
Tiles	Tiles

__next__

Returns the next tiles.

RETURNS	DESCRIPTION
Tiles	Tiles