org.simbrain.network.layouts

Class GridLayout

java.lang.Object

org.simbrain.network.layouts.GridLayout

All Implemented Interfaces:

Layout

public class GridLayout
extends java.lang.Object
implements Layout

Lay neurons out in a grid.

Author:

Jeff Yoshimi

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_H_SPACING The default horizontal spacing.
static boolean	DEFAULT_MANUAL_COLS The default allowed state for manual cols.
static int	DEFAULT_NUM_COLUMNS The default number of columns if manual columns are allowed.
static double	DEFAULT_V_SPACING The default vertical spacing.

Constructor Summary

Constructors

Constructor and Description
GridLayout() Default constructor.
GridLayout(double hSpacing, double vSpacing) Create a grid layout that automatically produces a square grid based on number of neurons.
GridLayout(double hSpacing, double vSpacing, int numColumns) Create a grid layout with a specific number of columns.

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.util.List<Neuron>>	getColumnList(java.util.List<Neuron> neurons, int numRows) Returns a list of columns corresponding to a set of neurons assumed to be in the form of a grid.
java.lang.String	getDescription()
double	getHSpacing()
int	getNumColumns()
double	getVSpacing()
boolean	isManualColumns()
void	layoutNeurons(java.util.List<Neuron> neurons) Layout a list of neurons.
void	setHSpacing(double spacing)
void	setInitialLocation(java.awt.geom.Point2D initialPoint) Set the initial position.
void	setManualColumns(boolean manualColumns)
void	setNumColumns(int numColumns)
void	setVSpacing(double spacing)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NUM_COLUMNS

public static final int DEFAULT_NUM_COLUMNS

The default number of columns if manual columns are allowed.

See Also:

Constant Field Values

DEFAULT_H_SPACING

public static final double DEFAULT_H_SPACING

The default horizontal spacing.

See Also:

Constant Field Values

DEFAULT_V_SPACING

public static final double DEFAULT_V_SPACING

The default vertical spacing.

See Also:

Constant Field Values

DEFAULT_MANUAL_COLS

public static final boolean DEFAULT_MANUAL_COLS

The default allowed state for manual cols.

See Also:

Constant Field Values

Constructor Detail

GridLayout

public GridLayout(double hSpacing,
                  double vSpacing,
                  int numColumns)

Create a grid layout with a specific number of columns.

Parameters:

hSpacing - horizontal spacing between neurons

vSpacing - vertical spacing between neurons

numColumns - number of columns of neurons

GridLayout

public GridLayout(double hSpacing,
                  double vSpacing)

Create a grid layout that automatically produces a square grid based on number of neurons.

Parameters:

hSpacing - horizontal spacing between neurons

vSpacing - vertical spacing between neurons

GridLayout

public GridLayout()

Default constructor.

Method Detail

layoutNeurons

public void layoutNeurons(java.util.List<Neuron> neurons)

Layout a list of neurons.

Specified by:

layoutNeurons in interface Layout

Parameters:

neurons - the list of neurons

getColumnList

public static java.util.List<java.util.List<Neuron>> getColumnList(java.util.List<Neuron> neurons,
                                                                   int numRows)

Returns a list of columns corresponding to a set of neurons assumed to be in the form of a grid. Utility method currently used in scripts. TODO: Possibly move this method to a utility class for determining the locations of neurons and other network elements.

Parameters:

neurons - the list of neurons

numRows - the number of rows in the grid

Returns:

the list of columns, ordered by x-direction

setInitialLocation

public void setInitialLocation(java.awt.geom.Point2D initialPoint)

Description copied from interface: Layout

Set the initial position.

Specified by:

setInitialLocation in interface Layout

Parameters:

initialPoint - initial position

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Layout

Returns:

the name of this layout type

getNumColumns

public int getNumColumns()

Returns:

the numColumns

setNumColumns

public void setNumColumns(int numColumns)

Parameters:

numColumns - the numColumns to set

getHSpacing

public double getHSpacing()

Returns:

the hSpacing

setHSpacing

public void setHSpacing(double spacing)

Parameters:

spacing - the hSpacing to set

getVSpacing

public double getVSpacing()

Returns:

the vSpacing

setVSpacing

public void setVSpacing(double spacing)

Parameters:

spacing - the vSpacing to set

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isManualColumns

public boolean isManualColumns()

Returns:

the manualColumns

setManualColumns

public void setManualColumns(boolean manualColumns)

Parameters:

manualColumns - the manualColumns to set