Skip to content

Commit

Permalink
Docs: fix docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
tritemio committed Mar 24, 2015
1 parent 1fe5947 commit 25c5691
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions fretbursts/select_bursts.py
Original file line number Diff line number Diff line change
Expand Up @@ -147,17 +147,17 @@ def sbr(d, ich=0, th1=0, th2=np.inf):
return bursts_mask, ''

def peak_phrate(d, ich=0, th1=0, th2=np.inf):
"""Select bursts with peak phtotons rate between th1 and th2 (ms).
"""Select bursts with peak phtotons rate between th1 and th2 (cps).
Note that this function requires to compute the peak photon rate
first using :meth:`frebursts.burstlib.Data.calc_max_rate`.
first using :meth:`fretbursts.burstlib.Data.calc_max_rate`.
"""
rate = d.max_rate[ich]
mask = (rate >= th1)*(rate <= th2)
return mask, ''

def brightness(d, ich=0, th1=0, th2=np.inf, add_naa=False, gamma=1):
"""Select bursts with size/width between th1 and th2 (ms).
"""Select bursts with size/width between th1 and th2 (cps).
"""
sizes = d.burst_sizes(gamma=gamma, add_naa=add_naa)[ich]
brightness = sizes/d.burst_widths[ich]
Expand Down

0 comments on commit 25c5691

Please sign in to comment.