Spike::StepSignal Class Reference

Implement a step get_value, i.e. alpha*Theta(t - t_0) More...

#include <StepSignal.h>

Public Member Functions
	StepSignal (double alpha, double t_0, const TimeFrame &time_frame)
	Construct StepSignal from parameters.
	StepSignal (const std::string &input_file, const TimeFrame &time_frame)
	Construct StepSignal from input file.
void	calculate_signal ()
	Calculates the step get_value.
double	signal (double t) const
	Returns get_value, i.e. alpha*Theta(t - t_0)
void	print (std::ostream &out) const override
	Prints the signal to out stream.
Public Member Functions inherited from Spike::Signal
	Signal (const TimeFrame &time_frame)
	Constructs signal from given time frame.
double	get_value (size_t i) const
	Returns the signal value at index i.

Additional Inherited Members
Protected Attributes inherited from Spike::Signal
const TimeFrame &	time_frame
	reference to time frame
std::vector< double >	signal_values
	array containing the signal values

Detailed Description

Implement a step get_value, i.e. alpha*Theta(t - t_0)

Constructor & Destructor Documentation

StepSignal() [1/2]

Spike::StepSignal::StepSignal	(	double	alpha,
		double	t_0,
		const TimeFrame &	time_frame )

Construct StepSignal from parameters.

Parameters

alpha	Amplitude
t_0	Start time
time_frame	TimeFrame

StepSignal() [2/2]

Spike::StepSignal::StepSignal	(	const std::string &	input_file,
		const TimeFrame &	time_frame )

Construct StepSignal from input file.

Parameters

input_file	Input file in .ini format
time_frame	TimeFrame

Member Function Documentation

print()

void Spike::StepSignal::print ( std::ostream & out ) const

inlineoverridevirtual

Prints the signal to out stream.

Parameters

out	out stream

Implements Spike::Signal.

signal()

double Spike::StepSignal::signal

(

double

t

)

const

Returns get_value, i.e. alpha*Theta(t - t_0)

Parameters

t

Time

Returns

Signal, i.e. alpha*Theta(t - t_0)

---

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

• /github/workspace/Spike/Signal/StepSignal.h
• /github/workspace/Spike/Signal/StepSignal.cpp