interim updates data & results docs

Author: TomDonoghue

specparam/objs/data.py

@@ -35,6 +35,17 @@ class Data():
         If True, checks the power values and raises an error for any NaN / Inf values.
     format : {'power'}
         The representation format of the data.
+
+    Attributes
+    ----------
+    freqs : 1d array
+        Frequency values for the power spectrum.
+    power_spectrum : 1d array
+        Power values, stored internally in log10 scale.
+    freq_range : list of [float, float]
+        Frequency range of the power spectrum, as [lowest_freq, highest_freq].
+    freq_res : float
+        Frequency resolution of the power spectrum.
     """
 
     def __init__(self, check_freqs=True, check_data=True, format='power'):
@@ -278,7 +289,20 @@ def _prepare_data(self, freqs, powers, freq_range, spectra_dim=1):
 
 
 class Data2D(Data):
-    """Base object for managing data for spectral parameterization - for 2D data."""
+    """Base object for managing data for spectral parameterization - for 2D data.
+
+    Attributes
+    ----------
+    freqs : 1d array
+        Frequency values for the power spectra.
+    power_spectra : 2d array
+        Power values for the group of power spectra, as [n_power_spectra, n_freqs].
+        Power values are stored internally in log10 scale.
+    freq_range : list of [float, float]
+        Frequency range of the power spectra, as [lowest_freq, highest_freq].
+    freq_res : float
+        Frequency resolution of the power spectra.
+    """
 
     def __init__(self):
         """Initialize Data2D object."""
@@ -362,7 +386,20 @@ def decorated(*args, **kwargs):
 
 
 class Data2DT(Data2D):
-    """Base object for managing data for spectral parameterization - for 2D transposed data."""
+    """Base object for managing data for spectral parameterization - for 2D transposed data.
+
+    Attributes
+    ----------
+    freqs : 1d array
+        Frequency values for the spectrogram.
+    spectrogram : 2d array
+        Power values for the spectrogram, as [n_freqs, n_time_windows].
+        Power values are stored internally in log10 scale.
+    freq_range : list of [float, float]
+        Frequency range of the spectrogram, as [lowest_freq, highest_freq].
+    freq_res : float
+        Frequency resolution of the spectrogram.
+    """
 
     def __init__(self):
         """Initialize Data2DT object."""
@@ -415,7 +452,20 @@ def plot(self, **plt_kwargs):
 
 
 class Data3D(Data2DT):
-    """Base object for managing data for spectral parameterization - for 3D data."""
+    """Base object for managing data for spectral parameterization - for 3D data.
+
+    Attributes
+    ----------
+    freqs : 1d array
+        Frequency values for the power spectra.
+    spectrograms : 3d array
+        Power values for the spectrograms, organized as [n_events, n_freqs, n_time_windows].
+        Power values are stored internally in log10 scale.
+    freq_range : list of [float, float]
+        Frequency range of the power spectra, as [lowest_freq, highest_freq].
+    freq_res : float
+        Frequency resolution of the power spectra.
+    """
 
     def __init__(self):
         """Initialize Data3D object."""

specparam/objs/results.py

@@ -11,6 +11,7 @@
 from specparam.utils.array import unlog
 from specparam.utils.checks import check_inds, check_array_dim
 from specparam.modutils.errors import NoModelError
+from specparam.modutils.docs import docs_get_section, replace_docstring_sections
 from specparam.data.data import FitResults
 from specparam.data.conversions import group_to_dict, event_group_to_dict
 from specparam.data.utils import (get_model_params, get_group_params,
@@ -26,7 +27,17 @@
 
 
 class Results():
-    """Object for managing results - base / 1D version."""
+    """Object for managing results - base / 1D version.
+
+    Parameters
+    ----------
+    modes : Modes
+        Modes object with fit mode definitions.
+    metrics : Metrics
+        Metrics object with metric definitions.
+    bands : bands
+        Bands object with band definitions.
+    """
     # pylint: disable=attribute-defined-outside-init, arguments-differ
 
     def __init__(self, modes=None, metrics=None, bands=None):
@@ -294,8 +305,14 @@ def _regenerate_model(self, freqs):
             return_components=True)
 
 
+@replace_docstring_sections([docs_get_section(Results.__doc__, 'Parameters')])
 class Results2D(Results):
-    """Object for managing results - 2D version."""
+    """Object for managing results - 2D version.
+
+    Parameters
+    ----------
+    % copied in from Results
+    """
 
     def __init__(self, modes=None, metrics=None, bands=None):
         """Initialize Results2D object."""
@@ -457,8 +474,14 @@ def get_params(self, name, field=None):
         return get_group_params(self.group_results, self.modes, name, field)
 
 
+@replace_docstring_sections([docs_get_section(Results.__doc__, 'Parameters')])
 class Results2DT(Results2D):
-    """Object for managing results - 2D transpose version."""
+    """Object for managing results - 2D transpose version.
+
+    Parameters
+    ----------
+    % copied in from Results
+    """
 
     def __init__(self, modes=None, metrics=None, bands=None):
         """Initialize Results2DT object."""
@@ -510,8 +533,14 @@ def convert_results(self):
         self.time_results = group_to_dict(self.group_results, self.modes, self.bands)
 
 
+@replace_docstring_sections([docs_get_section(Results.__doc__, 'Parameters')])
 class Results3D(Results2DT):
-    """Object for managing results - 3D version."""
+    """Object for managing results - 3D version.
+
+    Parameters
+    ----------
+    % copied in from Results
+    """
 
     def __init__(self, modes=None, metrics=None, bands=None):
         """Initialize Results3D object."""