diff --git a/docs/_source/_plots/periodogram.png b/docs/_source/_plots/periodogram.png new file mode 100644 index 0000000000000000000000000000000000000000..a756cffab18869f615ff504303f2743618f14633 Binary files /dev/null and b/docs/_source/_plots/periodogram.png differ diff --git a/mlair/plotting/data_insight_plotting.py b/mlair/plotting/data_insight_plotting.py index 79c26522b90fa28391c4b358c125c90a199a345a..da1448763e73b2c1c90a58e4bb46e11bc7142a97 100644 --- a/mlair/plotting/data_insight_plotting.py +++ b/mlair/plotting/data_insight_plotting.py @@ -456,7 +456,17 @@ class PlotPeriodogram(AbstractPlotClass): # pragma: no cover If data consists on different sampling rates, a separate plot is create for each sampling. - To work properly, the data handler must have the attribute `.id_class._data`. + .. image:: ../../../../../_source/_plots/periodogram.png + :width: 400 + + .. note:: + This plot is not included in the default plot list. To use this plot, add "PlotPeriodogram" to the `plot_list`. + + .. warning:: + This plot is highly sensitive to the data handler structure. Therefore, it is highly likely that this method is + not compatible with any custom data handler. Proven data handlers are `DefaultDataHandler`, + `DataHandlerMixedSampling`, `DataHandlerMixedSamplingWithFilter`. To work properly, the data handler must have + the attribute `.id_class._data`. """ def __init__(self, generator: Dict[str, DataCollection], plot_folder: str = ".", plot_name="periodogram",