omero.util

Class TileLoop

java.lang.Object

omero.util.TileLoop

Direct Known Subclasses:

RPSTileLoop

public abstract class TileLoop
extends Object

Since:

4.3.0

Author:

Josh Moore, josh at glencoesoftware.com

Constructor Summary

Constructors

Constructor and Description
TileLoop()

Method Summary

Modifier and Type	Method and Description
abstract TileData	createData() Subclasses must provide a fresh instance of TileData.
int	forEachTile(int sizeX, int sizeY, int sizeZ, int sizeC, int sizeT, int tileWidth, int tileHeight, TileLoopIteration iteration) Iterates over every tile in a given pixel based on the over arching dimensions and a requested maximum tile width and height.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TileLoop

public TileLoop()

Method Detail

createData

public abstract TileData createData()

Subclasses must provide a fresh instance of TileData. The instance will be closed after the run of forEachTile(int, int, int, int, int, int, int, TileLoopIteration).

Returns:

the new instance

forEachTile

public int forEachTile(int sizeX,
                       int sizeY,
                       int sizeZ,
                       int sizeC,
                       int sizeT,
                       int tileWidth,
                       int tileHeight,
                       TileLoopIteration iteration)

Iterates over every tile in a given pixel based on the over arching dimensions and a requested maximum tile width and height.

Parameters:

sizeX - the size of the plane's X dimension

sizeY - the size of the plane's Y dimension

sizeZ - the size of the plane's Z dimension

sizeC - the size of the plane's C dimension

sizeT - the size of the plane's T dimension

iteration - Invoker to call for each tile.

tileWidth - Maximum width of the tile requested. The tile request itself will be smaller than the original tile width requested if x + tileWidth > sizeX.

tileHeight - Maximum height of the tile requested. The tile request itself will be smaller if y + tileHeight > sizeY.

Returns:

The total number of tiles iterated over.