ImageStack (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.janelia.it.jacs.shared.ffmpeg.ImageStack

```
public class ImageStack
extends Object
```
A stack of video frames read from FFmpeg

Author:

bostadm@janelia.hhmi.org

Constructor Summary

Constructors
Constructor and Description

ImageStack()

Constructors
Constructor and Description
`ImageStack()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Frame f)` Add a Frame to the end of the stack
`Frame`	`frame(int i)` Returns a Frame of the ith image in the stack
`int`	`getBytesPerPixel()`
`String`	`getInfo()`
`int`	`getNumComponents()`
`int`	`getNumFrames()` The number of frames in the stack
`int`	`getPaddingBottom()`
`int`	`getPaddingRight()`
`double[]`	`getSpacings()`
`String`	`getUnit()`
`int`	`height()` The height of the image in the stack
`byte[]`	`image(int i, int component)` Return a byte arryay of the pixels of the ith frame/image in the stack
`byte[]`	`interleave(int idx, int component, int count)` Return a byte array of the pixels of the ith frame/image in the stack
`int`	`linesize(int i)` A convenience routine for the size of a line of data (FFmpeg specific)
`void`	`merge(ImageStack other)` Merge the channels from another ImageStack to the end of this one
`void`	`release()` Release the resources used by this class
`void`	`setBytesPerPixel(int bytes_per_pixel)`
`void`	`setHeight(int height)` Setter method for height
`void`	`setInfo(String info)`
`void`	`setPaddingBottom(int _padding_bottom)`
`void`	`setPaddingRight(int _padding_right)`
`void`	`setSpacings(double spcx, double spcy, double spcz)`
`void`	`setUnit(String unit)`
`void`	`setWidth(int width)` Setter method for width
`int`	`width()` The width of the images in the stack

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

- Constructor Detail
  - ImageStack
```
public ImageStack()
```
- Method Detail
  - width
```
public int width()
```
    The width of the images in the stack
    
    Returns:
    
    the width of an individual image
  - setWidth
```
public void setWidth(int width)
```
    Setter method for width
    
    Parameters:
    
    width - - the width of an individual image
  - height
```
public int height()
```
    The height of the image in the stack
    
    Returns:
    
    the height of an individual image (in pixels)
  - setHeight
```
public void setHeight(int height)
```
    Setter method for height
    
    Parameters:
    
    height - - the height of an individual image
  - getPaddingRight
```
public int getPaddingRight()
```
    Returns:
    
    the _padding_right
  - setPaddingRight
```
public void setPaddingRight(int _padding_right)
```
    Parameters:
    
    _padding_right - the _padding_right to set
  - getPaddingBottom
```
public int getPaddingBottom()
```
    Returns:
    
    the _padding_bottom
  - setPaddingBottom
```
public void setPaddingBottom(int _padding_bottom)
```
    Parameters:
    
    _padding_bottom - the _padding_bottom to set
  - getNumFrames
```
public int getNumFrames()
```
    The number of frames in the stack
    
    Returns:
    
    the number of individual frames
  - getNumComponents
```
public int getNumComponents()
```
  - getBytesPerPixel
```
public int getBytesPerPixel()
```
  - setBytesPerPixel
```
public void setBytesPerPixel(int bytes_per_pixel)
```
  - getSpacings
```
public double[] getSpacings()
```
  - setSpacings
```
public void setSpacings(double spcx,
                        double spcy,
                        double spcz)
```
  - getUnit
```
public String getUnit()
```
  - setUnit
```
public void setUnit(String unit)
```
  - image
```
public byte[] image(int i,
                    int component)
```
    Return a byte arryay of the pixels of the ith frame/image in the stack
    
    Parameters:
    
    i - - image index
    
    component - - component index
    
    Returns:
    
    the bytes representing the image
  - interleave
```
public byte[] interleave(int idx,
                         int component,
                         int count)
```
    Return a byte array of the pixels of the ith frame/image in the stack
    
    Parameters:
    
    idx - - image index
    
    component - - component index
    
    count - - number of components to use
    
    Returns:
    
    the bytes representing the image
  - frame
```
public Frame frame(int i)
```
    Returns a Frame of the ith image in the stack
    
    Parameters:
    
    i - - image index
    
    Returns:
    
    the individual frame
  - linesize
```
public int linesize(int i)
```
    A convenience routine for the size of a line of data (FFmpeg specific)
    
    Parameters:
    
    i - - image index
    
    Returns:
    
    the size of a line of data
  - add
```
public void add(Frame f)
```
    Add a Frame to the end of the stack
    
    Parameters:
    
    f - - The Frame to add
  - merge
```
public void merge(ImageStack other)
```
    Merge the channels from another ImageStack to the end of this one
    
    Parameters:
    
    other - - The other ImageStack to add
  - release
```
public void release()
             throws Exception
```
    Release the resources used by this class
    
    Throws:
    
    Exception
  - setInfo
```
public void setInfo(String info)
```
  - getInfo
```
public String getInfo()
```

Class ImageStack

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImageStack

Method Detail

width

setWidth

height

setHeight

getPaddingRight

setPaddingRight

getPaddingBottom

setPaddingBottom

getNumFrames

getNumComponents

getBytesPerPixel

setBytesPerPixel

getSpacings

setSpacings

getUnit

setUnit

image

interleave

frame

linesize

add

merge

release

setInfo

getInfo