NEST  2.6.0,not_revisioned_source_dir@0
Public Member Functions | Private Attributes | List of all members
nest::GaussianParameter Class Reference

Gaussian parameter p(d) = c + p_center*exp(-(d-mean)^2/(2*sigma^2)) More...

#include <parameter.h>

Inheritance diagram for nest::GaussianParameter:
nest::RadialParameter nest::Parameter

Public Member Functions

 GaussianParameter (const DictionaryDatum &d)
 Parameters: c - constant offset p_center - value at center of gaussian mean - distance to center sigma - width of gaussian. More...
 
double_t raw_value (double_t x) const
 
Parameterclone () const
 Clone method. More...
 
- Public Member Functions inherited from nest::RadialParameter
 RadialParameter ()
 
 RadialParameter (double_t cutoff)
 
 RadialParameter (const DictionaryDatum &d)
 
double_t raw_value (const Position< 2 > &p, librandom::RngPtr &) const
 Raw value disregarding cutoff. More...
 
double_t raw_value (const Position< 3 > &p, librandom::RngPtr &) const
 Raw value disregarding cutoff. More...
 
- Public Member Functions inherited from nest::Parameter
 Parameter ()
 Default constructor. More...
 
 Parameter (double_t cutoff)
 Constructor. More...
 
 Parameter (const DictionaryDatum &d)
 Constructor Parameter that can be set in the Dictionary: cutoff - Values less than the cutoff are set to zero. More...
 
virtual ~Parameter ()
 Virtual destructor. More...
 
double_t value (const Position< 2 > &p, librandom::RngPtr &rng) const
 
double_t value (const Position< 3 > &p, librandom::RngPtr &rng) const
 
double_t value (const std::vector< double_t > &pt, librandom::RngPtr &rng) const
 
virtual Parametermultiply_parameter (const Parameter &other) const
 Create the product of this parameter with another. More...
 
virtual Parameterdivide_parameter (const Parameter &other) const
 Create the quotient of this parameter with another. More...
 
virtual Parameteradd_parameter (const Parameter &other) const
 Create the sum of this parameter with another. More...
 
virtual Parametersubtract_parameter (const Parameter &other) const
 Create the difference of this parameter with another. More...
 

Private Attributes

double_t c_
 
double_t p_center_
 
double_t mean_
 
double_t sigma_
 

Detailed Description

Gaussian parameter p(d) = c + p_center*exp(-(d-mean)^2/(2*sigma^2))

Constructor & Destructor Documentation

nest::GaussianParameter::GaussianParameter ( const DictionaryDatum d)
inline

Parameters: c - constant offset p_center - value at center of gaussian mean - distance to center sigma - width of gaussian.

References nest::names::c, c_, nest::names::d, nest::names::mean, mean_, nest::names::p_center, p_center_, nest::names::sigma, and sigma_.

Referenced by clone().

Member Function Documentation

Parameter* nest::GaussianParameter::clone ( ) const
inlinevirtual

Clone method.

Returns
dynamically allocated copy of parameter object

Implements nest::Parameter.

References GaussianParameter().

double_t nest::GaussianParameter::raw_value ( double_t  x) const
inlinevirtual

Implements nest::RadialParameter.

References c_, mean_, p_center_, and sigma_.

Member Data Documentation

double_t nest::GaussianParameter::c_
private

Referenced by GaussianParameter(), and raw_value().

double_t nest::GaussianParameter::mean_
private

Referenced by GaussianParameter(), and raw_value().

double_t nest::GaussianParameter::p_center_
private

Referenced by GaussianParameter(), and raw_value().

double_t nest::GaussianParameter::sigma_
private

Referenced by GaussianParameter(), and raw_value().


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