net.imglib2.img

Class ImgFactory<T>

java.lang.Object

net.imglib2.img.ImgFactory<T>

Direct Known Subclasses:

ListImgFactory, NativeImgFactory

public abstract class ImgFactory<T>
extends Object

TODO

Author:

Stephan Preibisch, Stephan Saalfeld

Constructor Summary

Constructors

Constructor and Description
ImgFactory()

Method Summary

Modifier and Type	Method and Description
Img<T>	create(Dimensions dim, T type) The ImgFactory can decide how to create the Img.
Img<T>	create(int[] dim, T type) The ImgFactory can decide how to create the Img.
abstract Img<T>	create(long[] dim, T type) The ImgFactory can decide how to create the Img.
Img<T>	create(Supplier<T> typeSupplier, Dimensions dim) The ImgFactory can decide how to create the Img.
Img<T>	create(Supplier<T> typeSupplier, int[] dim) The ImgFactory can decide how to create the Img.
Img<T>	create(Supplier<T> typeSupplier, long... dim) The ImgFactory can decide how to create the Img.
abstract <S> ImgFactory<S>	imgFactory(S type) Creates the same ImgFactory for a different generic parameter if possible.
<S> ImgFactory<S>	imgFactory(Supplier<S> typeSupplier) Creates the same ImgFactory for a different generic parameter if possible.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImgFactory

public ImgFactory()

Method Detail

create

public abstract Img<T> create(long[] dim,
                              T type)

The ImgFactory can decide how to create the Img. A NativeImgFactory will ask the Type to create a suitable NativeImg.

Returns:

Img

create

public Img<T> create(Dimensions dim,
                     T type)

The ImgFactory can decide how to create the Img. A NativeImgFactory will ask the Type to create a suitable NativeImg.

Returns:

Img

create

public Img<T> create(int[] dim,
                     T type)

The ImgFactory can decide how to create the Img. A NativeImgFactory will ask the Type to create a suitable NativeImg.

Returns:

Img

imgFactory

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

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.

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

create

public Img<T> create(Supplier<T> typeSupplier,
                     long... dim)

The ImgFactory can decide how to create the Img. A NativeImgFactory will ask the supplied Type to create a suitable NativeImg.

Returns:

Img

create

public Img<T> create(Supplier<T> typeSupplier,
                     Dimensions dim)

The ImgFactory can decide how to create the Img. A NativeImgFactory will ask the supplied Type to create a suitable NativeImg.

Returns:

Img

create

public Img<T> create(Supplier<T> typeSupplier,
                     int[] dim)

The ImgFactory can decide how to create the Img. A NativeImgFactory will ask the supplied Type to create a suitable NativeImg.

Note: This is not a vararg function because the underlying int[] based methods alreay copies the int[] dimensions into a disposable long[] anyways. This would be an unnecessary copy for int... varargs.

Returns:

Img

imgFactory

public <S> ImgFactory<S> imgFactory(Supplier<S> typeSupplier)
                             throws IncompatibleTypeException

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

Type Parameters:

S - the new type

Parameters:

typeSupplier - a supplier of S

Returns:

ImgFactory of type S

Throws:

IncompatibleTypeException - if type S is not compatible