diff options
Diffstat (limited to 'doc/source/modules/image')
| -rw-r--r-- | doc/source/modules/image/backprojection.rst | 8 | ||||
| -rw-r--r-- | doc/source/modules/image/bilinear.rst | 9 | ||||
| -rw-r--r-- | doc/source/modules/image/index.rst | 14 | ||||
| -rw-r--r-- | doc/source/modules/image/medianfilter.rst | 7 | ||||
| -rw-r--r-- | doc/source/modules/image/projection.rst | 15 | ||||
| -rw-r--r-- | doc/source/modules/image/reconstruction.rst | 14 | ||||
| -rw-r--r-- | doc/source/modules/image/shapes.rst | 8 | ||||
| -rw-r--r-- | doc/source/modules/image/sift.rst | 8 |
8 files changed, 83 insertions, 0 deletions
diff --git a/doc/source/modules/image/backprojection.rst b/doc/source/modules/image/backprojection.rst new file mode 100644 index 0000000..c45f670 --- /dev/null +++ b/doc/source/modules/image/backprojection.rst @@ -0,0 +1,8 @@ + +.. currentmodule:: silx.image + +:mod:`backprojection`: backprojection algorithm +----------------------------------------------- + +.. automodule:: silx.image.backprojection + :members: Backprojection diff --git a/doc/source/modules/image/bilinear.rst b/doc/source/modules/image/bilinear.rst new file mode 100644 index 0000000..e155751 --- /dev/null +++ b/doc/source/modules/image/bilinear.rst @@ -0,0 +1,9 @@ + +.. currentmodule:: silx.image + +:mod:`bilinear`: Bilinear interpolator +--------------------------------------- + +.. automodule:: silx.image.bilinear + :members: + :special-members: __call__ diff --git a/doc/source/modules/image/index.rst b/doc/source/modules/image/index.rst new file mode 100644 index 0000000..89c5642 --- /dev/null +++ b/doc/source/modules/image/index.rst @@ -0,0 +1,14 @@ + +.. py:module:: silx.image + +:mod:`silx.image`: +================== + +.. toctree:: + :maxdepth: 1 + + bilinear.rst + medianfilter.rst + shapes.rst + sift.rst + backprojection.rst diff --git a/doc/source/modules/image/medianfilter.rst b/doc/source/modules/image/medianfilter.rst new file mode 100644 index 0000000..412f8bb --- /dev/null +++ b/doc/source/modules/image/medianfilter.rst @@ -0,0 +1,7 @@ + +.. currentmodule:: silx.image.medianfilter + +:mod:`medianfilter`: Median filter +---------------------------------- + +.. autofunction:: silx.image.medianfilter.medfilt2d diff --git a/doc/source/modules/image/projection.rst b/doc/source/modules/image/projection.rst new file mode 100644 index 0000000..f5f4815 --- /dev/null +++ b/doc/source/modules/image/projection.rst @@ -0,0 +1,15 @@ + +.. currentmodule:: silx.image + +:mod:`projection`: projection algorithm +--------------------------------------- + +.. warning:: + + This module is known to be buggy in version 0.6: + Do NOT use it without having checked it provides + proper results + +.. automodule:: silx.image.projection + :members: Projection + diff --git a/doc/source/modules/image/reconstruction.rst b/doc/source/modules/image/reconstruction.rst new file mode 100644 index 0000000..d288581 --- /dev/null +++ b/doc/source/modules/image/reconstruction.rst @@ -0,0 +1,14 @@ + +.. currentmodule:: silx.image + +:mod:`reconstruction`: reconstruction algorithm +----------------------------------------------- + +.. warning:: + + This module is known to be buggy in version 0.6: + Do NOT use it without having checked it provides + proper results + +.. automodule:: silx.image.reconstruction + :members: ReconstructionAlgorithm, SIRT, TV diff --git a/doc/source/modules/image/shapes.rst b/doc/source/modules/image/shapes.rst new file mode 100644 index 0000000..a20b0cd --- /dev/null +++ b/doc/source/modules/image/shapes.rst @@ -0,0 +1,8 @@ + +.. currentmodule:: silx.image + +:mod:`shapes`: 2D shapes drawing +--------------------------------- + +.. automodule:: silx.image.shapes + :members: circle_fill, draw_line, polygon_fill_mask, Polygon diff --git a/doc/source/modules/image/sift.rst b/doc/source/modules/image/sift.rst new file mode 100644 index 0000000..55a4752 --- /dev/null +++ b/doc/source/modules/image/sift.rst @@ -0,0 +1,8 @@ + +.. currentmodule:: silx.image + +:mod:`sift`: 2D image alignment +--------------------------------- + +.. automodule:: silx.image.sift + :members: SiftPlan, MatchPlan, LinearAlign |