AnimatLab  2
Test
FiringRateSim::Neurons::RandomNeuron Class Reference

Random firing rate neuron. More...

#include <RandomNeuron.h>

+ Inheritance diagram for FiringRateSim::Neurons::RandomNeuron:
+ Collaboration diagram for FiringRateSim::Neurons::RandomNeuron:

Public Member Functions

 RandomNeuron ()
 Default constructor. More...
 
virtual ~RandomNeuron ()
 Destructor. More...
 
AnimatSim::Gains::GainBurstLengthDistribution ()
 
void BurstLengthDistribution (AnimatSim::Gains::Gain *lpGain)
 Sets the burst length distribution. More...
 
void BurstLengthDistribution (std::string strXml)
 Sets the burst length distribution using an xml packet. More...
 
virtual long CalculateSnapshotByteSize ()
 Calculates the snapshot byte size. More...
 
virtual void Copy (CStdSerialize *lpSource)
 
AnimatSim::Gains::GainCurrentDistribution ()
 
void CurrentDistribution (AnimatSim::Gains::Gain *lpGain)
 Sets the current distribution. More...
 
void CurrentDistribution (std::string strXml)
 Sets the current distribution using an xml packet. More...
 
float Il ()
 Gets the low current. More...
 
void Il (float fltVal)
 Sets the low current. More...
 
float Ilinit ()
 Gets the low current init value. More...
 
void Ilinit (float fltVal)
 Sets the low current init value. More...
 
AnimatSim::Gains::GainInterbusrtLengthDistribution ()
 
void InterbusrtLengthDistribution (AnimatSim::Gains::Gain *lpGain)
 Sets the interbusrt length distribution. More...
 
void InterbusrtLengthDistribution (std::string strXml)
 Sets the interbusrt length distribution using an xml packet. More...
 
float IntrinsicCurrent ()
 Gets the active intrinsic current. More...
 
void IntrinsicCurrent (float fltVal)
 Sets the active intrinsic current. More...
 
unsigned char IntrinsicType ()
 Gets the active intrinsic type (HI or LOW). More...
 
void IntrinsicType (unsigned char iVal)
 Sets the active intrinsic type (HI or LOW). More...
 
float ITime ()
 Gets the duration of the active current mode. More...
 
void ITime (float fltVal)
 Sets the duration of the active current mode. More...
 
virtual void Load (CStdXml &oXml)
 
virtual void LoadKeyFrameSnapshot (byte *aryBytes, long &lIndex)
 Loads a key frame snapshot. More...
 
virtual unsigned char NeuronType ()
 Gets the neuron type. More...
 
virtual void QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)
 
virtual void ResetSimulation ()
 Resets the simulation back to time 0. More...
 
virtual void SaveKeyFrameSnapshot (byte *aryBytes, long &lIndex)
 Saves a key frame snapshot. More...
 
virtual bool SetData (const std::string &strDataType, const std::string &strValue, bool bThrowError=true)
 Set a variable based on a string data type name. More...
 
- Public Member Functions inherited from FiringRateSim::Neurons::Neuron
 Neuron ()
 Default constructor. More...
 
virtual ~Neuron ()
 Destructor. More...
 
virtual float AccommodationTimeConstant ()
 Gets the accomodation time constant. More...
 
virtual void AccommodationTimeConstant (float fltVal)
 Sets the accomodation time constant. More...
 
virtual void AddExternalI (float fltVal)
 Adds to the external current. More...
 
virtual void AddExternalNodeInput (int iTargetDataType, float fltInput)
 Adds an external node input. More...
 
virtual bool AddItem (const std::string &strItemType, const std::string &strXml, bool bThrowError=true, bool bDoNotInit=false)
 Adds a new object to this parent. More...
 
virtual void AddSynapse (Synapse *lpSynapse)
 Adds a synapse to this neuron. More...
 
virtual void AddSynapse (std::string strXml, bool bDoNotInit)
 Adds a synapse using an xml packet. More...
 
virtual void ClearSynapses ()
 Clears the synapses list. More...
 
virtual float Cn ()
 Gets the membrane capacitance. More...
 
virtual void Cn (float fltVal)
 Sets the membrane capacitance. More...
 
virtual float ExternalI ()
 Gets the external current. More...
 
virtual void ExternalI (float fltVal)
 Sets the external current. More...
 
virtual int FindSynapseListPos (std::string strID, bool bThrowError=true)
 Searches for a synapse with the specified ID and returns its position in the list. More...
 
virtual float FiringFreq (FiringRateModule *lpModule)
 Calculates the current firing frequency. More...
 
virtual float Fmin ()
 Gets the minimum firing frequency. More...
 
virtual void Fmin (float fltVal)
 Sets the minimum firing frequency. More...
 
virtual float Gain ()
 Gets the firing frequency gain. More...
 
virtual void Gain (float fltVal)
 Sets the firing frequency gain. More...
 
virtual bool GainType ()
 Gets the gain type. (Old way or new way) More...
 
virtual void GainType (bool bVal)
 Sets the gain type. (Old way or new way) More...
 
virtual float * GetDataPointer (const std::string &strDataType)
 Returns a float pointer to a data item of interest in this object. More...
 
virtual SynapseGetSynapse (int iIndex)
 Gets a synapse by its index in the array. More...
 
virtual CStdPtrArray< Synapse > * GetSynapses ()
 Gets a pointer to the synapses array. More...
 
virtual float Gn ()
 Gets the membrane conductance. More...
 
virtual void Gn (float fltVal)
 Sets the membrane conductance. More...
 
virtual float Iinit ()
 
virtual void Iinit (float fltVal)
 
virtual void Initialize ()
 Initializes this object. More...
 
virtual float InitTime ()
 
virtual void InitTime (float fltVal)
 
virtual void InjectCurrent (float fltVal)
 Injects current into this neuron. More...
 
virtual float RelativeAccommodation ()
 Gets the relative accomodation. More...
 
virtual void RelativeAccommodation (float fltVal)
 Sets the relative accomodation. More...
 
virtual bool RemoveItem (const std::string &strItemType, const std::string &strID, bool bThrowError=true)
 Removes a child item from this parent. More...
 
virtual void RemoveSynapse (int iIndex)
 Removes the synapse described by iIndex. More...
 
virtual void RemoveSynapse (std::string strID, bool bThrowError=true)
 Removes the synapse by the GUID ID. More...
 
virtual void SetSystemPointers (Simulator *lpSim, Structure *lpStructure, NeuralModule *lpModule, Node *lpNode, bool bVerify)
 Sets the system pointers. More...
 
virtual void StepSimulation ()
 Step the simulation for this object. More...
 
virtual void TimeStepModified ()
 Notification method that the time step modified has been modified. Objects should recalculate any slice times as needed. More...
 
virtual int TotalSynapses ()
 Gets the total number of synapses. More...
 
virtual bool UseAccom ()
 Gets whether to use accommodation. More...
 
virtual void UseAccom (bool bVal)
 Sets whether to use accommodation. More...
 
virtual bool UseNoise ()
 Gets whether to use noise. More...
 
virtual void UseNoise (bool bVal)
 Sets whether to use noise. More...
 
virtual void VerifySystemPointers ()
 Verify that system pointers have been set correctly. More...
 
virtual float Vn ()
 Gets the membrane voltage. More...
 
virtual float VNoiseMax ()
 Gets the maximum noise voltage. More...
 
virtual void VNoiseMax (float fltVal)
 Sets the maximum noise voltage. More...
 
virtual float Vrest ()
 Gets the rest potential. More...
 
virtual void Vrest (float fltVal)
 Sets the rest potential. More...
 
virtual float Vth ()
 Gets the voltage threshold for firing. More...
 
virtual void Vth (float fltVal)
 Sets the voltage threshold for firing. More...
 
- Public Member Functions inherited from AnimatSim::Node
 Node ()
 Default constructor. More...
 
virtual ~Node ()
 Destructor. More...
 
virtual bool Enabled ()
 Tells whether this node is enabled. More...
 
virtual void Enabled (bool bValue)
 Enables the node. More...
 
virtual int GetTargetDataTypeIndex (const std::string &strDataType)
 Used to convert a string target data type into an integer index. More...
 
virtual void Kill (bool bState=true)
 Kills. More...
 
virtual void QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)
 Queries this object for a list of properties that can be changed using SetData. More...
 
virtual void SetSystemPointers (Simulator *lpSim, Structure *lpStructure, NeuralModule *lpModule, Node *lpNode, bool bVerify)
 Sets the system pointers. More...
 
- Public Member Functions inherited from AnimatSim::AnimatBase
 AnimatBase ()
 Constructs an AnimatBase object. More...
 
virtual ~AnimatBase ()
 Destroys the AnimatBase object.. More...
 
virtual void AfterResetSimulation ()
 Called after a simulation reset for some objects. More...
 
virtual NeuralModuleGetNeuralModule ()
 Gets the neural module. More...
 
virtual NodeGetNode ()
 Gets the node. More...
 
virtual SimulatorGetSimulator ()
 Gets the simulator pointer. More...
 
virtual StructureGetStructure ()
 Gets the structure for this node. More...
 
virtual bool HasProperty (const std::string &strName)
 Queries this object if it has a property with the given name. More...
 
virtual std::string ID ()
 Gets the unique GUID ID of this object. More...
 
virtual void ID (std::string strValue)
 Sets the unique GUID ID of the object. More...
 
virtual void Load (StdUtils::CStdXml &oXml)
 Loads the item using an XML data packet. More...
 
virtual std::string Name ()
 Gets the name of this object. More...
 
virtual void Name (std::string strValue)
 Sets the name of the object. Blank is acceptable. More...
 
virtual AnimatPropertyType PropertyType (const std::string &strName)
 
virtual void ReInitialize ()
 Re-initialize this object. More...
 
virtual void Reset ()
 Resets this object. More...
 
virtual void RigidBodyAdded (std::string strID)
 
virtual void RigidBodyRemoved (std::string strID)
 
virtual bool Selected ()
 Tells if this items is selected or not. More...
 
virtual void Selected (bool bValue, bool bSelectMultiple)
 Selects this object. More...
 
virtual bool SetData (const std::string &strDataType, const float fltValue, bool bThrowError=true)
 Set a variable based on a string data type name. More...
 
virtual bool SetData (const std::string &strDataType, const long lValue, bool bThrowError=true)
 Set a variable based on a string data type name. More...
 
virtual void SimPausing ()
 Called just before the simulation pauses. More...
 
virtual void SimStarting ()
 Called just before the simulation starts. More...
 
virtual void SimStopping ()
 Called just before the simulation stops. More...
 
virtual std::string Type ()
 returns the string type name of this object. More...
 
virtual void Type (std::string strValue)
 Sets the class type for this object. More...
 
virtual void VisualSelectionModeChanged (int iNewMode)
 Visual selection mode changed. More...
 

Protected Member Functions

virtual float CalculateIntrinsicCurrent (FiringRateModule *lpModule, float fltInputCurrent)
 Calculates the intrinsic current. More...
 
void HighCurrentOn ()
 Turns the high current on. More...
 
void LowCurrentOn ()
 Turns the low current on. More...
 
- Protected Member Functions inherited from FiringRateSim::Neurons::Neuron
virtual float CalculateFiringFrequency (float fltVn, float fltVth)
 Calculates the firing frequency of the neuron. More...
 
virtual float CalculateSynapticCurrent (FiringRateModule *lpModule)
 Calculates the total incoming synaptic current. More...
 
SynapseLoadSynapse (CStdXml &oXml)
 Loads a synapse. More...
 
- Protected Member Functions inherited from AnimatSim::Node
virtual void UpdateData ()
 Updates any reporting data for this time step. More...
 

Protected Attributes

float m_fltIl
 The low intrinsic current.
 
float m_fltIlinit
 The low intrinsic current init value.
 
float m_fltIntrinsic
 The active intrinsic current.
 
float m_fltITime
 Duration of the current mode (HI or LOW)
 
unsigned char m_iIntrinsicType
 Type of the intrinsic current that is active (HI or LOW)
 
unsigned char m_iIntrinsicTypeDefault
 
AnimatSim::Gains::Gainm_lpBurstGraph
 The pointer to the graph used to calculate the hi current duration.
 
AnimatSim::Gains::Gainm_lpCurrentGraph
 Pointer to the graph used to calculate the hi current.
 
AnimatSim::Gains::Gainm_lpIBurstGraph
 The pointer to the graph used to calculate the low current duration.
 
- Protected Attributes inherited from FiringRateSim::Neurons::Neuron
CStdPtrArray< Synapse > m_arySynapses
 The array of synapses that are in-coming to this neuron.
 
float m_aryVn [2]
 Current and next Membrane voltage. Vn.
 
float m_aryVth [2]
 Current and next threshold voltage. Vth.
 
bool m_bGainType
 Tells whether to use the old type gain or new type gain.
 
bool m_bUseAccom
 true use accomodation
 
bool m_bUseNoise
 Tells if we should use noise or not.
 
float m_fltAccomTimeConst
 The accomodation time constant tells how fast the neuron accomodates to a new membrane potential.
 
float m_fltAccomTimeMod
 If we are setting the accomodation time constant through modulation then this keeps track of it.
 
float m_fltAdapterI
 current added from all of the adapters.
 
float m_fltAdapterMemoryI
 Used to allow datacharts to track current input from adapters.
 
float m_fltCn
 Membrane capacitance.
 
float m_fltDCTH
 expon decline working factor for thresh accomm
 
float m_fltExternalI
 Externally injected current.
 
float m_fltFiringFreq
 Current firing frequency.
 
float m_fltFmin
 Minimum Firing frequency.
 
float m_fltGain
 
float m_fltGn
 Membrane conductance.
 
float m_fltIinit
 The initialization current to turn on at the beginning of the simulation.
 
float m_fltInitTime
 The duration for how long the Iinit current is on at the beginning of the simulation.
 
float m_fltIntrinsicI
 Intrinsic current.
 
float m_fltInvCn
 Inverse membrane capacitance.
 
float m_fltRelativeAccom
 The relative accomodation rate.
 
float m_fltSynapticI
 Current synaptic current.
 
float m_fltTotalMemoryI
 Total current applied to the neuron.
 
float m_fltVn
 Current membrane voltage.
 
float m_fltVndisp
 this is the membrane voltage that is reported back to animatlab.
 
float m_fltVNoise
 This is the random noise that should be added to the membrane voltage at a timestep.
 
float m_fltVNoiseMax
 Tells the maximum noise to use when running sim.
 
float m_fltVrest
 this is the resting potential of the neuron.
 
float m_fltVth
 Firing frequency voltage threshold.
 
float m_fltVthadd
 The component added to Vthi for accomodation.
 
float m_fltVthdisp
 this is the theshold voltage that is reported back to animatlab.
 
float m_fltVthi
 Initial firing frequency voltage threshold.
 
FiringRateModulem_lpFRModule
 Pointer to the parent FiringRateModule.
 
- Protected Attributes inherited from AnimatSim::Node
bool m_bInitEnabled
 Keeps track of the enabled state at sim startup.
 
float m_fltEnabled
 This is used for reporting the enabled state in a GetDataPointer call.
 
Organism * m_lpOrganism
 The pointer to this node's organism.
 
- Protected Attributes inherited from AnimatSim::AnimatBase
bool m_bEnabled
 Tells if this item is enabled or not. If it is not enabled then it is not run.
 
bool m_bSelected
 Tells whether the object is selected or not.
 
AnimatSim::Behavior::NeuralModulem_lpModule
 The pointer to this items parentNeuralModule. If this is not relevant for this object then this is NULL.
 
Nodem_lpNode
 The pointer to this items parent Node. If this is not relevant for this object then this is NULL.
 
Simulatorm_lpSim
 The pointer to a Simulation.
 
AnimatSim::Environment::Structurem_lpStructure
 The pointer to this items parent Structure. If this is not relevant for this object then this is NULL.
 
std::string m_strID
 The unique Id for this object.
 
std::string m_strName
 The name for this object.
 
std::string m_strType
 The type for this object. Examples are Box, Plane, Neuron, etc..
 

Additional Inherited Members

- Static Public Member Functions inherited from AnimatSim::Node
static NodeCastToDerived (AnimatBase *lpBase)
 

Detailed Description

Random firing rate neuron.

This neuron has intrinsic currents that are randomly generated. It has a high current and low current. The low current is a constant. The high current and the burst durations are calculated using random variables. Each one has a gain function. A random number between 0 and 100 is generated and fed into the gain function and this determines the current and/or the duration value.

Author
dcofer
Date
3/29/2011

Definition at line 24 of file RandomNeuron.h.

Constructor & Destructor Documentation

FiringRateSim::Neurons::RandomNeuron::RandomNeuron ( )

Default constructor.

Author
dcofer
Date
3/29/2011

Definition at line 25 of file RandomNeuron.cpp.

References m_fltIl, m_fltIlinit, m_fltIntrinsic, m_fltITime, m_iIntrinsicType, m_iIntrinsicTypeDefault, m_lpBurstGraph, m_lpCurrentGraph, m_lpIBurstGraph, and StdUtils::Std_IRand().

+ Here is the call graph for this function:

FiringRateSim::Neurons::RandomNeuron::~RandomNeuron ( )
virtual

Destructor.

Author
dcofer
Date
3/29/2011

Definition at line 50 of file RandomNeuron.cpp.

References m_lpBurstGraph, m_lpCurrentGraph, m_lpIBurstGraph, and StdUtils::Std_TraceMsg().

+ Here is the call graph for this function:

Member Function Documentation

void FiringRateSim::Neurons::RandomNeuron::BurstLengthDistribution ( AnimatSim::Gains::Gain lpGain)

Sets the burst length distribution.

Author
dcofer
Date
3/29/2011
Parameters
[in,out]lpGainPointer to a gain.

Definition at line 279 of file RandomNeuron.cpp.

References m_lpBurstGraph.

void FiringRateSim::Neurons::RandomNeuron::BurstLengthDistribution ( std::string  strXml)

Sets the burst length distribution using an xml packet.

Author
dcofer
Date
3/29/2011
Parameters
strXmlThe xml packet defining the gain.

Definition at line 297 of file RandomNeuron.cpp.

References AnimatSim::Gains::LoadGain(), and AnimatSim::AnimatBase::m_lpSim.

+ Here is the call graph for this function:

float FiringRateSim::Neurons::RandomNeuron::CalculateIntrinsicCurrent ( FiringRateModule m_lpFRModule,
float  fltInputCurrent 
)
protectedvirtual

Calculates the intrinsic current.

Author
dcofer
Date
3/29/2011
Parameters
[in,out]m_lpFRModulePointer to the parent FiringRateModule.
fltInputCurrentThe input current.
Returns
The calculated intrinsic current.

Reimplemented from FiringRateSim::Neurons::Neuron.

Definition at line 396 of file RandomNeuron.cpp.

References HighCurrentOn(), LowCurrentOn(), m_fltIntrinsic, m_fltITime, m_iIntrinsicType, and AnimatSim::Behavior::NeuralModule::TimeStep().

+ Here is the call graph for this function:

long FiringRateSim::Neurons::RandomNeuron::CalculateSnapshotByteSize ( )
virtual

Calculates the snapshot byte size.

Sometimes the user may want to capture a snapshot of the simulation at a given point in time, and then be able to go back to that specific point. To do this we grab a snapshot of all the data in the system, including the neural variables. We essentially serialize the data into a binary format for later re-use. This method calculates the number of bytes that will be required to store the entire object.

Author
dcofer
Date
2/24/2011
Returns
The calculated snapshot byte size.

Reimplemented from FiringRateSim::Neurons::Neuron.

Definition at line 412 of file RandomNeuron.cpp.

References FiringRateSim::Neurons::Neuron::CalculateSnapshotByteSize(), m_fltITime, and m_iIntrinsicType.

+ Here is the call graph for this function:

void FiringRateSim::Neurons::RandomNeuron::CurrentDistribution ( AnimatSim::Gains::Gain lpGain)

Sets the current distribution.

Author
dcofer
Date
3/29/2011
Parameters
[in,out]lpGainPointer to a gain.

Definition at line 244 of file RandomNeuron.cpp.

References m_lpCurrentGraph.

void FiringRateSim::Neurons::RandomNeuron::CurrentDistribution ( std::string  strXml)

Sets the current distribution using an xml packet.

Author
dcofer
Date
3/29/2011
Parameters
strXmlThe xml packet defining the gain.

Definition at line 262 of file RandomNeuron.cpp.

References AnimatSim::Gains::LoadGain(), and AnimatSim::AnimatBase::m_lpSim.

+ Here is the call graph for this function:

void FiringRateSim::Neurons::RandomNeuron::HighCurrentOn ( )
protected

Turns the high current on.

Author
dcofer
Date
3/29/2011

Definition at line 347 of file RandomNeuron.cpp.

References AnimatSim::Gains::Gain::CalculateGain(), m_fltIntrinsic, m_fltITime, m_iIntrinsicType, m_lpBurstGraph, m_lpCurrentGraph, and StdUtils::Std_DRand().

Referenced by CalculateIntrinsicCurrent().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

float FiringRateSim::Neurons::RandomNeuron::Il ( )

Gets the low current.

Author
dcofer
Date
3/29/2011
Returns
low current.

Definition at line 143 of file RandomNeuron.cpp.

References m_fltIl.

void FiringRateSim::Neurons::RandomNeuron::Il ( float  fltVal)

Sets the low current.

Author
dcofer
Date
3/29/2011
Parameters
fltValThe new value.

Definition at line 154 of file RandomNeuron.cpp.

References m_fltIl.

float FiringRateSim::Neurons::RandomNeuron::Ilinit ( )

Gets the low current init value.

Author
dcofer
Date
3/29/2011
Returns
low current init value.

Definition at line 167 of file RandomNeuron.cpp.

References m_fltIlinit.

Referenced by SetData().

+ Here is the caller graph for this function:

void FiringRateSim::Neurons::RandomNeuron::Ilinit ( float  fltVal)

Sets the low current init value.

Author
dcofer
Date
3/29/2011
Parameters
fltValThe new value.

Definition at line 178 of file RandomNeuron.cpp.

References m_fltIl, and m_fltIlinit.

void FiringRateSim::Neurons::RandomNeuron::InterbusrtLengthDistribution ( AnimatSim::Gains::Gain lpGain)

Sets the interbusrt length distribution.

Author
dcofer
Date
3/29/2011
Parameters
[in,out]lpGainPointer to a gain.

Definition at line 314 of file RandomNeuron.cpp.

References m_lpIBurstGraph.

void FiringRateSim::Neurons::RandomNeuron::InterbusrtLengthDistribution ( std::string  strXml)

Sets the interbusrt length distribution using an xml packet.

Author
dcofer
Date
3/29/2011
Parameters
strXmlThe xml packet defining the gain.

Definition at line 332 of file RandomNeuron.cpp.

References AnimatSim::Gains::LoadGain(), and AnimatSim::AnimatBase::m_lpSim.

+ Here is the call graph for this function:

float FiringRateSim::Neurons::RandomNeuron::IntrinsicCurrent ( )
virtual

Gets the active intrinsic current.

Author
dcofer
Date
3/29/2011
Returns
intrinsic current.

Reimplemented from FiringRateSim::Neurons::Neuron.

Definition at line 119 of file RandomNeuron.cpp.

References m_fltIntrinsic.

void FiringRateSim::Neurons::RandomNeuron::IntrinsicCurrent ( float  fltVal)
virtual

Sets the active intrinsic current.

Author
dcofer
Date
3/29/2011
Parameters
fltValThe new value.

Reimplemented from FiringRateSim::Neurons::Neuron.

Definition at line 130 of file RandomNeuron.cpp.

References m_fltIntrinsic.

unsigned char FiringRateSim::Neurons::RandomNeuron::IntrinsicType ( )

Gets the active intrinsic type (HI or LOW).

Author
dcofer
Date
3/29/2011
Returns
intrinsic type.

Definition at line 95 of file RandomNeuron.cpp.

References m_iIntrinsicType.

void FiringRateSim::Neurons::RandomNeuron::IntrinsicType ( unsigned char  iVal)

Sets the active intrinsic type (HI or LOW).

Author
dcofer
Date
3/29/2011
Parameters
iValThe new value.

Definition at line 106 of file RandomNeuron.cpp.

References m_iIntrinsicType.

float FiringRateSim::Neurons::RandomNeuron::ITime ( )

Gets the duration of the active current mode.

Author
dcofer
Date
3/29/2011
Returns
duration.

Definition at line 71 of file RandomNeuron.cpp.

References m_fltITime.

void FiringRateSim::Neurons::RandomNeuron::ITime ( float  fltVal)

Sets the duration of the active current mode.

Author
dcofer
Date
3/29/2011
Parameters
fltValThe new value.

Definition at line 82 of file RandomNeuron.cpp.

References m_fltITime.

void FiringRateSim::Neurons::RandomNeuron::LoadKeyFrameSnapshot ( byte *  aryBytes,
long &  lIndex 
)
virtual

Loads a key frame snapshot.

Sometimes the user may want to capture a snapshot of the simulation at a given point in time, and then be able to go back to that specific point. To do this we grab a snapshot of all the data in the system, including the neural variables. We essentially serialize the data into a binary format for later re-use. This method goes through each module and loads its data from the byte array.

Author
dcofer
Date
2/24/2011
Parameters
[in,out]aryBytesThe array of bytes where the data is being stored.
[in,out]lIndexCurrent zero-based index of the read position in the array.

Reimplemented from FiringRateSim::Neurons::Neuron.

Definition at line 429 of file RandomNeuron.cpp.

References FiringRateSim::Neurons::Neuron::LoadKeyFrameSnapshot(), m_fltITime, and m_iIntrinsicType.

+ Here is the call graph for this function:

void FiringRateSim::Neurons::RandomNeuron::LowCurrentOn ( )
protected

Turns the low current on.

Author
dcofer
Date
3/29/2011

Definition at line 372 of file RandomNeuron.cpp.

References AnimatSim::Gains::Gain::CalculateGain(), m_fltIl, m_fltIntrinsic, m_fltITime, m_iIntrinsicType, m_lpIBurstGraph, and StdUtils::Std_DRand().

Referenced by CalculateIntrinsicCurrent().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

unsigned char FiringRateSim::Neurons::RandomNeuron::NeuronType ( )
virtual

Gets the neuron type.

Author
dcofer
Date
3/29/2011
Returns
neuron type.

Reimplemented from FiringRateSim::Neurons::Neuron.

Definition at line 192 of file RandomNeuron.cpp.

void FiringRateSim::Neurons::RandomNeuron::ResetSimulation ( )
virtual

Resets the simulation back to time 0.

This method calls the ResetSimulation method on all subitems in order to reset the simulation back to the beginning.

Author
dcofer
Date
3/1/2011

Reimplemented from FiringRateSim::Neurons::Neuron.

Definition at line 386 of file RandomNeuron.cpp.

References m_fltIl, m_fltIlinit, m_fltIntrinsic, m_fltITime, m_iIntrinsicType, m_iIntrinsicTypeDefault, and FiringRateSim::Neurons::Neuron::ResetSimulation().

+ Here is the call graph for this function:

void FiringRateSim::Neurons::RandomNeuron::SaveKeyFrameSnapshot ( byte *  aryBytes,
long &  lIndex 
)
virtual

Saves a key frame snapshot.

Sometimes the user may want to capture a snapshot of the simulation at a given point in time, and then be able to go back to that specific point. To do this we grab a snapshot of all the data in the system, including the neural variables. We essentially serialize the data into a binary format for later re-use. This method goes through each module and saves its data into the byte array.

Author
dcofer
Date
2/24/2011
Parameters
[in,out]aryBytesThe array of bytes where the data is being stored.
[in,out]lIndexCurrent zero-based index of the write position in the array.

Reimplemented from FiringRateSim::Neurons::Neuron.

Definition at line 418 of file RandomNeuron.cpp.

References m_fltITime, m_iIntrinsicType, and FiringRateSim::Neurons::Neuron::SaveKeyFrameSnapshot().

+ Here is the call graph for this function:

bool FiringRateSim::Neurons::RandomNeuron::SetData ( const std::string &  strDataType,
const std::string &  strValue,
bool  bThrowError = true 
)
virtual

Set a variable based on a string data type name.

This is a generic method that can be used to set any variable in an AnimatBase object by specifying the name of the variable and a string representation of that data. The GUI uses this method to set data into variables in the simulation when the user changes them in the UI. The value string can be as simple as a float or int, or as complex as an xml packet. It is the developers responsibilty to know what type of data is needed and to process it accordingly.

Author
dcofer
Date
2/22/2011
Parameters
strDataTypestring name of the data type to set.
strValueThe string value of the data. It is up to the developer to determine what this should be. For example, in most cases it is simply a float and you just have to convert it to a float and make the appropriate mutator method call. However, it can be any type of string, including an entire xml packet. It is the developers responsibility to know how to set and process the data as required.
bThrowErrortrue to throw error if there is a problem. If false then it will not return an error, just return false.
Returns
true if it succeeds, false if it fails.

Reimplemented from FiringRateSim::Neurons::Neuron.

Definition at line 442 of file RandomNeuron.cpp.

References Ilinit(), FiringRateSim::Neurons::Neuron::SetData(), and StdUtils::Std_CheckString().

+ Here is the call graph for this function:

Member Data Documentation

unsigned char FiringRateSim::Neurons::RandomNeuron::m_iIntrinsicTypeDefault
protected

Default Type of the intrinsic current that is active (HI or LOW). Used to reset the intrinsic type at the beginning of each run.

Definition at line 32 of file RandomNeuron.h.

Referenced by RandomNeuron(), and ResetSimulation().


The documentation for this class was generated from the following files: