nest::GaborParameter Class Reference

#include <parameter.h>

Inheritance diagram for nest::GaborParameter:

Collaboration diagram for nest::GaborParameter:

Public Member Functions
	GaborParameter (const Dictionary &d)
	Construct the parameter from a dictionary of arguments.
	GaborParameter (const GaborParameter &p)
	Copy constructor.
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
std::shared_ptr< Parameter > const	px_
std::shared_ptr< Parameter > const	py_
const double	cos_
const double	sin_
const double	gamma_
const double	inv_two_std2_
const double	lambda_
const double	psi_
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

Constructor & Destructor Documentation

GaborParameter() [1/2]

nest::GaborParameter::GaborParameter

(

const Dictionary &

d

)

Construct the parameter from a dictionary of arguments.

GaborParameter() [2/2]

nest::GaborParameter::GaborParameter ( const GaborParameter &  p )

inline

Copy constructor.

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::GaborParameter::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 cos_, gamma_, inv_two_std2_, lambda_, numerics::pi, psi_, px_, py_, and sin_.

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::GaborParameter::value ( RngPtr  , Node *    )

inlineoverridevirtual

Returns

the value of the parameter.

Reimplemented from nest::Parameter.

Member Data Documentation

cos_

const double nest::GaborParameter::cos_

protected

Referenced by value().

gamma_

const double nest::GaborParameter::gamma_

protected

Referenced by value().

inv_two_std2_

const double nest::GaborParameter::inv_two_std2_

protected

Referenced by value().

lambda_

const double nest::GaborParameter::lambda_

protected

Referenced by value().

psi_

const double nest::GaborParameter::psi_

protected

Referenced by value().

px_

std::shared_ptr< Parameter > const nest::GaborParameter::px_

protected

Referenced by value().

py_

std::shared_ptr< Parameter > const nest::GaborParameter::py_

protected

Referenced by value().

sin_

const double nest::GaborParameter::sin_

protected

Referenced by value().

---

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

• parameter.h
• parameter.cpp