C++ API reference

class ConvolvedSpikeTrain

A class representing a single-unit spike train for which several helper vectors relating to a Van Rossum-like exponential convolution have been calculated.

Public Functions

ConvolvedSpikeTrain()

Default constructor.

ConvolvedSpikeTrain(std::vector<double> spikes, double tau)

Constructor accepting a spike train.

Parameters
  • spikes: A vector of spike times.
  • tau: Time scale for the exponential kernel. There is a limit to how small tau can be compared to the absolute value of the spike times. An exception will be raised if this limit is exceeded; its value is system-dependent, but as a rule of thumb tau and the spike times should be within 4 orders of magnitude of each other.

Warning

doxygenfunction: Unable to resolve multiple matches for function “distance” with arguments (std::vector< std::vector< ConvolvedSpikeTrain > > &, double, double **) in doxygen xml output for project “pymuvr” from directory: _doxygen/xml. Potential matches:

- void distance(std::vector<std::vector<ConvolvedSpikeTrain>>&, double, double **)
- void distance(std::vector<std::vector<ConvolvedSpikeTrain>>&, std::vector<std::vector<ConvolvedSpikeTrain>>&, double, double **)

Warning

doxygenfunction: Unable to resolve multiple matches for function “distance” with arguments (std::vector< std::vector< ConvolvedSpikeTrain > > &, std::vector< std::vector< ConvolvedSpikeTrain > > &, double, double **) in doxygen xml output for project “pymuvr” from directory: _doxygen/xml. Potential matches:

- void distance(std::vector<std::vector<ConvolvedSpikeTrain>>&, double, double **)
- void distance(std::vector<std::vector<ConvolvedSpikeTrain>>&, std::vector<std::vector<ConvolvedSpikeTrain>>&, double, double **)

Warning

doxygenfunction: Unable to resolve multiple matches for function “inner_product” with arguments (std::vector< std::vector< ConvolvedSpikeTrain > > &, double, double **) in doxygen xml output for project “pymuvr” from directory: _doxygen/xml. Potential matches:

- void inner_product(std::vector<std::vector<ConvolvedSpikeTrain>>&, double, double **)
- void inner_product(std::vector<std::vector<ConvolvedSpikeTrain>>&, std::vector<std::vector<ConvolvedSpikeTrain>>&, double, double **)

Warning

doxygenfunction: Unable to resolve multiple matches for function “inner_product” with arguments (std::vector< std::vector< ConvolvedSpikeTrain > > &, std::vector< std::vector< ConvolvedSpikeTrain > > &, double, double **) in doxygen xml output for project “pymuvr” from directory: _doxygen/xml. Potential matches:

- void inner_product(std::vector<std::vector<ConvolvedSpikeTrain>>&, double, double **)
- void inner_product(std::vector<std::vector<ConvolvedSpikeTrain>>&, std::vector<std::vector<ConvolvedSpikeTrain>>&, double, double **)