marcel/pylot
3
0
Fork 0
Code Issues 7 Pull Requests 1 Releases Wiki Activity

completition of Docstring

Browse Source
This commit is contained in:
sebastianp 2016-02-03 14:35:07 +01:00
parent 8893a8ec6b
commit 8f6f6cf8b6
1 changed files with 16 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
pylot/core/analysis/correlation.py
View File

@ -6,11 +6,15 @@ import numpy as np
def crosscorrsingle(wf1, wf2, taumax): def crosscorrsingle(wf1, wf2, taumax):
''' '''
Calculates the crosscorrelation between two waveforms with a defined maximum timedifference.
:param Wx: :param wf1: first waveformdata
:param Wy: :type wf1: list
:param taumax: :param wf2: second waveformdata
:return: :type wf2: list
:param taumax: maximum time difference between waveforms
:type taumax: positive integer
:return: returns the crosscorrelation funktion 'c' and the lagvector 'l'
:rtype: c and l are lists
''' '''
N = len(wf1) N = len(wf1)
c = np.zeros(2 * taumax - 1) c = np.zeros(2 * taumax - 1)
@ -83,10 +87,13 @@ def wfscrosscorr(weights, wfs, taumax):
SWB 26.01.2010 as arranged with Thomas Meier and Monika Bischoff SWB 26.01.2010 as arranged with Thomas Meier and Monika Bischoff
:param weights: :param weights: weighting factors for the single components
:param wfs: :type weights: tuple
:param taumax: :param wfs: tuple of `~numpy.array` object containing waveform data
:return: :type wfs: tuple
:param taumax: maximum time difference
:type taumax: positive integer
:return: returns cross correlation function normalized by the waveform energy
''' '''
ccnorm = 0. ccnorm = 0.