ImageContainer (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- levelsets.ij.ImageContainer

Direct Known Subclasses:

ImageProgressContainer
```
public class ImageContainer
extends Object
```
Container for three-dimensional images

Field Summary

Fields
Modifier and Type	Field and Description
`protected ij.ImagePlus`	`ip`
`protected boolean`	`isStack`
`protected ij.process.ShortProcessor`	`lproc`
`protected short[][]`	`proc_pixels`
`protected ij.process.ImageProcessor[]`	`sproc`
`protected int`	`stack_size`
`protected String`	`title`
`protected int`	`width`

Constructor Summary

Constructors
Constructor and Description

ImageContainer()

ImageContainer(ij.ImagePlus ip)
Constructs a new ImageContainer.

ImageContainer(ij.process.ImageProcessor[] iproc)

Constructors
Constructor and Description
`ImageContainer()`
`ImageContainer(ij.ImagePlus ip)` Constructs a new ImageContainer.
`ImageContainer(ij.process.ImageProcessor[] iproc)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyFilter(Filter filter)` Applies the passed Filter on every image in the container.
`void`	`applyFilter(Filter filter, int start, int end)` Applies the passed filter on the selected range of images
`double[][][]`	`calculateGradients()` Calculates grey value gradients of the image container an returns a result array.
`ij.ImagePlus`	`createImagePlus(String title)`
`ImageContainer`	`deepCopy()` Returns a deep copy of the whole ImageContainer
`int`	`getHeight()` Returns the height of the contained images
`int`	`getImageCount()` Returns the number of contained images
`int`	`getPixel(int x, int y, int z)` Returns an array filled with the pixel values at the selected coordinates.
`int`	`getWidth()` Returns the width of the contained images
`double`	`getzScale()`
`BufferedImage`	`ij2bufferedImage(Image im)`
`ImageProgressContainer`	`progressCopy()`
`void`	`setData(double[][][] data)` Sets the image stack to the contents of the passed three-dimensional double value array.
`void`	`setPixel(int x, int y, int z, int pixel)` Sets the selected pixel to value provided by a array
`ij.ImagePlus`	`updateImagePlus(String title)`

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

- Field Detail
  - ip
```
protected ij.ImagePlus ip
```
  - title
```
protected String title
```
  - sproc
```
protected ij.process.ImageProcessor[] sproc
```
  - proc_pixels
```
protected final short[][] proc_pixels
```
  - width
```
protected int width
```
  - stack_size
```
protected int stack_size
```
  - isStack
```
protected boolean isStack
```
  - lproc
```
protected ij.process.ShortProcessor lproc
```
- Constructor Detail
  - ImageContainer
```
public ImageContainer()
```
  - ImageContainer
```
public ImageContainer(ij.ImagePlus ip)
```
    Constructs a new ImageContainer.
  - ImageContainer
```
public ImageContainer(ij.process.ImageProcessor[] iproc)
```
- Method Detail
  - createImagePlus
```
public final ij.ImagePlus createImagePlus(String title)
```
  - updateImagePlus
```
public final ij.ImagePlus updateImagePlus(String title)
```
  - getImageCount
```
public final int getImageCount()
```
    Returns the number of contained images
    
    Returns:
    
    The array filled with pixel values - usually RGB(A).
  - getPixel
```
public final int getPixel(int x,
                          int y,
                          int z)
```
    Returns an array filled with the pixel values at the selected coordinates.
    
    Parameters:
    
    x - The X coordinate
    
    y - The Y coordinate
    
    z - The Z coordinate
    
    Returns:
    
    An array filled with the pixel values
  - getWidth
```
public final int getWidth()
```
    Returns the width of the contained images
    
    Returns:
    
    The height of the contained images
  - getHeight
```
public final int getHeight()
```
    Returns the height of the contained images
    
    Returns:
    
    The height of the contained images
  - setPixel
```
public final void setPixel(int x,
                           int y,
                           int z,
                           int pixel)
```
    Sets the selected pixel to value provided by a array
    
    Parameters:
    
    x - The X coordinate
    
    y - The Y coordinate
    
    z - The Z coordinate
    
    pixel - An array containing values for the pixel - usually RGB(A).
  - deepCopy
```
public final ImageContainer deepCopy()
```
    Returns a deep copy of the whole ImageContainer
    
    Returns:
    
    The deep copy of the ImageContainer
  - progressCopy
```
public final ImageProgressContainer progressCopy()
```
  - setData
```
public final void setData(double[][][] data)
```
    Sets the image stack to the contents of the passed three-dimensional double value array. The values are scaled to grey values between 0 and 255
    
    Parameters:
    
    data - The data array
  - calculateGradients
```
public final double[][][] calculateGradients()
```
    Calculates grey value gradients of the image container an returns a result array.
    
    Returns:
    
    The result array
  - applyFilter
```
public final void applyFilter(Filter filter)
```
    Applies the passed Filter on every image in the container.
    
    Parameters:
    
    filter - The filter
  - applyFilter
```
public final void applyFilter(Filter filter,
                              int start,
                              int end)
```
    Applies the passed filter on the selected range of images
    
    Parameters:
    
    filter - The Filter
    
    start - The start index (zero based indices)
    
    end - The end index (zero based indices)
  - ij2bufferedImage
```
public final BufferedImage ij2bufferedImage(Image im)
```
  - getzScale
```
public final double getzScale()
```

Class ImageContainer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ip

title

sproc

proc_pixels

width

stack_size

isStack

lproc

Constructor Detail

ImageContainer

ImageContainer

ImageContainer

Method Detail

createImagePlus

updateImagePlus

getImageCount

getPixel

getWidth

getHeight

setPixel

deepCopy

progressCopy

setData

calculateGradients

applyFilter

applyFilter

ij2bufferedImage

getzScale