Skip to content

Commit

Permalink
More documentation for "sample frequency"
Browse files Browse the repository at this point in the history
It turns out "sample frequency" is actually the number of samples per
channel/signal in EDFlib:
https://www.teuniz.net/edflib/doc/edflib_8h.html#a11d03849cecc17a2599125a1a102b69e

We inherit this strange definition, and need to explain it.
  • Loading branch information
DimitriPapadopoulos committed Jul 3, 2023
1 parent b7e4c34 commit 8d8944b
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions pyedflib/edfreader.py
Original file line number Diff line number Diff line change
Expand Up @@ -370,11 +370,10 @@ def getStartdatetime(self):

def getBirthdate(self, string=True):
"""
Returns the birthdate as string object
Returns the birthdate as a string.
Parameters
----------
None
Examples
--------
Expand All @@ -393,7 +392,9 @@ def getBirthdate(self, string=True):

def getSampleFrequencies(self):
"""
Returns samplefrequencies of all signals.
Returns the number of samples for all channels.
The effective sample frequency is samplefrequency / duration.
Parameters
----------
Expand All @@ -413,7 +414,9 @@ def getSampleFrequencies(self):

def getSampleFrequency(self, chn):
"""
Returns the samplefrequency of signal edfsignal.
Returns the number of samples in given channel.
The effective sample frequency is samplefrequency / duration.
Parameters
----------
Expand Down

0 comments on commit 8d8944b

Please sign in to comment.