Skip to content

Commit

Permalink
fixed docstring issue
Browse files Browse the repository at this point in the history
  • Loading branch information
SamuelBorden committed Feb 15, 2024
1 parent 0184396 commit fc629e2
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions src/pygama/pargen/extract_tau.py
Original file line number Diff line number Diff line change
Expand Up @@ -134,11 +134,14 @@ def get_dpz_decay_constants(
) -> tuple[dict, dict]:
"""
Gets values for the DPZ time constants in 3 stages:
1. Perform a linear fit to the start and end of the decaying tail of a superpulse
2. Use those initial guesses to seed a LSQ fit to a DPZ model of the sum of two decaying exponentials
3. Use the results of the model fit as initial guesses in a DSP routine that optimizes the flatness of the decaying tail
1. Perform a linear fit to the start and end of the decaying tail of a superpulse
2. Use those initial guesses to seed a LSQ fit to a DPZ model of the sum of two decaying exponentials
3. Use the results of the model fit as initial guesses in a DSP routine that optimizes the flatness of the decaying tail
The first step in this process is to generate a superpulse from high-energy waveforms.
Parameters
----------
tb_data
Expand All @@ -162,16 +165,18 @@ def get_dpz_decay_constants(
display
An integer. If greater than 1, plots and shows the attempts to fit the long and short time constants. If greater than 0, saves the plot to a dictionary.
Returns
-------
tau_dict
dictionary of form {'dpz': {'tau1': decay_constant1, 'tau2': decay_constant2, 'frac': fraction}}
out_plot_dict
A dictionary containing monitoring plots
Notes
-----
tau1 is the shorter time constant, tau2 is the longer, and frac is the amount of the larger time constant present in the sum of the two exponentials.
tau1 is the shorter time constant, tau2 is the longer, and frac is the amount of the larger time constant present in the sum of the two exponentials
"""
n_events = 10000
tau_dict = {}
Expand Down

0 comments on commit fc629e2

Please sign in to comment.