From 87fc82bc5f9aa4c88ee35e91c8b962ee11c1dd28 Mon Sep 17 00:00:00 2001 From: ggmarshall Date: Mon, 13 Jan 2025 17:10:40 +0100 Subject: [PATCH] fix docs --- src/pygama/pargen/AoE_cal.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/pygama/pargen/AoE_cal.py b/src/pygama/pargen/AoE_cal.py index 5370848b2..6d85d9aea 100644 --- a/src/pygama/pargen/AoE_cal.py +++ b/src/pygama/pargen/AoE_cal.py @@ -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 @@ -774,11 +774,11 @@ def time_correction( Name of the A/E parameter to use mode: str Mode to use for the time correction, can be "full", "partial" or "none": - + 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