ImageAccess (IP-LAB Teaching Image-Processing Programming in Java)

java.lang.Object
- ImageAccess

```
public class ImageAccess
extends java.lang.Object
```
This is the prime class of the Image-Processing Laboratories. The image is always store in double. This class contains a collection of methods that facilitates the access to the pixel level. Version: September 2015
Project: IP-LAB, Teaching Image Processing Programming in Java
Contact: Daniel Sage, Biomedical Imaging Group, EPFL, Lausanne, Switzerland
Reference: Teaching Image-Processing Programming in Java, IEEE Signal Processing Magazine 20, November 2003

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImageAccess.Display` Class Display.
`static class`	`ImageAccess.RGB` Class RGB.
`static class`	`ImageAccess.Stack` Class Stack.

Field Summary

Fields
Modifier and Type Field and Description

int nx
Horizontal size of the image.

int ny
Vertical size of the image.

double[] pixels
Array of pixels in double stored row by rows.

Fields
Modifier and Type	Field and Description
`int`	`nx` Horizontal size of the image.
`int`	`ny` Vertical size of the image.
`double[]`	`pixels` Array of pixels in double stored row by rows.

Constructor Summary

Constructors
Constructor and Description
`ImageAccess()` Create an ImageAccess object from the current selected ImagePlus.
`ImageAccess(ColorProcessor cp, int colorPlane)` Create a new ImageAccess object from the specified ColorProcessor.
`ImageAccess(ImagePlus imp)` Create an ImageAccess object from the specified ImagePlus.
`ImageAccess(ImageProcessor ip)` Create an ImageAccess object from the specified ImageProcessor.
`ImageAccess(int nx, int ny)` Create an ImageAccess of size [nx, ny].
`ImageAccess(int nx, int ny, double[] array)` Create an ImageAccess object from a 1D double array of pixels.
`ImageAccess(java.lang.String name)` Create am ImageAccess object from ImagePlus specified by its name.
`ImageAccess(java.lang.String path, java.lang.String filename)` Create an ImageAccess object from a file.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(double constant)` Add a constant to each pixel of this image.
`void`	`add(ImageAccess a)` Add a ImageAccess object to this ImageAccess (pixelwise mode).
`ByteProcessor`	`createByteProcessor()` Create a ByteProcessor from the pixel data.
`FloatProcessor`	`createFloatProcessor()` Create a FloatProcessor from the pixel data.
`void`	`divide(double constant)` Divide a constant value to each pixel of this image.
`void`	`divide(ImageAccess a)` Divide this image by by an ImageAccess object (pixelwise mode).
`ImageAccess`	`duplicate()` Duplicate the current image.
`double[][]`	`getArrayPixels()` Return a copy of the pixel data organized in a 2D array.
`double[]`	`getColumn(int x)` Get a whole column of this image.
`int`	`getHeight()` Return the height of the image.
`double`	`getInterpolatedPixel(double x, double y)` Get the gray level of a selected pixel using a bilinear interpolation.
`double`	`getMaximum()` Return the maximum value of ImageAccess.
`double`	`getMean()` Return the mean value of ImageAccess.
`double`	`getMinimum()` Return the minimum value of ImageAccess.
`double[][]`	`getNeighborhood(int x, int y, int mx, int my)` Return a neighborhood around a pixel position.
`double`	`getPixel(int x, int y)` Get the gray level of a selected pixel.
`double[]`	`getPixels()` Return a reference to the pixel data in double (1D).
`double[]`	`getRow(int y)` Get a whole row of this image.
`ImageAccess`	`getSubImage(int x, int y, int mx, int my)` Return a sub-image from this image.
`java.lang.String`	`getTitle()` Return the title of the image.
`int`	`getWidth()` Return the width of the image.
`void`	`multiply(double constant)` Multiply a constant to each pixel of this image.
`void`	`multiply(ImageAccess a)` Multiply a ImageAccess object to this ImageAccess (pixelwise mode).
`void`	`pow(double a)` Raised an ImageAccess object to the power a.
`void`	`putArrayPixels(double[][] array)` Put an 2D array into this image.
`void`	`putColumn(int x, double[] column)` Put a whole column in a specified position into this image.
`void`	`putPixel(int x, int y, double value)` Put a pixel value to a specified position.
`void`	`putRow(int y, double[] row)` Put a whole row in a specified position into this image.
`void`	`putSubImage(int x, int y, ImageAccess subimage)` Put a sub-image with the upper left corner in the coordinate (x,y).
`void`	`setConstant(double constant)` Set a constant value to all pixels of this image.
`void`	`setTitle(java.lang.String title)` Set the title of the image
`ImageAccess.Display`	`show()` Show an image (ImageAccess object).
`ImageAccess.Display`	`show(java.lang.String title)` Show an image (ImageAccess object) and set the title.
`void`	`sqrt()` Compute the square root of an ImageAccess.
`void`	`subtract(double constant)` Subtract a constant to each pixels of this image.
`void`	`subtract(ImageAccess a)` Subtract a ImageAccess object to this ImageAccess (pixelwise mode).

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

- Field Detail
  - pixels
```
public double[] pixels
```
    Array of pixels in double stored row by rows.
  - nx
```
public int nx
```
    Horizontal size of the image.
  - ny
```
public int ny
```
    Vertical size of the image.
- Constructor Detail
  - ImageAccess
```
public ImageAccess()
```
    Create an ImageAccess object from the current selected ImagePlus.
  - ImageAccess
```
public ImageAccess(java.lang.String name)
```
    Create am ImageAccess object from ImagePlus specified by its name.
    
    Parameters:
    
    name - Name of the ImagePlus object.
  - ImageAccess
```
public ImageAccess(java.lang.String path,
                   java.lang.String filename)
```
    Create an ImageAccess object from a file.
    
    Parameters:
    
    path - Path of the file
    
    filename - Name of the file
  - ImageAccess
```
public ImageAccess(ImagePlus imp)
```
    Create an ImageAccess object from the specified ImagePlus.
    
    Parameters:
    
    imp - ImagePlus object
  - ImageAccess
```
public ImageAccess(ImageProcessor ip)
```
    Create an ImageAccess object from the specified ImageProcessor.
    
    Parameters:
    
    ip - ImageProcessor object
  - ImageAccess
```
public ImageAccess(int nx,
                   int ny,
                   double[] array)
```
    Create an ImageAccess object from a 1D double array of pixels. The size of the array should be compatible with the requested size.
    
    Parameters:
    
    nx - Horizontal size of the image along the X-axis
    
    ny - Vertical size of the image along the Y-axis
    
    array - Array of pixel (1D) of size nx * ny
  - ImageAccess
```
public ImageAccess(int nx,
                   int ny)
```
    Create an ImageAccess of size [nx, ny].
    
    Parameters:
    
    nx - Horizontal size of the image along the X-axis
    
    ny - Vertical size of the image along the Y-axis
  - ImageAccess
```
public ImageAccess(ColorProcessor cp,
                   int colorPlane)
```
    Create a new ImageAccess object from the specified ColorProcessor.
    
    Parameters:
    
    cp - ColorProcessor object
    
    colorPlane - Index of the color plane 0 (red), 1 (green) or 2 (blue)
- Method Detail
  - getTitle
```
public java.lang.String getTitle()
```
    Return the title of the image.
    
    Returns:
    
    Title of the image
  - getWidth
```
public int getWidth()
```
    Return the width of the image.
    
    Returns:
    
    Image width
  - getHeight
```
public int getHeight()
```
    Return the height of the image.
    
    Returns:
    
    Image height
  - getMaximum
```
public double getMaximum()
```
    Return the maximum value of ImageAccess.
    
    Returns:
    
    Maximum value
  - getMinimum
```
public double getMinimum()
```
    Return the minimum value of ImageAccess.
    
    Returns:
    
    Minimum value
  - getMean
```
public double getMean()
```
    Return the mean value of ImageAccess.
    
    Returns:
    
    the mean value
  - getArrayPixels
```
public double[][] getArrayPixels()
```
    Return a copy of the pixel data organized in a 2D array.
    
    Returns:
    
    2D double array representing the image
  - getPixels
```
public double[] getPixels()
```
    Return a reference to the pixel data in double (1D).
    
    Returns:
    
    1D double array
  - createFloatProcessor
```
public FloatProcessor createFloatProcessor()
```
    Create a FloatProcessor from the pixel data. The double values of the pixel are simply casted in float.
    
    Returns:
    
    FloatProcessor object
  - createByteProcessor
```
public ByteProcessor createByteProcessor()
```
    Create a ByteProcessor from the pixel data. The double values of the pixel are clipped in the [0..255] range.
    
    Returns:
    
    ByteProcessor object
  - duplicate
```
public ImageAccess duplicate()
```
    Duplicate the current image.
    
    Returns:
    
    New ImageAccess object
  - getPixel
```
public double getPixel(int x,
                       int y)
```
    Get the gray level of a selected pixel. Mirror border conditions are applied.
    
    Parameters:
    
    x - X-coordinate of a pixel
    
    y - Y-coordinate of a pixel
    
    Returns:
    
    Gray level of the pixel (double)
  - getInterpolatedPixel
```
public double getInterpolatedPixel(double x,
                                   double y)
```
    Get the gray level of a selected pixel using a bilinear interpolation. The coordinates can be given in double and the bilinear interpolation is applied the find the gray level. Mirror border conditions are applied.
    
    Parameters:
    
    x - X-coordinate of a pixel
    
    y - Y-coordinate of a pixel
    
    Returns:
    
    Gray level of the pixel (double)
  - getColumn
```
public double[] getColumn(int x)
```
    Get a whole column of this image.
    
    Parameters:
    
    x - X-coordinate of a pixel
    
    Returns:
    
    Column as double array
  - getRow
```
public double[] getRow(int y)
```
    Get a whole row of this image.
    
    Parameters:
    
    y - Y-coordinate of a pixel
    
    Returns:
    
    Row as a double array
  - getNeighborhood
```
public double[][] getNeighborhood(int x,
                                  int y,
                                  int mx,
                                  int my)
```
    Return a neighborhood around a pixel position.
    Mirror border conditions are applied.
    
    The pixel value of (x-n/2, y-n/2) is put into neigh[0][0]
    ...
    The pixel value of (x+n/2, y+n/2) is put into neigh[n-1][n-1]
    
    For example if neigh is a double[4][4]:
    The pixel value of (x-1, y-1) is put into neigh[0][0]
    The pixel value of (x , y ) is put into neigh[1][1]
    The pixel value of (x, y+1) is put into neigh[1][2]
    The pixel value of (x+1, y-2) is put into neigh[2][0]
    ...
    For example if neigh is a double[5][5]:
    The pixel value of (x-2, y-2) is put into neigh[0][0]
    The pixel value of (x-1, y-1) is put into neigh[1][1]
    The pixel value of (x , y ) is put into neigh[2][2]
    The pixel value of (x, y+1) is put into neigh[2][3]
    The pixel value of (x+2, y-2) is put into neigh[4][0]
    
    Parameters:
    
    x - X-coordinate of a pixel
    
    y - Y-coordinate of a pixel
    
    Returns:
    
    Neighborhood, a 2D double array
  - getSubImage
```
public ImageAccess getSubImage(int x,
                               int y,
                               int mx,
                               int my)
```
    Return a sub-image from this image.
    
    Parameters:
    
    x - X-coordinate of a pixel
    
    y - Y-coordinate of a pixel
    
    mx - Horizontal size of sub-image
    
    my - Vertical size of sub-image
    
    Returns:
    
    Sub-image
  - putPixel
```
public void putPixel(int x,
                     int y,
                     double value)
```
    Put a pixel value to a specified position.
    
    Parameters:
    
    x - X-coordinate of a pixel
    
    y - Y-coordinate of a pixel
    
    value - Value of the gray level
  - putColumn
```
public void putColumn(int x,
                      double[] column)
```
    Put a whole column in a specified position into this image.
    
    Parameters:
    
    x - X-coordinate of a pixel
    
    column - 1D array of the type double
  - putRow
```
public void putRow(int y,
                   double[] row)
```
    Put a whole row in a specified position into this image.
    
    Parameters:
    
    y - Y-coordinate of a pixel
    
    row - 1D Array of the type double
  - putArrayPixels
```
public void putArrayPixels(double[][] array)
```
    Put an 2D array into this image.
    
    Parameters:
    
    array - Double array to out into this image
  - putSubImage
```
public void putSubImage(int x,
                        int y,
                        ImageAccess subimage)
```
    Put a sub-image with the upper left corner in the coordinate (x,y). The sub-image input should be already created.
    
    Parameters:
    
    x - X-coordinate of a pixel
    
    y - Y-coordinate of a pixel
    
    subimage - ImageAccess object to insert into this image
  - setConstant
```
public void setConstant(double constant)
```
    Set a constant value to all pixels of this image.
    
    Parameters:
    
    constant - Constant value
  - setTitle
```
public void setTitle(java.lang.String title)
```
    Set the title of the image
    
    Parameters:
    
    title - Title of the image
  - sqrt
```
public void sqrt()
```
    Compute the square root of an ImageAccess.
  - pow
```
public void pow(double a)
```
    Raised an ImageAccess object to the power a.
    
    Parameters:
    
    a - Power value
  - add
```
public void add(double constant)
```
    Add a constant to each pixel of this image.
    
    Parameters:
    
    constant - Constant value to be added
  - multiply
```
public void multiply(double constant)
```
    Multiply a constant to each pixel of this image.
    
    Parameters:
    
    constant - Constant value to be multiplied
  - subtract
```
public void subtract(double constant)
```
    Subtract a constant to each pixels of this image.
    
    Parameters:
    
    constant - Constant to be subtracted
  - divide
```
public void divide(double constant)
```
    Divide a constant value to each pixel of this image.
    
    Parameters:
    
    constant - Constant to be divided
  - add
```
public void add(ImageAccess a)
```
    Add a ImageAccess object to this ImageAccess (pixelwise mode).
    
    Parameters:
    
    a - Image to add
  - subtract
```
public void subtract(ImageAccess a)
```
    Subtract a ImageAccess object to this ImageAccess (pixelwise mode).
    
    Parameters:
    
    a - Image to subtract
  - multiply
```
public void multiply(ImageAccess a)
```
    Multiply a ImageAccess object to this ImageAccess (pixelwise mode).
    
    Parameters:
    
    a - Image to multiply
  - divide
```
public void divide(ImageAccess a)
```
    Divide this image by by an ImageAccess object (pixelwise mode).
    
    Parameters:
    
    a - Dividend image
  - show
```
public ImageAccess.Display show()
```
    Show an image (ImageAccess object).
    
    Returns:
    
    Display object
  - show
```
public ImageAccess.Display show(java.lang.String title)
```
    Show an image (ImageAccess object) and set the title.
    
    Parameters:
    
    title - Title of the window image
    
    Returns:
    
    Display object

Class ImageAccess

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

pixels

nx

ny

Constructor Detail

ImageAccess

ImageAccess

ImageAccess

ImageAccess

ImageAccess

ImageAccess

ImageAccess

ImageAccess

Method Detail

getTitle

getWidth

getHeight

getMaximum

getMinimum

getMean

getArrayPixels

getPixels

createFloatProcessor

createByteProcessor

duplicate

getPixel

getInterpolatedPixel

getColumn

getRow

getNeighborhood

getSubImage

putPixel

putColumn

putRow

putArrayPixels

putSubImage

setConstant

setTitle

sqrt

pow

add

multiply

subtract

divide

add

subtract

multiply

divide

show

show