org.simbrain.world.visionworld

Interface SensorMatrix

All Known Implementing Classes:

AbstractSensorMatrix, DenseSensorMatrix, SparseSensorMatrix

public interface SensorMatrix

Two-dimensional matrix of sensors with uniformly sized receptive fields.

Method Summary

Modifier and Type	Method and Description
int	columns() Return the number of columns of this sensor matrix.
Filter	getDefaultFilter() Return the default filter for the sensors in this sensor matrix, if any.
int	getReceptiveFieldHeight() Return the receptive field height for sensors in this sensor matrix.
int	getReceptiveFieldWidth() Return the receptive field width for sensors in this sensor matrix.
Sensor	getSensor(int row, int column) Return the sensor in this sensor matrix at the specified row and column, if any.
int	rows() Return the number of rows of this sensor matrix.

Method Detail

rows

int rows()

Return the number of rows of this sensor matrix. The number of rows will be at least one.

Returns:

the number of rows of this sensor matrix

columns

int columns()

Return the number of columns of this sensor matrix. The number of columns will be at least one.

Returns:

the number of columns of this sensor matrix

getReceptiveFieldHeight

int getReceptiveFieldHeight()

Return the receptive field height for sensors in this sensor matrix. The receptive field height will be at least zero.

Returns:

the receptive field height for sensors in this sensor matrix

getReceptiveFieldWidth

int getReceptiveFieldWidth()

Return the receptive field width for sensors in this sensor matrix. The receptive field width will be at least zero.

Returns:

the receptive field width for sensors in this sensor matrix

getDefaultFilter

Filter getDefaultFilter()

Return the default filter for the sensors in this sensor matrix, if any.

Returns:

the default filter for the sensors in this sensor matrix or null if one has not been defined

getSensor

Sensor getSensor(int row,
                 int column)

Return the sensor in this sensor matrix at the specified row and column, if any.

Parameters:

row - row, must be >= 0 and < rows()

column - column, must be >= 0 and < columns()

Returns:

the sensor in this sensor matrix at the specified row and column, if any

Throws:

java.lang.IndexOutOfBoundsException - if row is less than zero or greater than or equal to rows(), or if column is less than zero or greater than or equal to columns()