Improve ImageProfile class docstring
@@ -209,6 +209,11 @@ class ImageProfile(object):
* `profile` Image profile data (required).
* `profile_err` Image profile data error (optional).
+ Parameters
+ ----------
+ table : `~astropy.table.Table`
+ Table instance with the columns specified as above.
+
"""
def __init__(self, table):
self.table = table
@@ -223,7 +228,16 @@ class ImageProfile(object):
x_j = \sum_i x_{(j - i)} h_i
- Where :math:h_i are coefficients of the convolution kernel.
+ Where :math:`h_i` are the coefficients of the convolution kernel.
+
+ The corresponding error on :math:`x_j` is then estimated using Gaussian
+ error propagation, neglecting correlations between the individual
+ :math:`x_{(j - i)}`:
+
+ .. math::
+
+ \Delta x_j = \sqrt{\sum_i \Delta x^{2}_{(j - i)} h^{2}_i}
+
Parameters
----------
