fmeobjects.FMERasterTools.addBandTileCache

FMERasterTools.addBandTileCache(band, parms)

Adds a band tile cache to a band.

Adding a cache may improve performance in cases where a band will be read multiple times. In such cases, data read from the band will be cached, so that subsequent callers may have their FMEBand.getTile() requests filled without performing redundant processing.

Note that a cache will not by default accumulate tiles. When created it is in an “undecided” state. In this state, it will accumulate tiles only if multiple instances of it exist(e.g.a clone is made after adding the cache). In order to force a cache to accumulate tiles, call FMEBand.enableBandCache() after calling this method.

Adding a cache will be most useful when consumers request data in a tiled - BSQ interleaving. That is, when iterating over tiles first, then bands.

Parameters:

• band (FMEBand) – Band where the cache will be added.

• parms (dict[str, str]) – (Optional) Name-value pair representing additional parameters. Currently, no additional parameters exist.

Return type:

FMEBand

Returns:

The band after adding cache to a band.

Raises:

FMEException – An exception is raised if an error occurred.