add print function to data object

Author: TomDonoghue

specparam/data/data.py

@@ -9,6 +9,7 @@
 from specparam.data import SpectrumMetaData, ModelChecks
 from specparam.utils.spectral import trim_spectrum
 from specparam.utils.checks import check_input_options
+from specparam.reports.strings import gen_data_str
 from specparam.modutils.errors import DataError, InconsistentDataError
 from specparam.modutils.docs import docs_get_section, replace_docstring_sections
 from specparam.plts.settings import PLT_COLORS
@@ -162,6 +163,18 @@ def plot(self, plt_log=False, **plt_kwargs):
                      log_powers=False, **data_kwargs)
 
 
+    def print(self, concise):
+        """Print out a data summary.
+
+        Parameters
+        ----------
+        concise : bool, optional, default: False
+            Whether to print the report in a concise mode, or not.
+        """
+
+        print(gen_data_str(self, concise))
+
+
     def set_checks(self, check_freqs=None, check_data=None):
         """Set check statuses, which control if an error is raised based on check on the inputs.
 

specparam/reports/strings.py

@@ -135,23 +135,23 @@ def gen_data_str(data, concise=False):
         Formatted string of data summary.
     """
 
-    # Get number of spectra, checking attributes for {Data3D, Data2DT, Data2D, Data}
-    if getattr(data, 'n_events', None):
-        n_spectra_str = '{} spectrograms with {} windows each'.format(data.n_events, data.n_time_windows)
-    elif getattr(data, 'n_time_windows', None):
-        n_spectra_str = '1 spectrogram with {} windows'.format(data.n_time_windows)
-    elif getattr(data, 'n_spectra', None):
-        n_spectra_str = '{} power spectra'.format(data.n_spectra)
-    else:
-        n_spectra_str = '1 power spectrum'
-
     if not data.has_data:
 
         no_data_str = "No data currently loaded in the object."
         str_lst = [DIVIDER,'', no_data_str, '', DIVIDER]
 
     else:
 
+        # Get number of spectra, checking attributes for {Data3D, Data2DT, Data2D, Data}
+        if getattr(data, 'n_events', None):
+            n_spectra_str = '{} spectrograms with {} windows each'.format(data.n_events, data.n_time_windows)
+        elif getattr(data, 'n_time_windows', None):
+            n_spectra_str = '1 spectrogram with {} windows'.format(data.n_time_windows)
+        elif getattr(data, 'n_spectra', None):
+            n_spectra_str = '{} power spectra'.format(data.n_spectra)
+        else:
+            n_spectra_str = '1 power spectrum'
+
         str_lst = [
 
             DIVIDER,