io.scif.img.cell.loaders

Class AbstractArrayLoader<A>

java.lang.Object

io.scif.img.cell.loaders.AbstractArrayLoader<A>

All Implemented Interfaces:

SCIFIOArrayLoader<A>

Direct Known Subclasses:

ByteAccessLoader, ByteArrayLoader, CharAccessLoader, CharArrayLoader, DoubleAccessLoader, DoubleArrayLoader, FloatAccessLoader, FloatArrayLoader, IntAccessLoader, IntArrayLoader, LongAccessLoader, LongArrayLoader, ShortAccessLoader, ShortArrayLoader

public abstract class AbstractArrayLoader<A>
extends Object
implements SCIFIOArrayLoader<A>

Abstract superclass for all SCIFIOArrayLoader implementations.

Reads the byte array appropriate for the given cell dimensions and delegates to each subclass's array conversion method. See convertBytes(Object, byte[], int).

Author:

Mark Hiner

Constructor Summary

Constructors

Constructor and Description
AbstractArrayLoader(Reader reader, ImageRegion subRegion)

Method Summary

Modifier and Type	Method and Description
abstract void	convertBytes(A data, byte[] bytes, int planesRead) Type-specific conversion method.
protected boolean	isCompatible()
A	loadArray(net.imglib2.Interval bounds)
A	loadArray(net.imglib2.Interval bounds, A data)
net.imglib2.display.ColorTable	loadTable(int imageIndex, int planeIndex) Returns the ColorTable for a given set of indices.
abstract Class<?>	outputClass()
protected Reader	reader()
void	setIndex(int index)
protected ImgUtilityService	utils()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.scif.img.cell.loaders.SCIFIOArrayLoader

emptyArray, getBitsPerElement

Constructor Detail

AbstractArrayLoader

public AbstractArrayLoader(Reader reader,
                           ImageRegion subRegion)

Method Detail

setIndex

public void setIndex(int index)

Specified by:

setIndex in interface SCIFIOArrayLoader<A>

Parameters:

index - The image index this loader should use when opening planes.

loadTable

public net.imglib2.display.ColorTable loadTable(int imageIndex,
                                                int planeIndex)
                                         throws FormatException,
                                                IOException

Description copied from interface: SCIFIOArrayLoader

Returns the ColorTable for a given set of indices. If the desired plane has already been opened, the table should be cached. Otherwise, this will trigger the loading of a small sub-plane to access the desired table.

Specified by:

loadTable in interface SCIFIOArrayLoader<A>

Parameters:

imageIndex - Image index of desired ColorTable

planeIndex - Plane index of desired ColorTable

Returns:

The ColorTable for the specified indices

Throws:

FormatException

IOException

loadArray

public A loadArray(net.imglib2.Interval bounds)

Specified by:

loadArray in interface SCIFIOArrayLoader<A>

Parameters:

bounds - bounds of the plane.

Returns:

An opened plane using the given bounds.

loadArray

public A loadArray(net.imglib2.Interval bounds,
                   A data)

reader

protected Reader reader()

Returns:

Reader used for plane loading

isCompatible

protected boolean isCompatible()

Returns:

true iff the byte[]'s passed to convertBytes will match the generic type of this loader.

utils

protected ImgUtilityService utils()

Returns:

an ImgUtilityService instance for this loader.

convertBytes

public abstract void convertBytes(A data,
                                  byte[] bytes,
                                  int planesRead)

Type-specific conversion method. The given data is populated using the provided byte array, at a position based on planes read, assuming the length of the given byte array corresponds to one plane.

outputClass

public abstract Class<?> outputClass()

Returns:

The generic type of this loader.