net.imglib2.img.cell

Class CellImgFactory<T extends NativeType<T>>

java.lang.Object

net.imglib2.img.ImgFactory<T>

net.imglib2.img.NativeImgFactory<T>

net.imglib2.img.cell.CellImgFactory<T>

public class CellImgFactory<T extends NativeType<T>>
extends NativeImgFactory<T>

Factory for creating CellImgs. The cell dimensions for a standard cell can be supplied in the constructor of the factory. If no cell dimensions are given, the factory creates cells of size 10 x 10 x ... x 10.

Author:

Tobias Pietzsch

Constructor Summary

Constructors

Constructor and Description
CellImgFactory()
CellImgFactory(int... cellDimensions)

Method Summary

Modifier and Type	Method and Description
CellImg<T,?>	create(long[] dim, T type) This class will ask the Type to create a suitable Img for the Type and the dimensionality.
CellImg<T,ByteArray>	createByteInstance(long[] dimensions, Fraction entitiesPerPixel)
CellImg<T,CharArray>	createCharInstance(long[] dimensions, Fraction entitiesPerPixel)
CellImg<T,DoubleArray>	createDoubleInstance(long[] dimensions, Fraction entitiesPerPixel)
CellImg<T,FloatArray>	createFloatInstance(long[] dimensions, Fraction entitiesPerPixel)
CellImg<T,IntArray>	createIntInstance(long[] dimensions, Fraction entitiesPerPixel)
CellImg<T,LongArray>	createLongInstance(long[] dimensions, Fraction entitiesPerPixel)
CellImg<T,ShortArray>	createShortInstance(long[] dimensions, Fraction entitiesPerPixel)
static int[]	getCellDimensions(int[] defaultCellDimensions, int n, Fraction entitiesPerPixel) Computes cell size array by truncating or expanding defaultCellDimensions to length n.
<S> ImgFactory<S>	imgFactory(S type) Creates the same ImgFactory for a different generic parameter if possible.
static void	verifyDimensions(int[] dimensions) Verify that dimensions is not null or empty, and that no dimension is less than 1.
static void	verifyDimensions(long[] dimensions) Verify that dimensions is not null or empty, and that no dimension is less than 1.

Methods inherited from class net.imglib2.img.ImgFactory

create, create, create, create, create, imgFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

CellImgFactory

public CellImgFactory()

CellImgFactory

public CellImgFactory(int... cellDimensions)

Method Detail

verifyDimensions

public static void verifyDimensions(int[] dimensions)
                             throws IllegalArgumentException

Verify that dimensions is not null or empty, and that no dimension is less than 1. Throw IllegalArgumentException otherwise.

Parameters:

dimensions -

Throws:

IllegalArgumentException

verifyDimensions

public static void verifyDimensions(long[] dimensions)
                             throws IllegalArgumentException

Verify that dimensions is not null or empty, and that no dimension is less than 1. Throw IllegalArgumentException otherwise.

Parameters:

dimensions -

Throws:

IllegalArgumentException

getCellDimensions

public static int[] getCellDimensions(int[] defaultCellDimensions,
                                      int n,
                                      Fraction entitiesPerPixel)
                               throws IllegalArgumentException

Computes cell size array by truncating or expanding defaultCellDimensions to length n. Then verifies that a cell does not contain more than Integer.MAX_VALUE entities.

Parameters:

defaultCellDimensions -

n -

entitiesPerPixel -

Returns:

Throws:

IllegalArgumentException

create

public CellImg<T,?> create(long[] dim,
                           T type)

Description copied from class: NativeImgFactory

This class will ask the Type to create a suitable Img for the Type and the dimensionality. Type will then call one of the abstract methods defined below to create the NativeImg

Overrides:

create in class NativeImgFactory<T extends NativeType<T>>

Returns:

Img - the instantiated Container

createByteInstance

public CellImg<T,ByteArray> createByteInstance(long[] dimensions,
                                               Fraction entitiesPerPixel)

Specified by:

createByteInstance in class NativeImgFactory<T extends NativeType<T>>

createCharInstance

public CellImg<T,CharArray> createCharInstance(long[] dimensions,
                                               Fraction entitiesPerPixel)

Specified by:

createCharInstance in class NativeImgFactory<T extends NativeType<T>>

createShortInstance

public CellImg<T,ShortArray> createShortInstance(long[] dimensions,
                                                 Fraction entitiesPerPixel)

Specified by:

createShortInstance in class NativeImgFactory<T extends NativeType<T>>

createIntInstance

public CellImg<T,IntArray> createIntInstance(long[] dimensions,
                                             Fraction entitiesPerPixel)

Specified by:

createIntInstance in class NativeImgFactory<T extends NativeType<T>>

createLongInstance

public CellImg<T,LongArray> createLongInstance(long[] dimensions,
                                               Fraction entitiesPerPixel)

Specified by:

createLongInstance in class NativeImgFactory<T extends NativeType<T>>

createFloatInstance

public CellImg<T,FloatArray> createFloatInstance(long[] dimensions,
                                                 Fraction entitiesPerPixel)

Specified by:

createFloatInstance in class NativeImgFactory<T extends NativeType<T>>

createDoubleInstance

public CellImg<T,DoubleArray> createDoubleInstance(long[] dimensions,
                                                   Fraction entitiesPerPixel)

Specified by:

createDoubleInstance in class NativeImgFactory<T extends NativeType<T>>

imgFactory

public <S> ImgFactory<S> imgFactory(S type)
                             throws IncompatibleTypeException

Description copied from class: ImgFactory

Creates the same ImgFactory for a different generic parameter if possible. If the type "S" does not suit the needs of the ImgFactory (for example implement NativeType in all NativeImgFactory, this method will throw an IncompatibleTypeException.

Specified by:

imgFactory in class ImgFactory<T extends NativeType<T>>

Type Parameters:

S - the new type

Parameters:

type - an instance of S

Returns:

ImgFactory of type S

Throws:

IncompatibleTypeException - if type S is not compatible