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

Bivariate Gaussian parameter p(x,y) = c + p_center*exp( -( (x-mean_x)^2/sigma_x^2 + (y-mean_y)^2/sigma_y^2. More...

#include <parameter.h>

Inheritance diagram for nest::Gaussian2DParameter:
nest::Parameter

Public Member Functions

 Gaussian2DParameter (const DictionaryDatum &d)
 Parameters: c - constant offset p_center - value at center mean_x - x-coordinate of center mean_y - y-coordinate of center sigma_x - width in x-direction sigma_y - width in y-direction rho - correlation of x and y. More...
 
double_t raw_value (const Position< 2 > &pos, librandom::RngPtr &) const
 Raw value disregarding cutoff. More...
 
double_t raw_value (const Position< 3 > &pos, librandom::RngPtr &rng) const
 Raw value disregarding cutoff. More...
 
Parameterclone () const
 Clone method. 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_x_
 
double_t sigma_x_
 
double_t mean_y_
 
double_t sigma_y_
 
double_t rho_
 

Detailed Description

Bivariate Gaussian parameter p(x,y) = c + p_center*exp( -( (x-mean_x)^2/sigma_x^2 + (y-mean_y)^2/sigma_y^2.

Constructor & Destructor Documentation

nest::Gaussian2DParameter::Gaussian2DParameter ( const DictionaryDatum d)

Parameters: c - constant offset p_center - value at center mean_x - x-coordinate of center mean_y - y-coordinate of center sigma_x - width in x-direction sigma_y - width in y-direction rho - correlation of x and y.

References nest::names::c, c_, nest::names::d, nest::names::mean_x, mean_x_, nest::names::mean_y, mean_y_, nest::names::p_center, p_center_, nest::names::rho, rho_, nest::names::sigma_x, sigma_x_, nest::names::sigma_y, and sigma_y_.

Referenced by clone().

Member Function Documentation

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

Clone method.

Returns
dynamically allocated copy of parameter object

Implements nest::Parameter.

References Gaussian2DParameter().

double_t nest::Gaussian2DParameter::raw_value ( const Position< 2 > &  ,
librandom::RngPtr  
) const
inlinevirtual

Raw value disregarding cutoff.

Returns
the value of the parameter at the given point.

Reimplemented from nest::Parameter.

References c_, mean_x_, mean_y_, p_center_, rho_, sigma_x_, and sigma_y_.

Referenced by raw_value().

double_t nest::Gaussian2DParameter::raw_value ( const Position< 3 > &  ,
librandom::RngPtr  
) const
inlinevirtual

Raw value disregarding cutoff.

Returns
the value of the parameter at the given point.

Reimplemented from nest::Parameter.

References raw_value().

Member Data Documentation

double_t nest::Gaussian2DParameter::c_
private

Referenced by Gaussian2DParameter(), and raw_value().

double_t nest::Gaussian2DParameter::mean_x_
private

Referenced by Gaussian2DParameter(), and raw_value().

double_t nest::Gaussian2DParameter::mean_y_
private

Referenced by Gaussian2DParameter(), and raw_value().

double_t nest::Gaussian2DParameter::p_center_
private

Referenced by Gaussian2DParameter(), and raw_value().

double_t nest::Gaussian2DParameter::rho_
private

Referenced by Gaussian2DParameter(), and raw_value().

double_t nest::Gaussian2DParameter::sigma_x_
private

Referenced by Gaussian2DParameter(), and raw_value().

double_t nest::Gaussian2DParameter::sigma_y_
private

Referenced by Gaussian2DParameter(), and raw_value().


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