Calculation of the spike-triggered phase and amplitude #121
Conversation
|
I this the code covers the basic requirements and the tests work on my side. The code I used for calculating was partially overlapping with the current STA implementation at that time since collection the individual phases at the spike time is similar to collecting the LFP values at the spike times. I suggest to adjust the behaviour of the spike_triggered_phase function to make it more similar to the sta in terms of reordering the arguments. Do you think it makes sense to include a 'window' option in the future? In that case the code would be again partially similar to the STA implementation (lines 150-165). |
|
I think adding a window option is something to discuss -- however, maybe this should be modularized, such that there is a common way in which all such functions handle the cutting. Raised an issue #151. |
elephant/phase_analysis.py
Outdated
| """ | ||
|
|
||
| # Convert inputs to lists | ||
| if type(spiketrains) is not list: |
There was a problem hiding this comment.
For type comparision please use instanceof
elephant/phase_analysis.py
Outdated
| >>> f_sampling = 1 * pq.ms | ||
| >>> tlen = 100 * pq.s | ||
| >>> time_axis = np.arange( | ||
| 0, tlen.rescale(pq.s).magnitude, |
There was a problem hiding this comment.
In the example you do not need to resacle.
elephant/phase_analysis.py
Outdated
| start = [elem.t_start for elem in hilbert_transform] | ||
| stop = [elem.t_stop for elem in hilbert_transform] | ||
|
|
||
| result_phases = [[] for _ in range(num_spiketrains)] |
There was a problem hiding this comment.
Do you need to create empty lists? Can't you use later on extend or just numpy arrays while intializing?
elephant/phase_analysis.py
Outdated
| for i, entry in enumerate(result_times): | ||
| result_times[i] = pq.Quantity(entry, units=entry[0].units).flatten() | ||
|
|
||
| return (result_phases, result_amps, result_times) |
There was a problem hiding this comment.
You can remove redundant brackets.
This is a first contribution towards tools to work with measures based on phase synchronization analysis. This function extracts the phase and amplitude of a signal at the times of spikes.
The function could use more unit tests, and there is certainly a lot of room for optimization, but before continuing I would like to know if this function would cover the required basic functionality?
@JuliaSprenger I think you may have similar code -- could you check in how far this is similar in functionality?