Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

NeuralRegion Class Reference

Base class encompassing both retinal and cortical regions organized as a 2D matrix. More...

#include <neuralregion.h>

Inheritance diagram for NeuralRegion

Inheritance graph

[legend]
Collaboration diagram for NeuralRegion:

Collaboration graph

[legend]
List of all members.

Public Types

typedef double Activity
 Type to use for an activity level. More...

typedef double Length
 Type to use for distances across the surface of the matrix in any direction. More...

typedef MatrixType<Activityrectangular ActivityMatrix
 Matrix for activity. More...

typedef ActivityMatrix::size_type Subscript
 A single index for a matrix. More...

typedef pair<Subscript,SubscriptSubscriptPair
 Coordinate of a specific unit in a matrix or the size of a matrix. More...


Public Methods

 NeuralRegion (string name_i, Subscript height, Subscript width)
 NeuralRegion (const NeuralRegion& other)
virtual ~NeuralRegion ()
virtual void activate (bool learn=false, bool settle=true) = 0
 Activate the map given the current inputs. More...

const string& name () const
 Returns the declared name of this region. More...

Low-level interface -- avoid if possible
virtual Activity activity (Subscript i, Subscript j) const
 Returns the current activity for the specified unit. More...

virtual const ActivityMatrixconst_activity () const
 Returns a const matrix of the current activity values. More...


Protected Attributes

ActivityMatrix output
 Matrix of current activity values to be propagated to other layers. More...


Detailed Description

Base class encompassing both retinal and cortical regions organized as a 2D matrix.

Definition at line 20 of file neuralregion.h.


Member Typedef Documentation

typedef double NeuralRegion::Activity
 

Type to use for an activity level.

Definition at line 23 of file neuralregion.h.

typedef MatrixType<Activity>::rectangular NeuralRegion::ActivityMatrix
 

Matrix for activity.

Currently this is only available read-only so that a derived class can use some other representation internally as long as this representation is available for other regions to see.

Definition at line 33 of file neuralregion.h.

typedef double NeuralRegion::Length
 

Type to use for distances across the surface of the matrix in any direction.

Definition at line 25 of file neuralregion.h.

Referenced by FixedWtRegion::input_dimensions().

typedef ActivityMatrix::size_type NeuralRegion::Subscript
 

A single index for a matrix.

Definition at line 36 of file neuralregion.h.

Referenced by CortexMapWrapper::input_dimensions(), InputVectorWrapper::input_dimensions(), and FixedWtRegion::input_dimensions().

typedef pair<Subscript,Subscript> NeuralRegion::SubscriptPair
 

Coordinate of a specific unit in a matrix or the size of a matrix.

Definition at line 39 of file neuralregion.h.


Constructor & Destructor Documentation

NeuralRegion::NeuralRegion ( string name_i,
Subscript height,
Subscript width )
 

Definition at line 51 of file neuralregion.h.

NeuralRegion::NeuralRegion ( const NeuralRegion & other )
 

Parameters:
other   Copy constructor

Definition at line 54 of file neuralregion.h.

NeuralRegion::~NeuralRegion ( ) [inline, virtual]
 

Definition at line 57 of file neuralregion.h.


Member Function Documentation

void NeuralRegion::activate ( bool learn = false,
bool settle = true ) [pure virtual]
 

Activate the map given the current inputs.

Must be implemented by derived classes.

Reimplemented in FixedWtRegion, InputVectorWrapper, CortexMapWrapper, and Retina.

Activity NeuralRegion::activity ( Subscript i,
Subscript j ) const [inline, virtual]
 

Returns the current activity for the specified unit.

Reimplemented in InputVectorWrapper.

Definition at line 67 of file neuralregion.h.

const ActivityMatrix & NeuralRegion::const_activity ( ) const [inline, virtual]
 

Returns a const matrix of the current activity values.

Reimplemented in InputVectorWrapper.

Definition at line 69 of file neuralregion.h.

const string & NeuralRegion::name ( ) const [inline]
 

Returns the declared name of this region.

Definition at line 75 of file neuralregion.h.


Member Data Documentation

ActivityMatrix NeuralRegion::output [protected]
 

Matrix of current activity values to be propagated to other layers.

Definition at line 82 of file neuralregion.h.


The documentation for this class was generated from the following file:
Generated at Mon Aug 21 00:31:20 2000 for RF-LISSOM by doxygen1.2.1 written by Dimitri van Heesch, © 1997-2000