Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ggmarshall committed Jan 13, 2025
1 parent 5ca3dff commit e368a56
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions src/pygama/pargen/AoE_cal.py
Original file line number Diff line number Diff line change
Expand Up @@ -693,8 +693,8 @@ def __init__(
dep_correct: bool
Whether to correct the double escape peak into the single site band before cut determination
dt_cut: dict
Dictionary of the drift time cut parameters in the form:
{"out_param": "dt_cut", "hard": False}
Dictionary of the drift time cut parameters in the form::
{"out_param": "dt_cut", "hard": False}
where the out_param is the name of the parameter to cut on in the dataframe (should have been precalculated)
and "hard" is whether to remove these events completely for survival fraction calculations
or whether they they should only be removed in the cut determination/ A/E calibration steps
Expand Down Expand Up @@ -777,8 +777,8 @@ def time_correction(
none: just use the mean of the a/e centroids to shift all the data
partial: iterate through the centroids if vary by less than 0.4 sigma
then group and take mean otherwise when a run higher than 0.4 sigma
is found if it is a single run set to nan otherwise start a new block
then group and take mean otherwise when a run higher than 0.4 sigma
is found if it is a single run set to nan otherwise start a new block
full : each run will be corrected individually
average_consecutive: average the consecutive centroids
interpolate_consecutive: interpolate between the consecutive centroids
Expand All @@ -787,6 +787,7 @@ def time_correction(
be added to the calibration dictionary
display: int
plot level
"""
log.info("Starting A/E time correction")
self.timecorr_df = pd.DataFrame()
Expand Down Expand Up @@ -1070,6 +1071,7 @@ def drift_time_correction(
be added to the calibration dictionary
display: int
plot level
"""
log.info("Starting A/E drift time correction")
self.dt_res_dict = {}
Expand Down Expand Up @@ -1512,6 +1514,7 @@ def get_aoe_cut_fit(
be added to the calibration dictionary
display: int
plot level
"""

log.info("Starting A/E low cut determination")
Expand Down Expand Up @@ -1628,6 +1631,7 @@ def calculate_survival_fractions_sweep(
mode: str
mode to use for the cut determination, can be "greater" or "less" i.e. do we want to
keep events with A/E greater or less than the cut value
"""
sfs = pd.DataFrame()
peak_dfs = {}
Expand Down Expand Up @@ -1744,6 +1748,7 @@ def calculate_survival_fractions(
mode: str
mode to use for the cut determination, can be "greater" or "less" i.e. do we want to
keep events with A/E greater or less than the cut value
"""
sfs = pd.DataFrame()
for i, peak in enumerate(peaks):
Expand Down

0 comments on commit e368a56

Please sign in to comment.