nest::Gaussian2DParameter Class Reference

Parameter class representing a gaussian distribution in two dimensions applied on a parameter. More...

#include <parameter.h>

Inheritance diagram for nest::Gaussian2DParameter:

Collaboration diagram for nest::Gaussian2DParameter:

Public Member Functions
	Gaussian2DParameter (const Dictionary &d)
	Construct the parameter from a dictionary of arguments.
	Gaussian2DParameter (const Gaussian2DParameter &p)
double	value (RngPtr, Node *) override
double	value (RngPtr rng, const std::vector< double > &source_pos, const std::vector< double > &target_pos, const AbstractLayer &layer, Node *node) override
	Generates a value based on parameter specifications and arguments.
virtual double	value (RngPtr, Node *)
	Generates a value based on parameter specifications and arguments.
virtual double	value (RngPtr rng, const std::vector< double > &source_pos, const std::vector< double > &target_pos, const AbstractLayer &layer, Node *node)
	Generates a value based on parameter specifications and arguments.
Public Member Functions inherited from nest::Parameter
	Parameter (bool is_spatial=false, bool returns_int_only=false)
	Creates a Parameter, with optionally specified attributes.
	Parameter (const Parameter &p)=default
virtual	~Parameter ()=default
std::vector< double >	apply (const NodeCollectionPTR &, const std::vector< std::vector< double > > &)
	Applies a parameter on a single-node ID NodeCollection and given array of positions.
bool	is_spatial () const
	Check if the Parameter is based on spatial properties.
bool	returns_int_only () const
	Check if the Parameter only returns integer values.

Protected Attributes
ParameterPTR const	px_
ParameterPTR const	py_
const double	mean_x_
const double	mean_y_
const double	x_term_const_
const double	y_term_const_
const double	xy_term_const_
Protected Attributes inherited from nest::Parameter
bool	is_spatial_ { false }
bool	returns_int_only_ { false }

Additional Inherited Members
Protected Member Functions inherited from nest::Parameter
bool	value_is_integer_ (const double value) const

Detailed Description

Parameter class representing a gaussian distribution in two dimensions applied on a parameter.

Can only be used when connecting spatially distributed nodes.

Constructor & Destructor Documentation

Gaussian2DParameter() [1/2]

nest::Gaussian2DParameter::Gaussian2DParameter

(

const Dictionary &

d

)

Construct the parameter from a dictionary of arguments.

Gaussian2DParameter() [2/2]

nest::Gaussian2DParameter::Gaussian2DParameter ( const Gaussian2DParameter &  p )

inline

Member Function Documentation

value() [1/4]

double nest::Parameter::value ( RngPtr  rng, const std::vector< double > &  source_pos, const std::vector< double > &  target_pos, const AbstractLayer &  layer, Node *  node  )

inlinevirtual

Generates a value based on parameter specifications and arguments.

Used when connecting spatial nodes. Note that not all parameters support all overloaded versions.

Parameters

rng	pointer to the random number generator
source_pos	position of the source node
target_pos	position of the target node
layer	spatial layer
node	target node, required for normal and lognormal parameters

Returns

the value of the parameter.

Reimplemented from nest::Parameter.

value() [2/4]

double nest::Gaussian2DParameter::value ( RngPtr  rng, const std::vector< double > &  source_pos, const std::vector< double > &  target_pos, const AbstractLayer &  layer, Node *  node  )

overridevirtual

Generates a value based on parameter specifications and arguments.

Used when connecting spatial nodes. Note that not all parameters support all overloaded versions.

Parameters

rng	pointer to the random number generator
source_pos	position of the source node
target_pos	position of the target node
layer	spatial layer
node	target node, required for normal and lognormal parameters

Returns

the value of the parameter.

Reimplemented from nest::Parameter.

References mean_x_, mean_y_, px_, py_, x_term_const_, xy_term_const_, and y_term_const_.

value() [3/4]

virtual double nest::Parameter::value ( RngPtr  , Node *    )

inlinevirtual

Generates a value based on parameter specifications and arguments.

Used when getting a parameter value based on random values or node attributes, like position. Note that not all parameters support all overloaded versions.

Parameters

rng	pointer to the random number generator
node	pointer to the node, used when the node position is relevant

Returns

the value of the parameter.

Reimplemented from nest::Parameter.

value() [4/4]

double nest::Gaussian2DParameter::value ( RngPtr  , Node *    )

inlineoverridevirtual

Returns

the value of the parameter.

Reimplemented from nest::Parameter.

Member Data Documentation

mean_x_

const double nest::Gaussian2DParameter::mean_x_

protected

Referenced by value().

mean_y_

const double nest::Gaussian2DParameter::mean_y_

protected

Referenced by value().

px_

ParameterPTR const nest::Gaussian2DParameter::px_

protected

Referenced by value().

py_

ParameterPTR const nest::Gaussian2DParameter::py_

protected

Referenced by value().

x_term_const_

const double nest::Gaussian2DParameter::x_term_const_

protected

Referenced by value().

xy_term_const_

const double nest::Gaussian2DParameter::xy_term_const_

protected

Referenced by value().

y_term_const_

const double nest::Gaussian2DParameter::y_term_const_

protected

Referenced by value().

---

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

• parameter.h
• parameter.cpp