loci.plugins.in

Class ImagePlusReader

java.lang.Object

loci.plugins.in.ImagePlusReader

All Implemented Interfaces:

StatusReporter

public class ImagePlusReader
extends java.lang.Object
implements StatusReporter

A high-level reader for ImagePlus objects.

Source code:

Trac, Gitweb

Field Summary

Fields

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

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)
static ImagePlus	createImage(java.lang.String title, ImageStack stack, java.util.List<LUT> luts) Creates an ImagePlus from the given image stack.
static ImagePlus	createImage(java.lang.String title, java.util.List<ImageProcessor> procs) Creates an ImagePlus from the given image processors.
static ImageStack	createStack(java.util.List<ImageProcessor> procs, java.util.List<java.lang.String> labels, java.util.List<LUT> luts) Creates an image stack from the given image processors.
void	notifyListeners(StatusEvent e)
ImagePlus[]	openImagePlus() Opens one or more ImagePlus objects corresponding to the reader's associated options.
ImagePlus[]	openThumbImagePlus()
void	removeStatusListener(StatusListener l)

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 java.lang.String PROP_SERIES

Special property for storing series number associated with the image.

See Also:

Constant Field Values

PROP_LUT

public static final java.lang.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 java.util.List<StatusListener> listeners

Constructor Detail

ImagePlusReader

public ImagePlusReader()
                throws java.io.IOException

Constructs an ImagePlusReader with the default options.

Throws:

java.io.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,
                                 java.io.IOException

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

Throws:

FormatException

java.io.IOException

openThumbImagePlus

public ImagePlus[] openThumbImagePlus()
                               throws FormatException,
                                      java.io.IOException

Throws:

FormatException

java.io.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(java.lang.String title,
                    java.util.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(java.lang.String title,
                    ImageStack stack,
                    java.util.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(java.util.List<ImageProcessor> procs,
                     java.util.List<java.lang.String> labels,
                     java.util.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.