summaryrefslogtreecommitdiff
path: root/doc/source/modules/opencl
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/modules/opencl')
-rw-r--r--doc/source/modules/opencl/codec_cbf.rst9
-rw-r--r--doc/source/modules/opencl/fbp.rst10
-rw-r--r--doc/source/modules/opencl/index.rst15
-rw-r--r--doc/source/modules/opencl/medfilt.rst7
-rw-r--r--doc/source/modules/opencl/sift/align.rst7
-rw-r--r--doc/source/modules/opencl/sift/index.rst11
-rw-r--r--doc/source/modules/opencl/sift/match.rst7
-rw-r--r--doc/source/modules/opencl/sift/plan.rst7
8 files changed, 73 insertions, 0 deletions
diff --git a/doc/source/modules/opencl/codec_cbf.rst b/doc/source/modules/opencl/codec_cbf.rst
new file mode 100644
index 0000000..f39a484
--- /dev/null
+++ b/doc/source/modules/opencl/codec_cbf.rst
@@ -0,0 +1,9 @@
+
+.. currentmodule:: silx.opencl.codec
+
+:mod:`byte_offset`: Byte Offset compression/decompression
+---------------------------------------------------------
+
+.. automodule:: silx.opencl.codec.byte_offset
+ :members: ByteOffset
+ :show-inheritance:
diff --git a/doc/source/modules/opencl/fbp.rst b/doc/source/modules/opencl/fbp.rst
new file mode 100644
index 0000000..3c8c465
--- /dev/null
+++ b/doc/source/modules/opencl/fbp.rst
@@ -0,0 +1,10 @@
+
+.. currentmodule:: silx.opencl
+
+:mod:`backprojection`: (Filtered) Back-Projection
+--------------------------------------------------
+
+.. automodule:: silx.opencl.backprojection
+ :members: Backprojection
+ :show-inheritance:
+ :undoc-members:
diff --git a/doc/source/modules/opencl/index.rst b/doc/source/modules/opencl/index.rst
new file mode 100644
index 0000000..e17eecb
--- /dev/null
+++ b/doc/source/modules/opencl/index.rst
@@ -0,0 +1,15 @@
+
+.. py:module:: silx.opencl
+
+:mod:`silx.opencl`: OpenCL-based features
+=========================================
+
+
+.. toctree::
+ :maxdepth: 1
+
+ sift/index.rst
+ fbp.rst
+ medfilt.rst
+ codec_cbf.rst
+
diff --git a/doc/source/modules/opencl/medfilt.rst b/doc/source/modules/opencl/medfilt.rst
new file mode 100644
index 0000000..b1379f7
--- /dev/null
+++ b/doc/source/modules/opencl/medfilt.rst
@@ -0,0 +1,7 @@
+.. currentmodule:: silx.opencl
+
+:mod:`medianfilter`: OpenCL median filter
+------------------------------------------
+
+.. automodule:: silx.opencl.medfilt
+ :members: MedianFilter2D, medfilt2d
diff --git a/doc/source/modules/opencl/sift/align.rst b/doc/source/modules/opencl/sift/align.rst
new file mode 100644
index 0000000..01b9fd6
--- /dev/null
+++ b/doc/source/modules/opencl/sift/align.rst
@@ -0,0 +1,7 @@
+.. currentmodule:: silx.opencl.sift
+
+:mod:`alignment`: SIFT Plan for linear alignment
+-------------------------------------------------
+
+.. automodule:: silx.opencl.sift.alignment
+ :members: LinearAlign
diff --git a/doc/source/modules/opencl/sift/index.rst b/doc/source/modules/opencl/sift/index.rst
new file mode 100644
index 0000000..9ae0d6f
--- /dev/null
+++ b/doc/source/modules/opencl/sift/index.rst
@@ -0,0 +1,11 @@
+.. currentmodule:: silx.opencl.sift
+
+:mod:`sift`: SIFT image alignment
+==================================
+
+.. toctree::
+ :maxdepth: 1
+
+ plan.rst
+ match.rst
+ align.rst
diff --git a/doc/source/modules/opencl/sift/match.rst b/doc/source/modules/opencl/sift/match.rst
new file mode 100644
index 0000000..c64c7d3
--- /dev/null
+++ b/doc/source/modules/opencl/sift/match.rst
@@ -0,0 +1,7 @@
+.. currentmodule:: silx.opencl.sift
+
+:mod:`match`: SIFT Plan for keypoints matching
+------------------------------------------------------
+
+.. automodule:: silx.opencl.sift.match
+ :members: MatchPlan, match_py
diff --git a/doc/source/modules/opencl/sift/plan.rst b/doc/source/modules/opencl/sift/plan.rst
new file mode 100644
index 0000000..135495d
--- /dev/null
+++ b/doc/source/modules/opencl/sift/plan.rst
@@ -0,0 +1,7 @@
+.. currentmodule:: silx.opencl.sift
+
+:mod:`plan`: SIFT Plan
+-----------------------
+
+.. automodule:: silx.opencl.sift.plan
+ :members: SiftPlan