org.simbrain.world.visionworld

Interface PixelMatrix

All Known Implementing Classes:

BufferedImagePixelMatrix, ScreenCapturePixelMatrix

public interface PixelMatrix

Two-dimensional matrix of pixel data.

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	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.

Method Detail

getHeight

int getHeight()

Return the height of this pixel matrix.

Returns:

the height of this pixel matrix

getWidth

int getWidth()

Return the width of this pixel matrix.

Returns:

the width of this pixel matrix

getImage

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.

Returns:

an image for this pixel matrix

getPixel

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

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

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

Throws:

java.lang.ArrayIndexOutOfBoundsException - if either of the specified coordinates are outside the bounds of this pixel matrix

setPixel

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).

Parameters:

x - x coordinate of the pixel to set

y - y coordinate of the pixel to set

color - color value, must not be null

Throws:

java.lang.UnsupportedOperationException - if the setPixel operation is not supported by this pixel matrix

java.lang.ArrayIndexOutOfBoundsException - if either of the specified coordinates are outside the bounds of this pixel matrix

view

java.awt.Image view(ReceptiveField receptiveField)

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

Parameters:

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

Returns:

an image for the specified receptive field

addPropertyChangeListener

void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Add the specified property change listener.

Parameters:

listener - listener to add

addPropertyChangeListener

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

Add the specified property change listener for the specified property.

Parameters:

propertyName - property name

listener - listener to add

removePropertyChangeListener

void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Remove the specified property change listener.

Parameters:

listener - listener to remove

removePropertyChangeListener

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

Remove the specified property change listener for the specified property.

Parameters:

propertyName - property name

listener - listener to remove