DiskCachedCellImgFactory (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.img.ImgFactory<T>
- - net.imglib2.img.NativeImgFactory<T>
  - - net.imglib2.cache.img.DiskCachedCellImgFactory<T>

```
public class DiskCachedCellImgFactory<T extends NativeType<T>>
extends NativeImgFactory<T>
```
Factory for creating DiskCachedCellImgs. See DiskCachedCellImgOptions for available configuration options and defaults.

Author:

Tobias Pietzsch

Constructor Summary

Constructors
Constructor and Description
`DiskCachedCellImgFactory()` Deprecated.
`DiskCachedCellImgFactory(DiskCachedCellImgOptions optional)` Deprecated.
`DiskCachedCellImgFactory(T type)` Create a new `DiskCachedCellImgFactory` with default configuration.
`DiskCachedCellImgFactory(T type, DiskCachedCellImgOptions optional)` Create a new `DiskCachedCellImgFactory` with the specified configuration.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`DiskCachedCellImg<T,?>`	`create(Dimensions dimensions)` Create an `Img<T>` with the specified `dimensions`.
`DiskCachedCellImg<T,?>`	`create(Dimensions dimensions, CellLoader<T> loader)`
`DiskCachedCellImg<T,?>`	`create(Dimensions dimensions, CellLoader<T> loader, DiskCachedCellImgOptions additionalOptions)`
`DiskCachedCellImg<T,?>`	`create(Dimensions dimensions, DiskCachedCellImgOptions additionalOptions)`
`DiskCachedCellImg<T,?>`	`create(int[] dimensions)` Create an `Img<T>` with the specified `dimensions`.
`DiskCachedCellImg<T,?>`	`create(long... dimensions)` Create a `NativeImg` with the specified `dimensions`.
`DiskCachedCellImg<T,?>`	`create(long[] dimensions, CellLoader<T> loader)`
`DiskCachedCellImg<T,?>`	`create(long[] dimensions, CellLoader<T> loader, DiskCachedCellImgOptions additionalOptions)`
`DiskCachedCellImg<T,?>`	`create(long[] dimensions, DiskCachedCellImgOptions additionalOptions)`
`DiskCachedCellImg<T,?>`	`create(long[] dim, T type)` Deprecated.
`DiskCachedCellImg<T,?>`	`create(long[] dim, T type, CellLoader<T> loader)` Deprecated.
`DiskCachedCellImg<T,?>`	`create(long[] dim, T type, CellLoader<T> loader, DiskCachedCellImgOptions additionalOptions)` Deprecated.
`DiskCachedCellImg<T,?>`	`create(long[] dim, T type, DiskCachedCellImgOptions additionalOptions)` Deprecated.
`<A> DiskCachedCellImg<T,A>`	`createWithCacheLoader(Dimensions dimensions, CacheLoader<Long,Cell<A>> backingLoader)`
`<A> DiskCachedCellImg<T,A>`	`createWithCacheLoader(Dimensions dimensions, CacheLoader<Long,Cell<A>> backingLoader, DiskCachedCellImgOptions additionalOptions)`
`<A> DiskCachedCellImg<T,A>`	`createWithCacheLoader(long[] dimensions, CacheLoader<Long,Cell<A>> backingLoader)`
`<A> DiskCachedCellImg<T,A>`	`createWithCacheLoader(long[] dimensions, CacheLoader<Long,Cell<A>> backingLoader, DiskCachedCellImgOptions additionalOptions)`
`<A> DiskCachedCellImg<T,A>`	`createWithCacheLoader(long[] dim, T type, CacheLoader<Long,Cell<A>> backingLoader)` Deprecated.
`<A> DiskCachedCellImg<T,A>`	`createWithCacheLoader(long[] dim, T type, CacheLoader<Long,Cell<A>> backingLoader, DiskCachedCellImgOptions additionalOptions)` Deprecated.
`<S> ImgFactory<S>`	`imgFactory(S type)` Creates the same `ImgFactory` for a different generic parameter if possible.

Methods inherited from class net.imglib2.img.ImgFactory
cache, create, create, create, create, create, imgFactory, type

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

Constructor Detail

DiskCachedCellImgFactory
```
public DiskCachedCellImgFactory(T type)
```
Create a new DiskCachedCellImgFactory with default configuration.

DiskCachedCellImgFactory

public DiskCachedCellImgFactory(T type,
                                DiskCachedCellImgOptions optional)

Create a new DiskCachedCellImgFactory with the specified configuration.

Parameters:: optional - configuration options.

DiskCachedCellImgFactory

@Deprecated
public DiskCachedCellImgFactory()

Deprecated.

DiskCachedCellImgFactory

@Deprecated
public DiskCachedCellImgFactory(DiskCachedCellImgOptions optional)

Deprecated.

Method Detail

create
```
public DiskCachedCellImg<T,?> create(long... dimensions)
```
Description copied from class: NativeImgFactory

Create a NativeImg with the specified dimensions.

Specified by:

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

Parameters:

dimensions - the dimensions of the image.

Returns:

new NativeImg with the specified dimensions.

create
```
public DiskCachedCellImg<T,?> create(Dimensions dimensions)
```
Description copied from class: NativeImgFactory

Create an Img<T> with the specified dimensions.

Overrides:

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

Returns:

new image with the specified dimensions.

create
```
public DiskCachedCellImg<T,?> create(int[] dimensions)
```
Description copied from class: NativeImgFactory

Create an Img<T> with the specified dimensions.
Note: This is not a vararg function because the underlying int[] based methods already copies the int[] dimensions into a disposable long[] anyways. This would be an unnecessary copy for int... varargs.

Overrides:

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

Returns:

new image with the specified dimensions.

create

public DiskCachedCellImg<T,?> create(long[] dimensions,
                                     DiskCachedCellImgOptions additionalOptions)

create

public DiskCachedCellImg<T,?> create(Dimensions dimensions,
                                     DiskCachedCellImgOptions additionalOptions)

create

public DiskCachedCellImg<T,?> create(long[] dimensions,
                                     CellLoader<T> loader)

create

public DiskCachedCellImg<T,?> create(Dimensions dimensions,
                                     CellLoader<T> loader)

create

public DiskCachedCellImg<T,?> create(long[] dimensions,
                                     CellLoader<T> loader,
                                     DiskCachedCellImgOptions additionalOptions)

create

public DiskCachedCellImg<T,?> create(Dimensions dimensions,
                                     CellLoader<T> loader,
                                     DiskCachedCellImgOptions additionalOptions)

createWithCacheLoader

public <A> DiskCachedCellImg<T,A> createWithCacheLoader(long[] dimensions,
                                                        CacheLoader<Long,Cell<A>> backingLoader)

createWithCacheLoader

public <A> DiskCachedCellImg<T,A> createWithCacheLoader(Dimensions dimensions,
                                                        CacheLoader<Long,Cell<A>> backingLoader)

createWithCacheLoader

public <A> DiskCachedCellImg<T,A> createWithCacheLoader(long[] dimensions,
                                                        CacheLoader<Long,Cell<A>> backingLoader,
                                                        DiskCachedCellImgOptions additionalOptions)

createWithCacheLoader

public <A> DiskCachedCellImg<T,A> createWithCacheLoader(Dimensions dimensions,
                                                        CacheLoader<Long,Cell<A>> backingLoader,
                                                        DiskCachedCellImgOptions additionalOptions)

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

create

@Deprecated
public DiskCachedCellImg<T,?> create(long[] dim,
                                                 T type)

Deprecated.

Specified by:: create in class NativeImgFactory<T extends NativeType<T>>

create

@Deprecated
public DiskCachedCellImg<T,?> create(long[] dim,
                                                 T type,
                                                 DiskCachedCellImgOptions additionalOptions)

Deprecated.

create

@Deprecated
public DiskCachedCellImg<T,?> create(long[] dim,
                                                 T type,
                                                 CellLoader<T> loader)

Deprecated.

create

@Deprecated
public DiskCachedCellImg<T,?> create(long[] dim,
                                                 T type,
                                                 CellLoader<T> loader,
                                                 DiskCachedCellImgOptions additionalOptions)

Deprecated.

createWithCacheLoader

@Deprecated
public <A> DiskCachedCellImg<T,A> createWithCacheLoader(long[] dim,
                                                                    T type,
                                                                    CacheLoader<Long,Cell<A>> backingLoader)

Deprecated.

createWithCacheLoader

@Deprecated
public <A> DiskCachedCellImg<T,A> createWithCacheLoader(long[] dim,
                                                                    T type,
                                                                    CacheLoader<Long,Cell<A>> backingLoader,
                                                                    DiskCachedCellImgOptions additionalOptions)

Deprecated.

Class DiskCachedCellImgFactory<T extends NativeType<T>>

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.img.ImgFactory

Methods inherited from class java.lang.Object

Constructor Detail

DiskCachedCellImgFactory

DiskCachedCellImgFactory

DiskCachedCellImgFactory

DiskCachedCellImgFactory

Method Detail

create

create

create

create

create

create

create

create

create

createWithCacheLoader

createWithCacheLoader

createWithCacheLoader

createWithCacheLoader

imgFactory

create

create

create

create

createWithCacheLoader

createWithCacheLoader