Spike
Loading...
Searching...
No Matches
Spike::SusceptibilitySimulation Class Referenceabstract

Implements a prototype simulation during which we measure the susceptibility of an integrate-and-fire neuron (with or without adaptation). More...

#include <SusceptibilitySimulation.h>

Public Member Functions

 SusceptibilitySimulation (const std::string &input_file)
 Constructs susceptibility simulation from .ini file.
 
virtual void calculate (size_t trials)=0
 Calculates the susceptibility for a given number of trials.
 
void set_c (double c_new)
 Sets a new noise split coefficient.
 
size_t get_N_neurons () const
 Returns the number of neurons (trials) for this simulation.
 
const TimeFrameget_time_frame () const
 Returns the time frame.
 

Protected Attributes

TimeFrame time_frame
 time frame
 
SpikeTrain spike_train
 spike train
 
WhiteNoiseSignal signal
 white noise signal
 
std::unique_ptr< IFneuron
 neuron
 
size_t N_neurons
 number of neurons (trials)
 
double c
 noise split coefficient
 
double D
 total noise intensity
 

Friends

std::ostream & operator<< (std::ostream &out, const SusceptibilitySimulation &suscept_sim)
 Overloads the << operator so we can print a simulation.
 

Detailed Description

Implements a prototype simulation during which we measure the susceptibility of an integrate-and-fire neuron (with or without adaptation).

Constructor & Destructor Documentation

◆ SusceptibilitySimulation()

Spike::SusceptibilitySimulation::SusceptibilitySimulation ( const std::string & input_file)
explicit

Constructs susceptibility simulation from .ini file.

Parameters
input_filepath to .ini file

Member Function Documentation

◆ calculate()

virtual void Spike::SusceptibilitySimulation::calculate ( size_t trials)
pure virtual

Calculates the susceptibility for a given number of trials.

Parameters
trialsnumber of Trials

Implemented in Spike::SusceptibilitySimulationLin, Spike::SusceptibilitySimulationLinNonlin, and Spike::SusceptibilitySimulationNonlin.

◆ get_N_neurons()

size_t Spike::SusceptibilitySimulation::get_N_neurons ( ) const
inline

Returns the number of neurons (trials) for this simulation.

Returns
number of neurons

◆ get_time_frame()

const TimeFrame & Spike::SusceptibilitySimulation::get_time_frame ( ) const
inline

Returns the time frame.

Returns
time frame

◆ set_c()

void Spike::SusceptibilitySimulation::set_c ( double c_new)

Sets a new noise split coefficient.

Parameters
c_newnew noise split coefficient

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream & out,
const SusceptibilitySimulation & suscept_sim )
friend

Overloads the << operator so we can print a simulation.

Parameters
outstream
suscept_simsusceptibility simulation
Returns

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