boone.structure

Class FilterMap

java.lang.Object

boone.structure.Layer

boone.structure.Map

boone.structure.FilterMap

All Implemented Interfaces:

Storable, java.lang.Cloneable

Direct Known Subclasses:

ConvolutionMap, PoolingMap

public abstract class FilterMap
extends Map

A filter map. $Id$

Since:

November, 2022

Author:

Helmut A. Mayer

Field Summary

Fields

Modifier and Type	Field and Description
protected int	connectedFilters The number of filters currently connected to previous layer.
protected int	filterHeight The height of the filter.
protected java.util.List<Link[][]>	filters The filter bank.
protected int	filterWidth The width of the filter.
protected int	padHeight The height of padding.
protected int	padWidth The width of padding.
protected int	strideHeight The height of a stride.
protected int	strideWidth The width of a stride.

Fields inherited from class boone.structure.Map

height, link, neuron, neurons, width

Method Summary

Modifier and Type	Method and Description
protected void	attachFilter(int row, int col, Map pre, Neuron detector) Attaches the filter to the previous map.
boolean	connect(Map other) Connects this map with the given previous map using the given link type for the filter.
protected void	createFilter() Creates the filter.
int	getFilterHeight() Returns the filter height.
protected Link	getFilterLink(Neuron sink, Link link) Returns a cloned filter link.
java.util.List<Link[][]>	getFilters() Returns the filter bank.
int	getFilterWidth() Returns the filter width.
int	getPadHeight() Returns the pad height.
int	getPadWidth() Returns the pad width.
int	getStrideHeight() Returns the stride height.
int	getStrideWidth() Returns the stride width.

Methods inherited from class boone.structure.Map

clone, connect, disconnect, getDepth, getHeight, getLinkCount, getNeuron, getNeuron, getNeurons, getSize, getWidth, reset, setIOType, toString, toXML

Methods inherited from class boone.structure.Layer

addMap, addMap, fromXML, getLevel, getMapCount, getMaps, getNeuron, removeMap, setLevel

Methods inherited from class java.lang.Object

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

Field Detail

filterWidth

protected int filterWidth

The width of the filter.

filterHeight

protected int filterHeight

The height of the filter.

padWidth

protected int padWidth

The width of padding.

padHeight

protected int padHeight

The height of padding.

strideWidth

protected int strideWidth

The width of a stride.

strideHeight

protected int strideHeight

The height of a stride.

filters

protected java.util.List<Link[][]> filters

The filter bank.

connectedFilters

protected int connectedFilters

The number of filters currently connected to previous layer.

Method Detail

getFilterWidth

public int getFilterWidth()

Returns the filter width.

Returns:

the filter width

getFilterHeight

public int getFilterHeight()

Returns the filter height.

Returns:

the filter height

getPadWidth

public int getPadWidth()

Returns the pad width.

Returns:

the pad width

getPadHeight

public int getPadHeight()

Returns the pad height.

Returns:

the pad height

getStrideWidth

public int getStrideWidth()

Returns the stride width.

Returns:

the stride width

getStrideHeight

public int getStrideHeight()

Returns the stride height.

Returns:

the stride height

getFilters

public java.util.List<Link[][]> getFilters()

Returns the filter bank.

Returns:

the filter bank

connect

public boolean connect(Map other)

Connects this map with the given previous map using the given link type for the filter. If this map already has detector neurons, then the filter has been connected to one or more pre-maps, and the same detector neurons are connected to the next maps. As the pre-maps may be of different size, the size of this map is dynamically adjusted to the largest pre-map.

Specified by:

connect in class Map

Parameters:

other - another map

Returns:

true, if some connection made

attachFilter

protected void attachFilter(int row,
                            int col,
                            Map pre,
                            Neuron detector)

Attaches the filter to the previous map. The filter window is set to the given position. The filter links are connected to all corresponding pixel neurons.

Parameters:

row - the row of the top left position in the previous map (may be outside of map)

col - the column of the top left position in the previous map (may be outside of map)

pre - the previous map

detector - a detector neuron

getFilterLink

protected Link getFilterLink(Neuron sink,
                             Link link)

Returns a cloned filter link. The sink parameter may be used in subclasses.

Parameters:

sink - a detector neuron

link - a filter link

createFilter

protected void createFilter()

Creates the filter.