BatchOpener (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- util.BatchOpener

```
public class BatchOpener
extends Object
```
This class contains methods I would like to see incorporated into HandleExtraFileTypes, or elsewhere. The main features are:
- An open method that returns an array of ImagePlus objects, one per channel, without calling show() on any of them.
- Files are identified as particular types by their content, (magic numbers, etc.) rather then their file extension. (The exception to this is the TorstenRaw_GZ_Reader, since the image files are raw and have no distinctive header.)
- The method doesn't rely on plugins being present at compile time - instead it uses reflection to check whether the required classes are available. This is a bit ugly, but means that this could be incorporated into the main ImageJ source code more easily.
The types of file that should be coped with properly at the moment are listed below:

Tested file types:
- Zeiss LSM files (using LSM_Toolbox rather than LSM_Reader)
- Leica SP files (using the Leica_SP_Reader plugin)
- Ordinary TIFF files (using the default ImageJ opener)
- AmiraMesh files (using the AmiraMeshReader plugin)
Untested file types (please send me example files!):
- Biorad PIC files (using the Biorad_Reader plugin)
- IPLab files (using the IPLab_Reader plugin)
- Packard InstantImager format (.img) files
- Gatan Digital Micrograph DM3 handler (DM3_Reader plugin)
Author:

Mark Longair

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`BatchOpener.ChannelsAndLoader` A helper class to return the array of ImagePlus as well as an indication of the file loader that was used.
`static class`	`BatchOpener.ImageLoaderException`
`static class`	`BatchOpener.NoSuchChannelException`

Constructor Summary

Constructors
Constructor and Description

BatchOpener()

Constructors
Constructor and Description
`BatchOpener()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static ij.ImagePlus[]`	`open(String path)` Returns an array of ImagePlus objects corresponding to all of the channels in the image file.
`static ij.ImagePlus`	`openFirstChannel(String path)` Returns an ImagePlus corresponding to the first (and possibly only) channel in the image file, without calling show() on the ImagePlus object.
`static ij.ImagePlus`	`openParticularChannel(String path, int i)` Returns an ImagePlus corresponding to the channel with the specified index in the image file.
`static BatchOpener.ChannelsAndLoader`	`openToChannelsAndLoader(String path)` Returns an object with (a) references to the array of ImagePlus objects corresponding to all of the channels in the image file and (b) a string indicating which loader was used.
`static ij.ImagePlus[]`	`splitChannelsToArray(ij.ImagePlus imp, boolean closeAfter)`

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

- Constructor Detail
  - BatchOpener
```
public BatchOpener()
```
- Method Detail
  - openFirstChannel
```
public static ij.ImagePlus openFirstChannel(String path)
```
    Returns an ImagePlus corresponding to the first (and possibly only) channel in the image file, without calling show() on the ImagePlus object. If the file contains no channels, or the file is not found this returns null.
    
    Parameters:
    
    path - the path of the image file to open
  - openParticularChannel
```
public static ij.ImagePlus openParticularChannel(String path,
                                                 int i)
                                          throws BatchOpener.NoSuchChannelException
```
    Returns an ImagePlus corresponding to the channel with the specified index in the image file. If that channel is not found in the image, a util.NoSuchChannelException is thrown. If the file cannot be found or there is any other error in opening, null is returned.
    
    Parameters:
    
    path - the path of the image file to open
    
    i - the (zero-indexed) index of the channel to return
    
    Throws:
    
    BatchOpener.NoSuchChannelException
  - open
```
public static ij.ImagePlus[] open(String path)
```
    Returns an array of ImagePlus objects corresponding to all of the channels in the image file. If the file cannot be found or there is any other error in opening, null is returned.
    
    Parameters:
    
    path - the path of the image file to open
  - openToChannelsAndLoader
```
public static BatchOpener.ChannelsAndLoader openToChannelsAndLoader(String path)
                                                             throws BatchOpener.ImageLoaderException
```
    Returns an object with (a) references to the array of ImagePlus objects corresponding to all of the channels in the image file and (b) a string indicating which loader was used. If the file cannot be found or there is any other error in opening, null is returned.
    
    Parameters:
    
    path - the path of the image file to open
    
    Throws:
    
    BatchOpener.ImageLoaderException
  - splitChannelsToArray
```
public static ij.ImagePlus[] splitChannelsToArray(ij.ImagePlus imp,
                                                  boolean closeAfter)
```

Class BatchOpener

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BatchOpener

Method Detail

openFirstChannel

openParticularChannel

open

openToChannelsAndLoader

splitChannelsToArray