ContourNeuronProp< CH, X, Y > Class Template Reference

Holds the property for each neuron. More...

#include <CINNIC/contourNeuronProp.H>

List of all members.

Public Member Functions

 ContourNeuronProp ()
CH & getCharge ()
 return this neurons charge
CH & getThreshold ()
 return this neurons threshold
CH & getSupressionMod ()
 return this neurons supression modifier
void setSupressionMod (CH &sup)
 set up supression for this neuron
void setSupressionBool ()
 set holder to know if supression has been incremented
void setSupressionThresh (CH &thresh, CH &changeVal, CH &max)
 set up supression threshold for this neuron and its weight augementation
void ResetTempCharge ()
 reset the "temporary" charges of this neuron
void ResetCharge ()
 reset base charge
void ResetChargeAll ()
 reset all charges
void setUpperLimit ()
 set neuron potential to upper limit
void Charge (CH &_charge, bool _pol, bool _sender)
 input a charge to this neuron, give your polarity so it can be sent on properly
void ChargeSimple (CH &_charge)
 input a charge to this neuron (potential) without polarity
CH & DisCharge (bool _pol, bool _sender, int a, int cascadeType)
 output a charge, make sure it goes to the correct polarity
void setThreshold (CH &Threshold, CH &Resistance)
 Tell the neuron its saturation level.

Protected Attributes

float threshold
 Current threshold for this neuron.

Detailed Description

template<class CH, class X, class Y>
class ContourNeuronProp< CH, X, Y >

Holds the property for each neuron.

this class is used to process and hold the membrane potential of each neuron. It keeps track of total potential as well as potential that is "up" or "down" that is, to simulate the effects of tranfering energy from neuron to another neuron it holds energy in either a positive or negative energy bank.

Definition at line 57 of file contourNeuronProp.H.


Constructor & Destructor Documentation

template<class CH , class X , class Y >
ContourNeuronProp< CH, X, Y >::ContourNeuronProp (  )  [inline]

This method when called will place a charge in this neuron telling it where the charge came from and the polarity properties of the placing neuron

Definition at line 58 of file contourNeuronProp.C.


Member Function Documentation

template<class CH, class X , class Y >
void ContourNeuronProp< CH, X, Y >::Charge ( CH &  _charge,
bool  _pol,
bool  _sender 
) [inline]

input a charge to this neuron, give your polarity so it can be sent on properly

Parameters:
charge The charge to give this neuron
_pol the polarity you have
_sender Is true if you are a sender of cascade

Definition at line 106 of file contourNeuronProp.C.

template<class CH, class X , class Y >
void ContourNeuronProp< CH, X, Y >::ChargeSimple ( CH &  _charge  )  [inline]

input a charge to this neuron (potential) without polarity

Parameters:
charge The charge to give this neuron

Definition at line 128 of file contourNeuronProp.C.

template<class CH , class X , class Y >
CH & ContourNeuronProp< CH, X, Y >::DisCharge ( bool  _pol,
bool  _sender,
int  a,
int  cascadeType 
) [inline]

output a charge, make sure it goes to the correct polarity

Parameters:
_pol Your polarity
_sender Are you a sender?

This method when called will return all the charges that should go to a another neuron from this neuron given the other neurons polarity

Definition at line 137 of file contourNeuronProp.C.

template<class CH , class X , class Y >
CH & ContourNeuronProp< CH, X, Y >::getCharge (  )  [inline]

return this neurons charge

Definition at line 68 of file contourNeuronProp.C.

template<class CH , class X , class Y >
CH & ContourNeuronProp< CH, X, Y >::getSupressionMod (  )  [inline]

return this neurons supression modifier

Definition at line 80 of file contourNeuronProp.C.

template<class CH , class X , class Y >
CH & ContourNeuronProp< CH, X, Y >::getThreshold (  )  [inline]

return this neurons threshold

Definition at line 74 of file contourNeuronProp.C.

References ContourNeuronProp< CH, X, Y >::threshold.

template<class CH , class X , class Y >
void ContourNeuronProp< CH, X, Y >::ResetCharge (  )  [inline]

reset base charge

Definition at line 185 of file contourNeuronProp.C.

template<class CH , class X , class Y >
void ContourNeuronProp< CH, X, Y >::ResetChargeAll (  )  [inline]

reset all charges

Definition at line 191 of file contourNeuronProp.C.

template<class CH , class X , class Y >
void ContourNeuronProp< CH, X, Y >::ResetTempCharge (  )  [inline]

reset the "temporary" charges of this neuron

This method resets the place counter for the charge storage vector in effect putting its charge to 0;

Definition at line 178 of file contourNeuronProp.C.

template<class CH , class X , class Y >
void ContourNeuronProp< CH, X, Y >::setSupressionBool (  )  [inline]

set holder to know if supression has been incremented

Definition at line 92 of file contourNeuronProp.C.

template<class CH, class X , class Y >
void ContourNeuronProp< CH, X, Y >::setSupressionMod ( CH &  sup  )  [inline]

set up supression for this neuron

Definition at line 86 of file contourNeuronProp.C.

template<class CH, class X , class Y >
void ContourNeuronProp< CH, X, Y >::setSupressionThresh ( CH &  thresh,
CH &  changeVal,
CH &  max 
) [inline]

set up supression threshold for this neuron and its weight augementation

This method is used to set up adaptive supression for its threshold and the amount supression will increase every time threshold is reached

Parameters:
thresh This is the threshold number
changeVal The amount supression should be increased

Definition at line 98 of file contourNeuronProp.C.

template<class CH, class X , class Y >
void ContourNeuronProp< CH, X, Y >::setThreshold ( CH &  Threshold,
CH &  Resistance 
) [inline]

Tell the neuron its saturation level.

this method stores the neurons fireing threshold at which point it fires a salience charge

Definition at line 168 of file contourNeuronProp.C.

References ContourNeuronProp< CH, X, Y >::threshold.

template<class CH , class X , class Y >
void ContourNeuronProp< CH, X, Y >::setUpperLimit (  )  [inline]

set neuron potential to upper limit

Definition at line 199 of file contourNeuronProp.C.


Member Data Documentation

template<class CH, class X, class Y>
float ContourNeuronProp< CH, X, Y >::threshold [protected]

Current threshold for this neuron.

Definition at line 74 of file contourNeuronProp.H.

Referenced by ContourNeuronProp< CH, X, Y >::getThreshold(), and ContourNeuronProp< CH, X, Y >::setThreshold().


The documentation for this class was generated from the following files:
Generated on Sun May 8 08:43:18 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3