nest::correlation_detector::Parameters_ Struct Reference

Public Member Functions
	Parameters_ ()
	Sets default parameter values. More...
	Parameters_ (const Parameters_ &)
	Recalibrate all times. More...
void	get (DictionaryDatum &) const
	Store current values in dictionary. More...
bool	set (const DictionaryDatum &, const correlation_detector &)
	Set values from dicitonary. More...

Public Attributes
Time	delta_tau_
	width of correlation histogram bins More...
Time	tau_max_
	maximum time difference of events to detect More...
Time	Tstart_
	start of recording More...
Time	Tstop_
	end of recording More...

Constructor & Destructor Documentation

nest::correlation_detector::Parameters_::Parameters_

(

)

Sets default parameter values.

nest::correlation_detector::Parameters_::Parameters_

(

const Parameters_ &

p

)

Recalibrate all times.

References nest::Time::calibrate(), delta_tau_, tau_max_, Tstart_, and Tstop_.

Member Function Documentation

void nest::correlation_detector::Parameters_::get

(

DictionaryDatum &

d

)

const

Store current values in dictionary.

References nest::names::delta_tau, nest::names::tau_max, nest::names::Tstart, and nest::names::Tstop.

bool nest::correlation_detector::Parameters_::set	(	const DictionaryDatum &	d,
		const correlation_detector &	n
	)

Set values from dicitonary.

Returns

true if the state needs to be reset after a change of binwidth or tau_max.

References nest::names::delta_tau, nest::Node::get_name(), nest::Time::ms, nest::names::tau_max, nest::names::Tstart, and nest::names::Tstop.

Referenced by nest::correlation_detector::set_status().

Member Data Documentation

Time nest::correlation_detector::Parameters_::delta_tau_

width of correlation histogram bins

Referenced by nest::correlation_detector::correlation_detector(), Parameters_(), and nest::correlation_detector::State_::reset().

Time nest::correlation_detector::Parameters_::tau_max_

maximum time difference of events to detect

Referenced by Parameters_(), and nest::correlation_detector::State_::reset().

Time nest::correlation_detector::Parameters_::Tstart_

start of recording

Referenced by Parameters_().

Time nest::correlation_detector::Parameters_::Tstop_

end of recording

Referenced by Parameters_().

---

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

• correlation_detector.h
• correlation_detector.cpp