diff options
Diffstat (limited to 'doc/source/modules/gui/plot/tools/profile.rst')
-rw-r--r-- | doc/source/modules/gui/plot/tools/profile.rst | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/doc/source/modules/gui/plot/tools/profile.rst b/doc/source/modules/gui/plot/tools/profile.rst new file mode 100644 index 0000000..32d8a26 --- /dev/null +++ b/doc/source/modules/gui/plot/tools/profile.rst @@ -0,0 +1,84 @@ +.. currentmodule:: silx.gui.plot.tools.profile + +:mod:`~silx.gui.plot.tools.profile`: Profile tool for PlotWidget +================================================================ + +.. automodule:: silx.gui.plot.tools.profile + +The profile package is divided into several sub-modules. + +:mod:`~silx.gui.plot.tools.profile.manager` module +-------------------------------------------------- + +.. automodule:: silx.gui.plot.tools.profile.manager + +:class:`ProfileManager` class ++++++++++++++++++++++++++++++ + +.. autoclass:: ProfileManager + :show-inheritance: + :members: + +:class:`ProfileWindow` class +++++++++++++++++++++++++++++ + +.. autoclass:: ProfileWindow + :show-inheritance: + :members: + +:mod:`~silx.gui.plot.tools.profile.editors` module +-------------------------------------------------- + +.. automodule:: silx.gui.plot.tools.profile.editors + +:class:`ProfileRoiEditorAction` class ++++++++++++++++++++++++++++++++++++++ + +.. autoclass:: ProfileRoiEditorAction + :show-inheritance: + :members: + +:mod:`~silx.gui.plot.tools.profile.core` module +----------------------------------------------- + +.. automodule:: silx.gui.plot.tools.profile.core + +:class:`ProfileRoiMixIn` class +++++++++++++++++++++++++++++++ + +.. autoclass:: ProfileRoiMixIn + :show-inheritance: + :members: + +:class:`CurveProfileData` class ++++++++++++++++++++++++++++++++ + +.. autoclass:: CurveProfileData + :show-inheritance: + :members: + + +:class:`ImageProfileData` class ++++++++++++++++++++++++++++++++ + +.. autoclass:: ImageProfileData + :show-inheritance: + :members: + +:mod:`~silx.gui.plot.tools.profile.ScatterProfileToolBar` module +---------------------------------------------------------------- + +.. automodule:: silx.gui.plot.tools.profile.ScatterProfileToolBar + +:class:`ScatterProfileToolBar` +++++++++++++++++++++++++++++++ + +.. autoclass:: ScatterProfileToolBar + :show-inheritance: + :members: + +:mod:`~silx.gui.plot.tools.profile.rois` module +----------------------------------------------- + +.. automodule:: silx.gui.plot.tools.profile.rois + |