nest::correlomatrix_detector::Parameters_ Struct Reference

Collaboration diagram for nest::correlomatrix_detector::Parameters_:

Public Member Functions
	Parameters_ ()
	Sets default parameter values.
	Parameters_ (const Parameters_ &)
	Recalibrate all times.
Parameters_ &	operator= (const Parameters_ &)
void	get (Dictionary &) const
	Store current values in dictionary.
bool	set (const Dictionary &, const correlomatrix_detector &, Node *node)
	Set values from dictionary.
Time	get_default_delta_tau ()

Public Attributes
Time	delta_tau_
	width of correlation histogram bins
Time	tau_max_
	maximum time difference of events to detect
Time	Tstart_
	start of recording
Time	Tstop_
	end of recording //!< end of recording
size_t	N_channels_
	number of channels

Constructor & Destructor Documentation

Parameters_() [1/2]

nest::correlomatrix_detector::Parameters_::Parameters_

(

)

Sets default parameter values.

Parameters_() [2/2]

nest::correlomatrix_detector::Parameters_::Parameters_

(

const Parameters_ &

p

)

Recalibrate all times.

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

Here is the call graph for this function:

Member Function Documentation

get()

void nest::correlomatrix_detector::Parameters_::get

(

Dictionary &

d

)

const

Store current values in dictionary.

References nest::names::delta_tau(), nest::names::N_channels(), nest::names::tau_max(), nest::names::Tstart(), and nest::names::Tstop().

Referenced by nest::correlomatrix_detector::get_status().

Here is the call graph for this function:

Here is the caller graph for this function:

get_default_delta_tau()

Time nest::correlomatrix_detector::Parameters_::get_default_delta_tau ( )

inline

References nest::Time::get_resolution().

Referenced by nest::correlomatrix_detector::calibrate_time(), and Parameters_().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

correlomatrix_detector::Parameters_ & nest::correlomatrix_detector::Parameters_::operator=

(

const Parameters_ &

p

)

set()

bool nest::correlomatrix_detector::Parameters_::set	(	const Dictionary &	d,
		const correlomatrix_detector &	n,
		Node *	node
	)

Set values from dictionary.

Returns

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

References nest::names::delta_tau(), nest::names::N_channels(), nest::names::tau_max(), nest::names::Tstart(), nest::names::Tstop(), and nest::update_value_param().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

delta_tau_

Time nest::correlomatrix_detector::Parameters_::delta_tau_

width of correlation histogram bins

Referenced by nest::correlomatrix_detector::calibrate_time(), nest::correlomatrix_detector::handle(), and Parameters_().

N_channels_

size_t nest::correlomatrix_detector::Parameters_::N_channels_

number of channels

Referenced by nest::correlomatrix_detector::handle(), and nest::correlomatrix_detector::handles_test_event().

tau_max_

Time nest::correlomatrix_detector::Parameters_::tau_max_

maximum time difference of events to detect

Referenced by nest::correlomatrix_detector::calibrate_time(), nest::correlomatrix_detector::handle(), and Parameters_().

Tstart_

Time nest::correlomatrix_detector::Parameters_::Tstart_

start of recording

Referenced by nest::correlomatrix_detector::calibrate_time(), nest::correlomatrix_detector::handle(), and Parameters_().

Tstop_

Time nest::correlomatrix_detector::Parameters_::Tstop_

end of recording //!< end of recording

Referenced by nest::correlomatrix_detector::calibrate_time(), nest::correlomatrix_detector::handle(), and Parameters_().

---

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

• correlomatrix_detector.h
• correlomatrix_detector.cpp