diff options
Diffstat (limited to 'doc/source/modules/math')
| -rw-r--r-- | doc/source/modules/math/combo.rst | 8 | ||||
| -rw-r--r-- | doc/source/modules/math/fit/bgtheories.rst | 10 | ||||
| -rw-r--r-- | doc/source/modules/math/fit/filters.rst | 18 | ||||
| -rw-r--r-- | doc/source/modules/math/fit/fitmanager.rst | 18 | ||||
| -rw-r--r-- | doc/source/modules/math/fit/fittheories.rst | 8 | ||||
| -rw-r--r-- | doc/source/modules/math/fit/fittheory.rst | 8 | ||||
| -rw-r--r-- | doc/source/modules/math/fit/functions.rst | 26 | ||||
| -rw-r--r-- | doc/source/modules/math/fit/index.rst | 25 | ||||
| -rw-r--r-- | doc/source/modules/math/fit/leastsq.rst | 16 | ||||
| -rw-r--r-- | doc/source/modules/math/fit/peaksearch.rst | 10 | ||||
| -rw-r--r-- | doc/source/modules/math/histogram.rst | 21 | ||||
| -rw-r--r-- | doc/source/modules/math/index.rst | 13 | ||||
| -rw-r--r-- | doc/source/modules/math/medianfilter.rst | 11 |
13 files changed, 192 insertions, 0 deletions
diff --git a/doc/source/modules/math/combo.rst b/doc/source/modules/math/combo.rst new file mode 100644 index 0000000..4d1b5c6 --- /dev/null +++ b/doc/source/modules/math/combo.rst @@ -0,0 +1,8 @@ +.. currentmodule:: silx.math + +:mod:`silx.math.combo`: Statistics combo functions +-------------------------------------------------- + +.. automodule:: silx.math.combo + +.. autofunction:: min_max diff --git a/doc/source/modules/math/fit/bgtheories.rst b/doc/source/modules/math/fit/bgtheories.rst new file mode 100644 index 0000000..5c6994a --- /dev/null +++ b/doc/source/modules/math/fit/bgtheories.rst @@ -0,0 +1,10 @@ + +.. currentmodule:: silx.math.fit + +See :mod:`fittheories` and :mod:`fittheory` for additional information. + +:mod:`bgtheories`: Background theories for :mod:`fitmanager` +------------------------------------------------------------ + +.. automodule:: silx.math.fit.bgtheories + :members: diff --git a/doc/source/modules/math/fit/filters.rst b/doc/source/modules/math/fit/filters.rst new file mode 100644 index 0000000..09f7145 --- /dev/null +++ b/doc/source/modules/math/fit/filters.rst @@ -0,0 +1,18 @@ + +.. currentmodule:: silx.math.fit + +Smoothing and background filters +-------------------------------- + +.. automodule:: silx.math.fit.filters + +.. autofunction:: silx.math.fit.smooth1d +.. autofunction:: silx.math.fit.smooth2d +.. autofunction:: silx.math.fit.smooth3d +.. autofunction:: silx.math.fit.savitsky_golay +.. autofunction:: silx.math.fit.snip1d +.. autofunction:: silx.math.fit.snip2d +.. autofunction:: silx.math.fit.snip3d +.. autofunction:: silx.math.fit.strip + + diff --git a/doc/source/modules/math/fit/fitmanager.rst b/doc/source/modules/math/fit/fitmanager.rst new file mode 100644 index 0000000..b8a9446 --- /dev/null +++ b/doc/source/modules/math/fit/fitmanager.rst @@ -0,0 +1,18 @@ + +.. currentmodule:: silx.math.fit + +:mod:`fitmanager`: Fit functions manager +---------------------------------------- + +.. automodule:: silx.math.fit.fitmanager + +For a tutorial on how to use :class:`FitManager`, see :ref:`fitmanager-tutorial`. + +API +... + +.. autoclass:: silx.math.fit.fitmanager.FitManager + :members: addbackground, addtheory, configure, disableweight, estimate, fit, fitconfig, + fit_results, gendata, enableweight, loadtheories, setdata, setbackground, + settheory, runfit + :special-members: __init__ diff --git a/doc/source/modules/math/fit/fittheories.rst b/doc/source/modules/math/fit/fittheories.rst new file mode 100644 index 0000000..4a0b6bc --- /dev/null +++ b/doc/source/modules/math/fit/fittheories.rst @@ -0,0 +1,8 @@ + +.. currentmodule:: silx.math.fit + +:mod:`fittheories`: Fit theories for :mod:`fitmanager` +-------------------------------------------------------- + +.. automodule:: silx.math.fit.fittheories + :members: diff --git a/doc/source/modules/math/fit/fittheory.rst b/doc/source/modules/math/fit/fittheory.rst new file mode 100644 index 0000000..ab29d17 --- /dev/null +++ b/doc/source/modules/math/fit/fittheory.rst @@ -0,0 +1,8 @@ + +.. currentmodule:: silx.math.fit + +:mod:`fittheory`: Fit theory definition +--------------------------------------- + +.. automodule:: silx.math.fit.fittheory + :members: diff --git a/doc/source/modules/math/fit/functions.rst b/doc/source/modules/math/fit/functions.rst new file mode 100644 index 0000000..f354964 --- /dev/null +++ b/doc/source/modules/math/fit/functions.rst @@ -0,0 +1,26 @@ + +.. currentmodule:: silx.math.fit + +Fit functions +------------- + +.. automodule:: silx.math.fit.functions + +.. autofunction:: silx.math.fit.atan_stepup +.. autofunction:: silx.math.fit.periodic_gauss +.. autofunction:: silx.math.fit.sum_agauss +.. autofunction:: silx.math.fit.sum_ahypermet +.. autofunction:: silx.math.fit.sum_alorentz +.. autofunction:: silx.math.fit.sum_apvoigt +.. autofunction:: silx.math.fit.sum_fastagauss +.. autofunction:: silx.math.fit.sum_fastahypermet +.. autofunction:: silx.math.fit.sum_gauss +.. autofunction:: silx.math.fit.sum_lorentz +.. autofunction:: silx.math.fit.sum_pvoigt +.. autofunction:: silx.math.fit.sum_slit +.. autofunction:: silx.math.fit.sum_splitgauss +.. autofunction:: silx.math.fit.sum_splitlorentz +.. autofunction:: silx.math.fit.sum_splitpvoigt +.. autofunction:: silx.math.fit.sum_stepdown +.. autofunction:: silx.math.fit.sum_stepup + diff --git a/doc/source/modules/math/fit/index.rst b/doc/source/modules/math/fit/index.rst new file mode 100644 index 0000000..958e339 --- /dev/null +++ b/doc/source/modules/math/fit/index.rst @@ -0,0 +1,25 @@ + +.. currentmodule:: silx.math +.. py:module:: silx.math.fit + +:mod:`fit`: Fitting tools +========================== + +.. toctree:: + :maxdepth: 1 + + leastsq.rst + peaksearch.rst + functions.rst + filters.rst + fitmanager.rst + fittheory.rst + fittheories.rst + bgtheories.rst + + +For a graphical fit widget, see :mod:`silx.gui.fit.FitWidget`. + +For a tutorial on using the various fit related modules, see :ref:`fit-tutorial` . + + diff --git a/doc/source/modules/math/fit/leastsq.rst b/doc/source/modules/math/fit/leastsq.rst new file mode 100644 index 0000000..35c105f --- /dev/null +++ b/doc/source/modules/math/fit/leastsq.rst @@ -0,0 +1,16 @@ + +.. currentmodule:: silx.math.fit + +:mod:`leastsq`: Levenberg Marquardt with constraints +----------------------------------------------------- + +.. automodule:: silx.math.fit.leastsq + :noindex: + +For a tutorial on how to use :func:`leastsq`, see :ref:`leastsq-tutorial`. + +Functions ++++++++++ + +.. autofunction:: silx.math.fit.leastsq +.. autofunction:: silx.math.fit.chisq_alpha_beta diff --git a/doc/source/modules/math/fit/peaksearch.rst b/doc/source/modules/math/fit/peaksearch.rst new file mode 100644 index 0000000..b1c70eb --- /dev/null +++ b/doc/source/modules/math/fit/peaksearch.rst @@ -0,0 +1,10 @@ + +.. currentmodule:: silx.math.fit + +Peak search function +-------------------- + +.. automodule:: silx.math.fit.peaks + +.. autofunction:: silx.math.fit.peaks.peak_search +.. autofunction:: silx.math.fit.peaks.guess_fwhm diff --git a/doc/source/modules/math/histogram.rst b/doc/source/modules/math/histogram.rst new file mode 100644 index 0000000..06a9fed --- /dev/null +++ b/doc/source/modules/math/histogram.rst @@ -0,0 +1,21 @@ + +.. currentmodule:: silx.math + +:mod:`histogram`: Multidimensional histograms +---------------------------------------------- + +.. automodule:: silx.math.histogram + + +Classes ++++++++ + +.. autoclass:: silx.math.histogram.Histogramnd + :members: + :undoc-members: + :special-members: __init__, __getitem__ + +.. autoclass:: silx.math.histogram.HistogramndLut + :members: + :undoc-members: + :special-members: __init__ diff --git a/doc/source/modules/math/index.rst b/doc/source/modules/math/index.rst new file mode 100644 index 0000000..ece49dd --- /dev/null +++ b/doc/source/modules/math/index.rst @@ -0,0 +1,13 @@ + +.. py:module:: silx.math + +:mod:`silx.math`: +================== + +.. toctree:: + :maxdepth: 1 + + fit/index.rst + histogram.rst + medianfilter.rst + combo.rst diff --git a/doc/source/modules/math/medianfilter.rst b/doc/source/modules/math/medianfilter.rst new file mode 100644 index 0000000..bb8903c --- /dev/null +++ b/doc/source/modules/math/medianfilter.rst @@ -0,0 +1,11 @@ + +.. currentmodule:: silx.math.medianfilter + +:mod:`medianfilter`: Median filter +---------------------------------- + +.. autofunction:: silx.math.medianfilter.medfilt + +.. autofunction:: silx.math.medianfilter.medfilt1d + +.. autofunction:: silx.math.medianfilter.medfilt2d |