WritableVirtualStack (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- ij.ImageStack
- - video2.WritableVirtualStack

```
public class WritableVirtualStack
extends ij.ImageStack
```
This class represents an array of disk-resident images. In the same folder as the images, a file 'indices' is stored, which holds the order in which the indices occur. The names of the image files are restricted to be in the format int + ".tif".

Constructor Summary

Constructors
Constructor and Description
`WritableVirtualStack(String dir)` Creates a new Writable Stack, using the given directory as a folder for the individual images.
`WritableVirtualStack(String dir, int w, int h)` Creates a new Writable Stack, using the given directory as a folder for the individual images.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSlice(String name)` Adds a slice to the end of the stack.
`void`	`addSlice(String name, ij.process.ImageProcessor ip)` Adds the given ImageProcessor as a slice to the end of the stack.
`void`	`addSlice(String name, ij.process.ImageProcessor ip, int n)` Adds the given ImageProcessor as a slice at the specified position in the stack.
`void`	`addSlice(String name, Object pixels)` Adds a slice with the given pixels to the end of the stack.
`void`	`deleteLastSlice()` Deletes the last slice in the stack.
`void`	`deleteSlice(int n)` Deletes the specified slice.
`String`	`getDirectory()` Returns the path to the directory containing the images.
`String`	`getFileName(int n)` Returns the file name of the specified slice, where 1 <= n <= nslices.
`int`	`getHeight()` Returns the height of this stack.
`Object[]`	`getImageArray()` Returns null.
`Object`	`getPixels(int n)` Returns the pixel array for the specified slice, where 1 <= n <= nslices.
`ij.process.ImageProcessor`	`getProcessor(int n)` Returns an ImageProcessor for the specified slice.
`int`	`getSize()` Returns the number of slices in this stack.
`String`	`getSliceLabel(int n)` Returns the label of the Nth image, where 1 <= n <= nSlices.
`int`	`getWidth()` Returns the width of this stack.
`boolean`	`isVirtual()` Always return true.
`void`	`saveIndicesFile()` Saves the 'indices' file to the image directory.
`void`	`setPixels(Object pixels, int n)` Assigns a pixel array to the specified slice.
`void`	`setSliceLabel(String label, int n)` Does nothing.
`void`	`trim()` Does nothing.

Methods inherited from class ij.ImageStack
addSlice, addUnsignedShortSlice, convertToFloat, create, create, crop, drawSphere, duplicate, getBitDepth, getColorModel, getRoi, getShortSliceLabel, getSliceLabels, getVoxel, getVoxels, getVoxels, isHSB, isHSB32, isLab, isRGB, setBitDepth, setColorModel, setProcessor, setRoi, setVoxel, setVoxels, setVoxels, size, toString, update

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

- Constructor Detail
  - WritableVirtualStack
```
public WritableVirtualStack(String dir,
                            int w,
                            int h)
```
    Creates a new Writable Stack, using the given directory as a folder for the individual images. If the folder is empty, a new stack is created, using a ColorProcessor of the given width and height as template. If the given directory does not exist, it is created. If the given directory is not empty, and the containing images' dimensions do not match the specified width and height, an exception is thrown.
  - WritableVirtualStack
```
public WritableVirtualStack(String dir)
```
    Creates a new Writable Stack, using the given directory as a folder for the individual images. If the folder is empty, or does not exist, an exception is thrown, because the required image dimensions are not specified; use WritableVirtualStack(dir, w, h) in this case).
- Method Detail
  - getWidth
```
public int getWidth()
```
    Returns the width of this stack.
    
    Overrides:
    
    getWidth in class ij.ImageStack
  - getHeight
```
public int getHeight()
```
    Returns the height of this stack.
    
    Overrides:
    
    getHeight in class ij.ImageStack
  - saveIndicesFile
```
public void saveIndicesFile()
```
    Saves the 'indices' file to the image directory.
  - addSlice
```
public void addSlice(String name)
```
    Adds a slice to the end of the stack.
    
    Parameters:
    
    name - The name of the slice. This parameter exists only for compatibility reasons with ImageStack, but is not used here.
  - addSlice
```
public void addSlice(String name,
                     Object pixels)
```
    Adds a slice with the given pixels to the end of the stack.
    
    Overrides:
    
    addSlice in class ij.ImageStack
    
    Parameters:
    
    name - The name of the slice. This parameter exists only for compatibility reasons with ImageStack, but is not used here.
    
    pixels - The pixel array for the new slice.
  - addSlice
```
public void addSlice(String name,
                     ij.process.ImageProcessor ip)
```
    Adds the given ImageProcessor as a slice to the end of the stack.
    
    Overrides:
    
    addSlice in class ij.ImageStack
    
    Parameters:
    
    name - The name of the slice. This parameter exists only for compatibility reasons with ImageStack, but is not used here.
    
    ip - The ImageProcessor for the new slice.
  - addSlice
```
public void addSlice(String name,
                     ij.process.ImageProcessor ip,
                     int n)
```
    Adds the given ImageProcessor as a slice at the specified position in the stack.
    
    Overrides:
    
    addSlice in class ij.ImageStack
    
    Parameters:
    
    name - The name of the slice. This parameter exists only for compatibility reasons with ImageStack, but is not used here.
    
    ip - The ImageProcessor for the new slice.
    
    n - The position of the slice, 0 to add it at the beginning.
  - deleteSlice
```
public void deleteSlice(int n)
```
    Deletes the specified slice.
    
    Overrides:
    
    deleteSlice in class ij.ImageStack
    
    Parameters:
    
    n - The position of the slice to delete, where 1 <= n <= nslices.
  - deleteLastSlice
```
public void deleteLastSlice()
```
    Deletes the last slice in the stack.
    
    Overrides:
    
    deleteLastSlice in class ij.ImageStack
  - getPixels
```
public Object getPixels(int n)
```
    Returns the pixel array for the specified slice, where 1 <= n <= nslices.
    
    Overrides:
    
    getPixels in class ij.ImageStack
  - setPixels
```
public void setPixels(Object pixels,
                      int n)
```
    Assigns a pixel array to the specified slice.
    
    Overrides:
    
    setPixels in class ij.ImageStack
    
    Parameters:
    
    pixels - The pixel array to be assigned.
    
    n - The slice index, where 1 <= n <= nslices.
  - getProcessor
```
public ij.process.ImageProcessor getProcessor(int n)
```
    Returns an ImageProcessor for the specified slice.
    
    Overrides:
    
    getProcessor in class ij.ImageStack
    
    Parameters:
    
    n - The slice index, where 1 <= n <= nSlices.
    
    Returns:
    
    null if the stack is empty.
  - getSize
```
public int getSize()
```
    Returns the number of slices in this stack.
    
    Overrides:
    
    getSize in class ij.ImageStack
  - getSliceLabel
```
public String getSliceLabel(int n)
```
    Returns the label of the Nth image, where 1 <= n <= nSlices.
    
    Overrides:
    
    getSliceLabel in class ij.ImageStack
  - getImageArray
```
public Object[] getImageArray()
```
    Returns null.
    
    Overrides:
    
    getImageArray in class ij.ImageStack
  - setSliceLabel
```
public void setSliceLabel(String label,
                          int n)
```
    Does nothing.
    
    Overrides:
    
    setSliceLabel in class ij.ImageStack
  - isVirtual
```
public boolean isVirtual()
```
    Always return true.
    
    Overrides:
    
    isVirtual in class ij.ImageStack
  - trim
```
public void trim()
```
    Does nothing.
    
    Overrides:
    
    trim in class ij.ImageStack
  - getDirectory
```
public String getDirectory()
```
    Returns the path to the directory containing the images.
  - getFileName
```
public String getFileName(int n)
```
    Returns the file name of the specified slice, where 1 <= n <= nslices.

Class WritableVirtualStack

Constructor Summary

Method Summary

Methods inherited from class ij.ImageStack

Methods inherited from class java.lang.Object

Constructor Detail

WritableVirtualStack

WritableVirtualStack

Method Detail

getWidth

getHeight

saveIndicesFile

addSlice

addSlice

addSlice

addSlice

deleteSlice

deleteLastSlice

getPixels

setPixels

getProcessor

getSize

getSliceLabel

getImageArray

setSliceLabel

isVirtual

trim

getDirectory

getFileName