io.scif.img

Class DefaultImgFactoryHeuristic

java.lang.Object

io.scif.img.DefaultImgFactoryHeuristic

All Implemented Interfaces:

ImgFactoryHeuristic

public class DefaultImgFactoryHeuristic
extends Object
implements ImgFactoryHeuristic

Default ImgFactoryHeuristic implementation. Uses the following heuristic to select a factory:

• Check each ImgMode in order
• If ImgMode.ARRAY, select if dataset size < 2GB
• If ImgMode.PLANAR, select if plane size < 2GB and dataset fits memory.
• If ImgMode.CELL, return a SCIFIOCellImgFactory.
• If ImgMode.AUTO or none of the requested types could be selected, check as though the order were ARRAY -> PLANAR -> CELL.

NB: ImgMode.CELL is always satisfied. Thus to avoid a particular ImgMode, provide a list excluding the undesired types that includes ImgMode.CELL last.

Author:

Mark Hiner, Curtis Rueden

Constructor Summary

Constructors

Constructor and Description
DefaultImgFactoryHeuristic()

Method Summary

Modifier and Type	Method and Description
<T> net.imglib2.img.ImgFactory<T>	createFactory(Metadata m, SCIFIOConfig.ImgMode[] imgModes, T type)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultImgFactoryHeuristic

public DefaultImgFactoryHeuristic()

Method Detail

createFactory

public <T> net.imglib2.img.ImgFactory<T> createFactory(Metadata m,
                                                       SCIFIOConfig.ImgMode[] imgModes,
                                                       T type)
                                                throws net.imglib2.exception.IncompatibleTypeException

Specified by:

createFactory in interface ImgFactoryHeuristic

Parameters:

m - Metadata describing the image

imgModes - An ordered list of ImgModes. Each should be investigated in the order they appear.

Returns:

An ImgFactory implementation capable of creating appropriate Imgs.

Throws:

net.imglib2.exception.IncompatibleTypeException - If an ImgFactory of type T can't be created matching the type described by the Metadata.