boone.structure

Class Layer

java.lang.Object

boone.structure.Layer

All Implemented Interfaces:

Storable

Direct Known Subclasses:

ConvolutionLayer, FeedForwardLayer, Map, PoolingLayer

public class Layer
extends java.lang.Object
implements Storable

A generic layer of a network. $Id$

Since:

October, 2021

Author:

Helmut A. Mayer

Constructor Summary

Constructors

Constructor and Description
Layer() Constructs an empty layer.

Method Summary

Modifier and Type	Method and Description
void	addMap(Map map) Adds a map to this layer.
protected void	addMap(Map map, int depth) Adds a map in depth to this layer.
boolean	connect(Layer layer) Connects this layer with the given layer.
void	disconnect() Disconnects this layer from the previous layer.
void	fromXML(org.jdom2.Element element) Reads attributes from XML tree.
int	getDepth() Returns the depth of the layer, i.e., the number of maps/channels/filters.
int	getHeight() Returns the height of the first map (channel 0).
int	getLevel() Returns the level of the layer.
int	getLinkCount() Returns the the number of links into this layer.
int	getMapCount() Returns the number of maps in this layer.
java.util.ArrayList<Map>	getMaps() Returns the maps of this layer.
protected Neuron	getNeuron(int row, int col, int chan) Returns the neuron with given coordinates.
NeuronList	getNeurons() Returns the neurons in this layer.
int	getSize() Returns the size of this layer, i.e., the number of neurons.
int	getWidth() Returns the width of the first map (channel 0).
protected Map	removeMap(int i) Removes the map with given index from this layer.
protected void	setIOType(boolean in, boolean out) Sets the layer maps' IO status.
void	setLevel(int level) Sets the level (number) of the layer.
java.lang.String	toString() Returns the maps of this layer.
org.jdom2.Element	toXML(org.jdom2.Element element) Returns an XML element containing information on the layer.

Methods inherited from class java.lang.Object

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

Constructor Detail

Layer

public Layer()

Constructs an empty layer.

Method Detail

getWidth

public int getWidth()

Returns the width of the first map (channel 0).

Returns:

the width

getHeight

public int getHeight()

Returns the height of the first map (channel 0).

Returns:

the height

getDepth

public int getDepth()

Returns the depth of the layer, i.e., the number of maps/channels/filters.

Returns:

the depth

getSize

public int getSize()

Returns the size of this layer, i.e., the number of neurons.

Returns:

the size

getLevel

public int getLevel()

Returns the level of the layer.

Returns:

the layer number

setLevel

public void setLevel(int level)

Sets the level (number) of the layer. An input layer has level 0.

Parameters:

level - the level/layer number

getNeurons

public NeuronList getNeurons()

Returns the neurons in this layer.

Returns:

the list of neurons, null, if no maps

getMaps

public java.util.ArrayList<Map> getMaps()

Returns the maps of this layer.

Returns:

the maps

addMap

public void addMap(Map map)

Adds a map to this layer. A null map is not added.

Parameters:

map - a map

addMap

protected void addMap(Map map,
                      int depth)

Adds a map in depth to this layer. The additional maps are cloned from the given map.

Parameters:

map - a map

removeMap

protected Map removeMap(int i)

Removes the map with given index from this layer.

Parameters:

i - the index

Returns:

the removed map

getMapCount

public int getMapCount()

Returns the number of maps in this layer.

Returns:

the number of maps

getLinkCount

public int getLinkCount()

Returns the the number of links into this layer.

Returns:

the number of incoming links

setIOType

protected void setIOType(boolean in,
                         boolean out)

Sets the layer maps' IO status.

Parameters:

in - true, if input layer

out - true, if output layer

getNeuron

protected Neuron getNeuron(int row,
                           int col,
                           int chan)

Returns the neuron with given coordinates.

Parameters:

row - the row of the neuron (0 to width - 1)

col - the column of the neuron (0 to height - 1)

chan - the map/channel of the neuron (0 to depth - 1)

Returns:

the neuron

connect

public boolean connect(Layer layer)

Connects this layer with the given layer.

Parameters:

layer - another layer

Returns:

true, if some connection has been made

disconnect

public void disconnect()

Disconnects this layer from the previous layer. The disconnected links are dangling and set to being not trainable.

fromXML

public void fromXML(org.jdom2.Element element)

Reads attributes from XML tree.

Specified by:

fromXML in interface Storable

Parameters:

element - a JDOM element

toXML

public org.jdom2.Element toXML(org.jdom2.Element element)

Returns an XML element containing information on the layer.

Specified by:

toXML in interface Storable

Parameters:

element - the parent element

Returns:

the layer element

toString

public java.lang.String toString()

Returns the maps of this layer.

Overrides:

toString in class java.lang.Object

Returns:

the string expression