Tonic firing rate neuron. More...

#include <TonicNeuron.h>

Inheritance diagram for FiringRateSim::Neurons::TonicNeuron:

Collaboration diagram for FiringRateSim::Neurons::TonicNeuron:

Public Member Functions
	TonicNeuron ()
	Default constructor. More...

virtual	~TonicNeuron ()
	Destructor. More...

virtual void	Copy (CStdSerialize *lpSource)

float	Ih ()
	Gets the tonic current. More...

void	Ih (float fltVal)
	Sets the tonic current. More...

virtual void	Load (CStdXml &oXml)

virtual unsigned char	NeuronType ()
	Gets the neuron type. More...

virtual void	QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)

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 long	CalculateSnapshotByteSize ()
	Calculates the snapshot byte size. 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 Synapse *	GetSynapse (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	IntrinsicCurrent ()
	Gets the intrinsic current. More...

virtual void	IntrinsicCurrent (float fltVal)
	Sets the intrinsic current. More...

virtual void	LoadKeyFrameSnapshot (byte *aryBytes, long &lIndex)
	Loads a key frame snapshot. 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	ResetSimulation ()
	Resets the simulation back to time 0. More...

virtual void	SaveKeyFrameSnapshot (byte *aryBytes, long &lIndex)
	Saves a key frame snapshot. 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 NeuralModule *	GetNeuralModule ()
	Gets the neural module. More...

virtual Node *	GetNode ()
	Gets the node. More...

virtual Simulator *	GetSimulator ()
	Gets the simulator pointer. More...

virtual Structure *	GetStructure ()
	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...

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...

Synapse *	LoadSynapse (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_fltIh
	The tonic current.

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.

FiringRateModule *	m_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::NeuralModule *	m_lpModule
	The pointer to this items parentNeuralModule. If this is not relevant for this object then this is NULL.

Node *	m_lpNode
	The pointer to this items parent Node. If this is not relevant for this object then this is NULL.

Simulator *	m_lpSim
	The pointer to a Simulation.

AnimatSim::Environment::Structure *	m_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 Node *	CastToDerived (AnimatBase *lpBase)

Detailed Description

Tonic firing rate neuron.

This neuron has a tonic intrinsic current that is applied to the neuron.

Author: dcofer

Date: 3/29/2011

Definition at line 21 of file TonicNeuron.h.

Constructor & Destructor Documentation

FiringRateSim::Neurons::TonicNeuron::TonicNeuron ( )

Default constructor.

Author: dcofer

Date: 3/29/2011

Definition at line 25 of file TonicNeuron.cpp.

References m_fltIh.

FiringRateSim::Neurons::TonicNeuron::~TonicNeuron ( )

virtual

Destructor.

Author: dcofer

Date: 3/29/2011

Definition at line 36 of file TonicNeuron.cpp.

Member Function Documentation

float FiringRateSim::Neurons::TonicNeuron::CalculateIntrinsicCurrent	(	FiringRateModule *	m_lpFRModule,
		float	fltInputCurrent
	)

protectedvirtual

Calculates the intrinsic current.

Author: dcofer

Date: 3/29/2011

Parameters

[in,out]	m_lpFRModule	Pointer to the parent FiringRateModule.
	fltInputCurrent	The input current.

Returns: The calculated intrinsic current.

Reimplemented from FiringRateSim::Neurons::Neuron.

Definition at line 85 of file TonicNeuron.cpp.

References m_fltIh.

float FiringRateSim::Neurons::TonicNeuron::Ih ( )

Gets the tonic current.

Author: dcofer

Date: 3/29/2011

Returns: tonic current.

Definition at line 49 of file TonicNeuron.cpp.

References m_fltIh.

Referenced by SetData().

Here is the caller graph for this function:

void FiringRateSim::Neurons::TonicNeuron::Ih ( float fltVal )

Sets the tonic current.

Author: dcofer

Date: 3/29/2011

Parameters

fltVal The new value.

Definition at line 60 of file TonicNeuron.cpp.

References m_fltIh.

unsigned char FiringRateSim::Neurons::TonicNeuron::NeuronType ( )

virtual

Gets the neuron type.

Author: dcofer

Date: 3/29/2011

Returns: neuron type.

Reimplemented from FiringRateSim::Neurons::Neuron.

Definition at line 73 of file TonicNeuron.cpp.

bool FiringRateSim::Neurons::TonicNeuron::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

strDataType	string name of the data type to set.
strValue	The 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.
bThrowError	true 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 90 of file TonicNeuron.cpp.

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

Here is the call graph for this function:

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation