DeferredArray3D (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- levelsets.algorithm.DeferredArray3D

Direct Known Subclasses:

DeferredByteArray3D, DeferredDoubleArray3D, DeferredIntArray3D, DeferredObjectArray3D
```
public abstract class DeferredArray3D
extends Object
```
Base class for tiled array data structure

Field Summary

Fields
Modifier and Type Field and Description

protected Object[] tiles

protected int tilesize

Fields
Modifier and Type	Field and Description
`protected Object[]`	`tiles`
`protected int`	`tilesize`

Constructor Summary

Constructors
Constructor and Description

DeferredArray3D(int xdim, int ydim, int zdim, int tilesize)
Creates a new instance of DeferredArray3D

Constructors
Constructor and Description
`DeferredArray3D(int xdim, int ydim, int zdim, int tilesize)` Creates a new instance of DeferredArray3D

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract Object`	`createTile(int tilesize)` Creates a tile.
`void`	`dumpToFile(String path)` Dumps the array content into a textfile.
`protected abstract String`	`getAsString(int x, int y, int z)` Returns the data at the requested position represented as a String
`protected Object`	`getTile(int x, int y, int z, boolean create)` Requests the tile for the passed coordinates.
`int`	`getTileSize()` Returns the length of the tile edge.
`int`	`getXLength()` Returns the size of the whole virtual array in X direction
`int`	`getYLength()` Returns the size of the whole virtual array in Y direction
`int`	`getZLength()` Returns the size of the whole virtual array in Z direction

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - tilesize
```
protected final int tilesize
```
  - tiles
```
protected final Object[] tiles
```
- Constructor Detail
  - DeferredArray3D
```
public DeferredArray3D(int xdim,
                       int ydim,
                       int zdim,
                       int tilesize)
```
    Creates a new instance of DeferredArray3D
    
    Parameters:
    
    xdim - Size in X direction
    
    ydim - Size in Y direction
    
    zdim - Size in Z direction
    
    tilesize - The tile size - length of an edge tile.
- Method Detail
  - getTileSize
```
public final int getTileSize()
```
    Returns the length of the tile edge. The edges have uniform length in all directions
    
    Returns:
    
    The size of the tile edges
  - getTile
```
protected final Object getTile(int x,
                               int y,
                               int z,
                               boolean create)
```
    Requests the tile for the passed coordinates.
    
    Parameters:
    
    x - The X index
    
    y - The Y index
    
    z - The Z index
    
    create - Determines whether the tile should be created if it has not been allocated yet.
    
    Returns:
    
    The tile - a three dimensional array of the proper data type
  - getXLength
```
public final int getXLength()
```
    Returns the size of the whole virtual array in X direction
    
    Returns:
    
    The size in X direction
  - getYLength
```
public final int getYLength()
```
    Returns the size of the whole virtual array in Y direction
    
    Returns:
    
    The size in Y direction
  - getZLength
```
public final int getZLength()
```
    Returns the size of the whole virtual array in Z direction
    
    Returns:
    
    The size in Z direction
  - dumpToFile
```
public final void dumpToFile(String path)
```
    Dumps the array content into a textfile. A matrix is dumped for every Z layer.
    
    Parameters:
    
    path - Path to the file to be created.
  - createTile
```
protected abstract Object createTile(int tilesize)
```
    Creates a tile. This is delegated to concrete subclasses as the tile needs to be of the proper data type.
    
    Parameters:
    
    tilesize - The tile dimension
    
    Returns:
    
    The tile - a three dimensional array of the proper data type
  - getAsString
```
protected abstract String getAsString(int x,
                                      int y,
                                      int z)
```
    Returns the data at the requested position represented as a String
    
    Parameters:
    
    x - The X index
    
    y - The Y index
    
    z - The Z index
    
    Returns:
    
    The data as String

Class DeferredArray3D

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

tilesize

tiles

Constructor Detail

DeferredArray3D

Method Detail

getTileSize

getTile

getXLength

getYLength

getZLength

dumpToFile

createTile

getAsString