loci.plugins.in

Class ImagePlusReader

java.lang.Object

loci.plugins.in.ImagePlusReader

All Implemented Interfaces:

StatusReporter

public class ImagePlusReader
extends Object
implements StatusReporter

A high-level reader for ImagePlus objects.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<StatusListener>	listeners
protected ImportProcess	process Import preparation process managing Bio-Formats readers and other state.
static String	PROP_LUT Special property prefix for storing planar LUTs.
static String	PROP_SERIES Special property for storing series number associated with the image.
private long	startTime
private long	time

Constructor Summary

Constructors

Constructor and Description
ImagePlusReader() Constructs an ImagePlusReader with the default options.
ImagePlusReader(ImportProcess process) Constructs an ImagePlusReader with the given complete import preparation process.

Method Summary

Methods

Modifier and Type	Method and Description
void	addStatusListener(StatusListener l)
private List<ImagePlus>	applyColors(List<ImagePlus> imps)
private List<ImagePlus>	concatenate(List<ImagePlus> imps)
private String	constructImageTitle(IFormatReader r, String file, String seriesName, boolean groupFiles)
private String	constructSliceLabel(int ndx, IFormatReader r, IMetadata meta, int series, int zCount, int cCount, int tCount)
private FileInfo	createFileInfo()
static ImagePlus	createImage(String title, ImageStack stack, List<LUT> luts) Creates an ImagePlus from the given image stack.
static ImagePlus	createImage(String title, List<ImageProcessor> procs) Creates an ImagePlus from the given image processors.
static ImageStack	createStack(List<ImageProcessor> procs, List<String> labels, List<LUT> luts) Creates an image stack from the given image processors.
private ImageStack	createVirtualStack(ImportProcess process, int s, List<LUT> luts)
private void	finishTiming()
private boolean[]	getPlanesToLoad(int s)
void	notifyListeners(StatusEvent e)
ImagePlus[]	openImagePlus() Opens one or more ImagePlus objects corresponding to the reader's associated options.
ImagePlus[]	openThumbImagePlus()
private ImagePlus	readImage(int s, boolean thumbnail)
private List<ImagePlus>	readImages()
private List<ImagePlus>	readImages(boolean thumbnail)
private ImageStack	readPlanes(ImportProcess process, int s, List<LUT> luts, boolean thumbnail)
private ImageProcessor[]	readProcessors(ImportProcess process, int no, Region r, boolean thumbnail) HACK: This method mainly exists to prompt the user for a missing LuraWave license code, in the case of LWF-compressed Flex.
private List<ImagePlus>	readThumbImages()
void	removeStatusListener(StatusListener l)
private static void	saveLUTs(ImagePlus imp, List<LUT> luts)
private List<ImagePlus>	splitDims(List<ImagePlus> imps)
private void	startTiming()
private void	updateTiming(int s, int i, int current, int total)

Methods inherited from class java.lang.Object

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

Field Detail

PROP_SERIES

public static final String PROP_SERIES

Special property for storing series number associated with the image.

See Also:

Constant Field Values

PROP_LUT

public static final String PROP_LUT

Special property prefix for storing planar LUTs.

See Also:

Constant Field Values

process

protected ImportProcess process

Import preparation process managing Bio-Formats readers and other state.

listeners

protected List<StatusListener> listeners

startTime

private long startTime

time

private long time

Constructor Detail

ImagePlusReader

public ImagePlusReader()
                throws IOException

Constructs an ImagePlusReader with the default options.

Throws:

IOException - if the default options cannot be determined.

ImagePlusReader

public ImagePlusReader(ImportProcess process)

Constructs an ImagePlusReader with the given complete import preparation process.

Method Detail

openImagePlus

public ImagePlus[] openImagePlus()
                          throws FormatException,
                                 IOException

Opens one or more ImagePlus objects corresponding to the reader's associated options.

Throws:

FormatException

IOException

openThumbImagePlus

public ImagePlus[] openThumbImagePlus()
                               throws FormatException,
                                      IOException

Throws:

FormatException

IOException

addStatusListener

public void addStatusListener(StatusListener l)

Specified by:

addStatusListener in interface StatusReporter

removeStatusListener

public void removeStatusListener(StatusListener l)

Specified by:

removeStatusListener in interface StatusReporter

notifyListeners

public void notifyListeners(StatusEvent e)

Specified by:

notifyListeners in interface StatusReporter

createImage

public static ImagePlus createImage(String title,
                    List<ImageProcessor> procs)

Creates an ImagePlus from the given image processors.

Parameters:

title - The title for the image.

procs - List of image processors to compile into an image.

createImage

public static ImagePlus createImage(String title,
                    ImageStack stack,
                    List<LUT> luts)

Creates an ImagePlus from the given image stack.

Parameters:

title - The title for the image.

stack - The image stack containing the image planes.

luts - Optional list of plane-specific LUTs to store as image properties, for later use.

createStack

public static ImageStack createStack(List<ImageProcessor> procs,
                     List<String> labels,
                     List<LUT> luts)

Creates an image stack from the given image processors.

Parameters:

procs - List of image processors to compile into a stack.

labels - Optional list of labels, one per plane.

luts - Optional list for storing plane-specific LUTs, for later use.

readImages

private List<ImagePlus> readImages()
                            throws FormatException,
                                   IOException

Throws:

FormatException

IOException

readThumbImages

private List<ImagePlus> readThumbImages()
                                 throws FormatException,
                                        IOException

Throws:

FormatException

IOException

readImages

private List<ImagePlus> readImages(boolean thumbnail)
                            throws FormatException,
                                   IOException

Throws:

FormatException

IOException

readImage

private ImagePlus readImage(int s,
                  boolean thumbnail)
                     throws FormatException,
                            IOException

Throws:

FormatException

IOException

createVirtualStack

private ImageStack createVirtualStack(ImportProcess process,
                            int s,
                            List<LUT> luts)
                               throws FormatException,
                                      IOException

Throws:

FormatException

IOException

readPlanes

private ImageStack readPlanes(ImportProcess process,
                    int s,
                    List<LUT> luts,
                    boolean thumbnail)
                       throws FormatException,
                              IOException

Throws:

FormatException

IOException

readProcessors

private ImageProcessor[] readProcessors(ImportProcess process,
                              int no,
                              Region r,
                              boolean thumbnail)
                                 throws FormatException,
                                        IOException

HACK: This method mainly exists to prompt the user for a missing LuraWave license code, in the case of LWF-compressed Flex.

Throws:

FormatException

IOException

See Also:

ImportProcess.setId()

concatenate

private List<ImagePlus> concatenate(List<ImagePlus> imps)

applyColors

private List<ImagePlus> applyColors(List<ImagePlus> imps)

splitDims

private List<ImagePlus> splitDims(List<ImagePlus> imps)

startTiming

private void startTiming()

updateTiming

private void updateTiming(int s,
                int i,
                int current,
                int total)

finishTiming

private void finishTiming()

createFileInfo

private FileInfo createFileInfo()

getPlanesToLoad

private boolean[] getPlanesToLoad(int s)

constructImageTitle

private String constructImageTitle(IFormatReader r,
                         String file,
                         String seriesName,
                         boolean groupFiles)

constructSliceLabel

private String constructSliceLabel(int ndx,
                         IFormatReader r,
                         IMetadata meta,
                         int series,
                         int zCount,
                         int cCount,
                         int tCount)

saveLUTs

private static void saveLUTs(ImagePlus imp,
            List<LUT> luts)