ImagePlusReader (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- loci.plugins.in.ImagePlusReader

All Implemented Interfaces:

loci.common.StatusReporter
```
public class ImagePlusReader
extends Object
implements loci.common.StatusReporter
```
A high-level reader for ImagePlus objects.

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<loci.common.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.

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addStatusListener(loci.common.StatusListener l)`
`static ij.ImagePlus`	`createImage(String title, ij.ImageStack stack, List<ij.process.LUT> luts)` Creates an `ImagePlus` from the given image stack.
`static ij.ImagePlus`	`createImage(String title, List<ij.process.ImageProcessor> procs)` Creates an `ImagePlus` from the given image processors.
`static ij.ImageStack`	`createStack(List<ij.process.ImageProcessor> procs, List<String> labels, List<ij.process.LUT> luts)` Creates an image stack from the given image processors.
`void`	`notifyListeners(loci.common.StatusEvent e)`
`ij.ImagePlus[]`	`openImagePlus()` Opens one or more `ImagePlus` objects corresponding to the reader's associated options.
`ij.ImagePlus[]`	`openThumbImagePlus()`
`void`	`removeStatusListener(loci.common.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 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<loci.common.StatusListener> listeners
```
- 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 ij.ImagePlus[] openImagePlus()
                             throws FormatException,
                                    IOException
```
    Opens one or more ImagePlus objects corresponding to the reader's associated options.
    
    Throws:
    
    FormatException
    
    IOException
  - openThumbImagePlus
```
public ij.ImagePlus[] openThumbImagePlus()
                                  throws FormatException,
                                         IOException
```
    Throws:
    
    FormatException
    
    IOException
  - addStatusListener
```
public void addStatusListener(loci.common.StatusListener l)
```
    Specified by:
    
    addStatusListener in interface loci.common.StatusReporter
  - removeStatusListener
```
public void removeStatusListener(loci.common.StatusListener l)
```
    Specified by:
    
    removeStatusListener in interface loci.common.StatusReporter
  - notifyListeners
```
public void notifyListeners(loci.common.StatusEvent e)
```
    Specified by:
    
    notifyListeners in interface loci.common.StatusReporter
  - createImage
```
public static ij.ImagePlus createImage(String title,
                                       List<ij.process.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 ij.ImagePlus createImage(String title,
                                       ij.ImageStack stack,
                                       List<ij.process.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 ij.ImageStack createStack(List<ij.process.ImageProcessor> procs,
                                        List<String> labels,
                                        List<ij.process.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.

Class ImagePlusReader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_SERIES

PROP_LUT

process

listeners

Constructor Detail

ImagePlusReader

ImagePlusReader

Method Detail

openImagePlus

openThumbImagePlus

addStatusListener

removeStatusListener

notifyListeners

createImage

createImage

createStack