#include <delta_sigma.hpp>

Public Member Functions
Real	alpha () const

Real	sigma () const

Real	step () const

Real	integral () const

Real	integral_to_zero () const

Real	limit (Real eps=DEFAULT_EPS) const

size_t	size () const

Real	operator[] (size_t i) const

auto	begin () const

auto	end () const

Static Public Member Functions
template<typename Window >
static DiscreteWindow	create_manual (Real alpha, Real sigma, Real step=DEFAULT_STEP, Real eps=DEFAULT_EPS)

template<typename Window >
static DiscreteWindow	create (Real min_spike_interval=DEFAULT_MIN_SPIKE_INTERVAL, Real response_time=DEFAULT_RESPONSE_TIME, Real step=DEFAULT_STEP, Real eps=DEFAULT_EPS)

Detailed Description

Class representing a discretised window function.

Member Function Documentation

Real cypress::nef::DeltaSigma::DiscreteWindow::alpha ( ) const

inline

Returns the used scaling factor.

auto cypress::nef::DeltaSigma::DiscreteWindow::begin ( ) const

inline

Returns a constant iterator allowing to access the first sample.

template<typename Window >

static DiscreteWindow cypress::nef::DeltaSigma::DiscreteWindow::create	(	Real	min_spike_interval = `DEFAULT_MIN_SPIKE_INTERVAL`,
		Real	response_time = `DEFAULT_RESPONSE_TIME`,
		Real	step = `DEFAULT_STEP`,
		Real	eps = `DEFAULT_EPS`
	)

static

Creates a DiscreteWindow with automatically chosen parameters matching

Parameters

min_spike_interval	is the minimum interval in which two spikes may occur. This parameter controls the scaling of the window function values.
response_time	controls the minimum response time that can be encoded using the spike-train representation at the cost of the value resolution.
step	is the discretisation time step.
eps	controls the minimum value that should be stored in the discretised window.

template<typename Window >

static DiscreteWindow cypress::nef::DeltaSigma::DiscreteWindow::create_manual	(	Real	alpha,
		Real	sigma,
		Real	step = `DEFAULT_STEP`,
		Real	eps = `DEFAULT_EPS`
	)

static

Constructor of the DiscreteWindow class. Discretises the window given as template parameter.

Parameters

alpha	is a scale factor the samples are scaled by.
sigma	is the standard deviation determining the x-axis scale.
step	is the sampling interval.
eps	is the epsilon determining up to which value the window is sampled.

auto cypress::nef::DeltaSigma::DiscreteWindow::end ( ) const

inline

Returns an iterator pointing at the last-plus-one sample.

Real cypress::nef::DeltaSigma::DiscreteWindow::integral ( ) const

inline

Returns the integral of the window function from minus infinity to plus infinity. Multiply the result with the standard deviation to get values for standard-deviations other than one.

Real cypress::nef::DeltaSigma::DiscreteWindow::integral_to_zero ( ) const

inline

Returns the integral of the window function from minus infinity to zero.

Real cypress::nef::DeltaSigma::DiscreteWindow::limit ( Real eps = DEFAULT_EPS ) const

inline

Returns the number of samples until the value of the window function reaches "epsilon". Multiply the result with the standard deviation to get values for standard-deviations other than one.

Real cypress::nef::DeltaSigma::DiscreteWindow::operator[] ( size_t i ) const

inline

Returns the value of the i-th sample.

Real cypress::nef::DeltaSigma::DiscreteWindow::sigma ( ) const

inline

Returns the used standard deviation/width of the window.

size_t cypress::nef::DeltaSigma::DiscreteWindow::size ( ) const

inline

Returns the number of samples stored in the window.

Real cypress::nef::DeltaSigma::DiscreteWindow::step ( ) const

inline

Returns the sample interval.

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

cypress/nef/delta_sigma.hpp

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation