Skip to content

Commit

Permalink
Fix protopipe.perf.temp docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
HealthyPear committed May 12, 2021
1 parent f227397 commit b4026f3
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions protopipe/perf/temp.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ def energy_bias_resolution(
):
"""
Calculate bias and energy resolution.
Parameters
----------
events: astropy.table.QTable
Expand All @@ -31,6 +32,7 @@ def energy_bias_resolution(
Function used to calculate the energy bias
resolution_function: callable
Function used to calculate the energy resolution
Returns
-------
result : astropy.table.Table
Expand Down Expand Up @@ -77,8 +79,10 @@ def angular_resolution(
):
"""
Calculate the angular resolution.
This implementation corresponds to the 68% containment of the angular
distance distribution.
Parameters
----------
events : astropy.table.QTable
Expand All @@ -88,11 +92,12 @@ def angular_resolution(
energy_type: str
Either "true" or "reco" energy.
Default is "true".
Returns
-------
result : astropy.table.Table
Table containing the 68% containment of the angular
distance distribution per each reconstructed energy bin.
Table containing the 68% containment of the angular distance
distribution per each reconstructed energy bin.
"""

ONE_SIGMA_QUANTILE = norm.cdf(1) - norm.cdf(-1)
Expand Down

0 comments on commit b4026f3

Please sign in to comment.