Skip to content
Snippets Groups Projects
Commit da4d59e9 authored by leufen1's avatar leufen1
Browse files

added sample plot into docs

parent e664f716
No related branches found
No related tags found
6 merge requests!319add all changes of dev into release v1.4.0 branch,!318Resolve "release v1.4.0",!299Draft: Merge default data handler and preprocessing support parameter use_multiprocessing....,!289include plot script restructuring,!287Resolve "periodogram for kzf",!259Draft: Resolve "WRF-Datahandler should inherit from SingleStationDatahandler"
docs/_source/_plots/periodogram.png

62.3 KiB

......@@ -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",
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment