org.simbrain.world.visionworld.pixelmatrix

Class BufferedImagePixelMatrix

java.lang.Object

org.simbrain.world.visionworld.pixelmatrix.BufferedImagePixelMatrix

All Implemented Interfaces:

PixelMatrix

public final class BufferedImagePixelMatrix
extends java.lang.Object
implements PixelMatrix

BufferedImage pixel matrix.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_HEIGHT Default height.
static int	DEFAULT_WIDTH Default width.

Constructor Summary

Constructors

Constructor and Description
BufferedImagePixelMatrix() Create a new BufferedImage pixel matrix with an empty image the default dimensions.
BufferedImagePixelMatrix(java.awt.image.BufferedImage image) Create a new BufferedImage pixel matrix with the specified image.
BufferedImagePixelMatrix(int width, int height) Create a new BufferedImage pixel matrix with an empty image the specified dimensions.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Add the specified property change listener.
void	addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener) Add the specified property change listener for the specified property.
int	getHeight() Return the height of this pixel matrix.
java.awt.Image	getImage() Return an image for this pixel matrix, scaled to dimensions getWidth() x getHeight() if necessary.
java.awt.Color	getPixel(int x, int y) Return the color of the pixel at the specified (x, y) coordinates.
int	getWidth() Return the width of this pixel matrix.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Remove the specified property change listener.
void	removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener) Remove the specified property change listener for the specified property.
void	setImage(java.awt.image.BufferedImage image) Set the image for this pixel matrix to image.
void	setPixel(int x, int y, java.awt.Color color) Set the pixel at the specified (x, y) coordinates to the RGB and alpha values in the specified color (optional operation).
java.awt.Image	view(ReceptiveField receptiveField) View this pixel matrix, returning an image for the specified receptive field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_HEIGHT

public static final int DEFAULT_HEIGHT

Default height.

See Also:

Constant Field Values

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

Default width.

See Also:

Constant Field Values

Constructor Detail

BufferedImagePixelMatrix

public BufferedImagePixelMatrix()

Create a new BufferedImage pixel matrix with an empty image the default dimensions.

See Also:

DEFAULT_HEIGHT, DEFAULT_WIDTH

BufferedImagePixelMatrix

public BufferedImagePixelMatrix(int width,
                                int height)

Create a new BufferedImage pixel matrix with an empty image the specified dimensions.

Parameters:

width - width in pixels, must be > 0

height - height in pixels, must be > 0

BufferedImagePixelMatrix

public BufferedImagePixelMatrix(java.awt.image.BufferedImage image)

Create a new BufferedImage pixel matrix with the specified image.

Parameters:

image - image for this pixel matrix, must not be null

Method Detail

getHeight

public int getHeight()

Return the height of this pixel matrix.

Specified by:

getHeight in interface PixelMatrix

Returns:

the height of this pixel matrix

getWidth

public int getWidth()

Return the width of this pixel matrix.

Specified by:

getWidth in interface PixelMatrix

Returns:

the width of this pixel matrix

getImage

public java.awt.Image getImage()

Return an image for this pixel matrix, scaled to dimensions getWidth() x getHeight() if necessary. The image will not be null.

Specified by:

getImage in interface PixelMatrix

Returns:

an image for this pixel matrix

setImage

public void setImage(java.awt.image.BufferedImage image)

Set the image for this pixel matrix to image.

This is a bound property.

Parameters:

image - image for this pixel matrix, must not be null

getPixel

public java.awt.Color getPixel(int x,
                               int y)

Return the color of the pixel at the specified (x, y) coordinates.

Specified by:

getPixel in interface PixelMatrix

Parameters:

x - x coordinate of the pixel

y - y coordinate of the pixel

Returns:

the color of the pixel at the specified (x, y) coordinates

setPixel

public void setPixel(int x,
                     int y,
                     java.awt.Color color)

Set the pixel at the specified (x, y) coordinates to the RGB and alpha values in the specified color (optional operation).

Specified by:

setPixel in interface PixelMatrix

Parameters:

x - x coordinate of the pixel to set

y - y coordinate of the pixel to set

color - color value, must not be null

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Add the specified property change listener.

Specified by:

addPropertyChangeListener in interface PixelMatrix

Parameters:

listener - listener to add

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)

Add the specified property change listener for the specified property.

Specified by:

addPropertyChangeListener in interface PixelMatrix

Parameters:

propertyName - property name

listener - listener to add

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Remove the specified property change listener.

Specified by:

removePropertyChangeListener in interface PixelMatrix

Parameters:

listener - listener to remove

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)

Remove the specified property change listener for the specified property.

Specified by:

removePropertyChangeListener in interface PixelMatrix

Parameters:

propertyName - property name

listener - listener to remove

view

public java.awt.Image view(ReceptiveField receptiveField)

View this pixel matrix, returning an image for the specified receptive field. The image will not be null.

Specified by:

view in interface PixelMatrix

Parameters:

receptiveField - receptive field through which to view this pixel matrix, must not be null

Returns:

an image for the specified receptive field