docstring edits

legend-exp · Apr 26, 2024 · 39cf4d3 · 39cf4d3
1 parent b7d2829
commit 39cf4d3
Showing 1 changed file with 70 additions and 72 deletions.
diff --git a/src/pygama/pargen/data_cleaning.py b/src/pygama/pargen/data_cleaning.py
@@ -373,44 +373,44 @@ def generate_cuts(
     Parameters
     ----------
     data : lh5 table, dictionary of arrays or pandas dataframe
-                data to calculate cuts on
+        data to calculate cuts on
     parameters : dict
-                dictionary of the form:
-                {
-                    "output_parameter_name": {
-                        "cut_parameter": "parameter_to_cut_on",
-                        "cut_level": number_of_sigmas,
-                        "mode": "inclusive" or "exclusive"
-                    }
-                }
-                number of sigmas can instead be a dictionary to specify different cut levels for low and high side
-                or to only have a one sided cut only specify one of the low or high side
-                e.g.
-                {
-                    "output_parameter_name": {
-                        "cut_parameter": "parameter_to_cut_on",
-                        "cut_level": {"low_side": 3, "high_side": 2},
-                        "mode": "inclusive" or "exclusive"
-                    }
-                }
-                alternatively can specify hit dict fields to just copy dict into output dict e.g.
-                {
-                    "is_valid_t0":{
-                        "expression":"(tp_0_est>a)&(tp_0_est<b)",
-                        "parameters":{"a":46000, "b":52000}
-                    }
-                }
-                or
-                {
-                    "is_valid_cal":{
-                        "expression":"(~is_pileup_tail)&(~is_pileup_baseline)"
-                    }
-                }
+        dictionary of the form:
+        {
+            "output_parameter_name": {
+                "cut_parameter": "parameter_to_cut_on",
+                "cut_level": number_of_sigmas,
+                "mode": "inclusive" or "exclusive"
+            }
+        }
+        number of sigmas can instead be a dictionary to specify different cut levels for low and high side
+        or to only have a one sided cut only specify one of the low or high side
+        e.g.
+        {
+            "output_parameter_name": {
+                "cut_parameter": "parameter_to_cut_on",
+                "cut_level": {"low_side": 3, "high_side": 2},
+                "mode": "inclusive" or "exclusive"
+            }
+        }
+        alternatively can specify hit dict fields to just copy dict into output dict e.g.
+        {
+            "is_valid_t0":{
+                "expression":"(tp_0_est>a)&(tp_0_est<b)",
+                "parameters":{"a":46000, "b":52000}
+            }
+        }
+        or
+        {
+            "is_valid_cal":{
+                "expression":"(~is_pileup_tail)&(~is_pileup_baseline)"
+            }
+        }
     rounding : int
-                number of decimal places to round to
+        number of decimal places to round to
     display : int
-                if 1 will display plots of the cuts
-                if 0 will not display plots
+        if 1 will display plots of the cuts
+        if 0 will not display plots
 
     Returns
     -------
@@ -424,7 +424,6 @@ def generate_cuts(
         }
     plot_dict
         dictionary of plots
-
     """
 
     output_dict = {}
@@ -566,44 +565,44 @@ def generate_cut_classifiers(
     Parameters
     ----------
     data : lh5 table, dictionary of arrays or pandas dataframe
-                data to calculate cuts on
+        data to calculate cuts on
     parameters : dict
-                dictionary of the form:
-                {
-                    "output_parameter_name": {
-                        "cut_parameter": "parameter_to_cut_on",
-                        "cut_level": number_of_sigmas,
-                        "mode": "inclusive" or "exclusive"
-                    }
-                }
-                number of sigmas can instead be a dictionary to specify different cut levels for low and high side
-                or to only have a one sided cut only specify one of the low or high side
-                e.g.
-                {
-                    "output_parameter_name": {
-                        "cut_parameter": "parameter_to_cut_on",
-                        "cut_level": {"low_side": 3, "high_side": 2},
-                        "mode": "inclusive" or "exclusive"
-                    }
-                }
-                alternatively can specify hit dict fields to just copy dict into output dict e.g.
-                {
-                    "is_valid_t0":{
-                        "expression":"(tp_0_est>a)&(tp_0_est<b)",
-                        "parameters":{"a":46000, "b":52000}
-                    }
-                }
-                or
-                {
-                    "is_valid_cal":{
-                        "expression":"(~is_pileup_tail)&(~is_pileup_baseline)"
-                    }
-                }
+        dictionary of the form:
+        {
+            "output_parameter_name": {
+                "cut_parameter": "parameter_to_cut_on",
+                "cut_level": number_of_sigmas,
+                 "mode": "inclusive" or "exclusive"
+            }
+        }
+        number of sigmas can instead be a dictionary to specify different cut levels for low and high side
+        or to only have a one sided cut only specify one of the low or high side
+        e.g.
+        {
+            "output_parameter_name": {
+                "cut_parameter": "parameter_to_cut_on",
+                "cut_level": {"low_side": 3, "high_side": 2},
+                "mode": "inclusive" or "exclusive"
+            }
+        }
+        alternatively can specify hit dict fields to just copy dict into output dict e.g.
+        {
+            "is_valid_t0":{
+                "expression":"(tp_0_est>a)&(tp_0_est<b)",
+                "parameters":{"a":46000, "b":52000}
+            }
+        }
+        or
+        {
+            "is_valid_cal":{
+                "expression":"(~is_pileup_tail)&(~is_pileup_baseline)"
+            }
+        }
     rounding : int
-                number of decimal places to round to
+        number of decimal places to round to
     display : int
-                if 1 will display plots of the cuts
-                if 0 will not display plots
+        if 1 will display plots of the cuts
+        if 0 will not display plots
 
     Returns
     -------
@@ -617,7 +616,6 @@ def generate_cut_classifiers(
         }
     plot_dict
         dictionary of plots
-
     """
 
     output_dict = {}