elephant.current_source_density.generate_lfp

elephant.current_source_density.generate_lfp(csd_profile, x_positions, y_positions=None, z_positions=None, x_limits=[0.0, 1.0], y_limits=[0.0, 1.0], z_limits=[0.0, 1.0], resolution=50)

Forward modelling for getting the potentials for testing Current Source Density (CSD).

Parameters:

csd_profilecallable

A function that computes true CSD profile. Available options are (see ./csd/utility_functions.py) 1D : gauss_1d_dipole 2D : large_source_2D and small_source_2D 3D : gauss_3d_dipole

x_positionsnp.ndarray

Positions of the x coordinates of the electrodes

y_positionsnp.ndarray, optional

Positions of the y coordinates of the electrodes Defaults to None, use in 2D or 3D cases only

z_positionsnp.ndarray, optional

Positions of the z coordinates of the electrodes Defaults to None, use in 3D case only

x_limitslist, optional

A list of [start, end]. The starting spatial coordinate and the ending for integration Defaults to [0.,1.]

y_limitslist, optional

A list of [start, end]. The starting spatial coordinate and the ending for integration Defaults to [0.,1.], use only in 2D and 3D case

z_limitslist, optional

A list of [start, end]. The starting spatial coordinate and the ending for integration Defaults to [0.,1.], use only in 3D case

resolutionint, optional

The resolution of the integration Defaults to 50

Returns:

LFPneo.AnalogSignal

The potentials created by the csd profile at the electrode positions. The electrode positions are attached as RecordingChannel’s coordinate.