From dfb96a9acf80f203fd0220156ffd8dc69f6d67e7 Mon Sep 17 00:00:00 2001 From: Erol444 Date: Thu, 8 Jul 2021 12:54:21 +0200 Subject: [PATCH 1/2] Added edgeDetector node and edgeDetectorConfig message docs --- .../messages/edge_detector_config.rst | 32 +++++++ .../source/components/nodes/edge_detector.rst | 91 +++++++++++++++++++ 2 files changed, 123 insertions(+) create mode 100644 docs/source/components/messages/edge_detector_config.rst create mode 100644 docs/source/components/nodes/edge_detector.rst diff --git a/docs/source/components/messages/edge_detector_config.rst b/docs/source/components/messages/edge_detector_config.rst new file mode 100644 index 000000000..dd1aae70e --- /dev/null +++ b/docs/source/components/messages/edge_detector_config.rst @@ -0,0 +1,32 @@ +EdgeDetectorConfig +================== + +This message is used to configure the :ref:`EdgeDetector` node. +You can set the horizontal and vertical Sobel filter kernel. + +Examples of functionality +######################### + +- :ref:`Edge detector` + +Reference +######### + +.. tabs:: + + .. tab:: Python + + .. autoclass:: depthai.EdgeDetectorConfig + :members: + :inherited-members: + :noindex: + + .. tab:: C++ + + .. doxygenclass:: dai::EdgeDetectorConfig + :project: depthai-core + :members: + :private-members: + :undoc-members: + +.. include:: ../../includes/footer-short.rst diff --git a/docs/source/components/nodes/edge_detector.rst b/docs/source/components/nodes/edge_detector.rst new file mode 100644 index 000000000..ecf76b438 --- /dev/null +++ b/docs/source/components/nodes/edge_detector.rst @@ -0,0 +1,91 @@ +EdgeDetector +============ + +Edge detector uses `Sobel filter `__ to create image that emphasises edges. + +How to place it +############### + +.. tabs:: + + .. code-tab:: py + + pipeline = dai.Pipeline() + edgeDetector = pipeline.createEdgeDetector() + + .. code-tab:: c++ + + dai::Pipeline pipeline; + auto edgeDetector = pipeline.create(); + + +Inputs and Outputs +################## + +.. code-block:: + + ┌───────────────────┐ + inputImage │ │ + ──────────────►│ │ + │ │ outputImage + │ EdgeDetector ├───────────► + inputConfig │ │ + ──────────────►│ │ + │ │ + └───────────────────┘ + +**Message types** + +- :code:`inputImage` - :ref:`ImgFrame` +- :code:`inputConfig` - :ref:`EdgeDetectorConfig` +- :code:`outputImage` - :ref:`ImgFrame` + +Usage +##### + +.. tabs:: + + .. code-tab:: py + + pipeline = dai.Pipeline() + edgeDetector = pipeline.createEdgeDetector() + + sobelHorizontalKernel = [[1, 0, -1], [2, 0, -2], [1, 0, -1]] + sobelVerticalKernel = [[1, 2, 1], [0, 0, 0], [-1, -2, -1]] + edgeDetector.initialConfig.setSobelFilterKernels(sobelHorizontalKernel, sobelVerticalKernel) + + .. code-tab:: c++ + + dai::Pipeline pipeline; + auto edgeDetector = pipeline.create(); + + std::vector> sobelHorizontalKernel = {{1, 0, -1}, {2, 0, -2}, {1, 0, -1}}; + std::vector> sobelVerticalKernel = {{1, 2, 1}, {0, 0, 0}, {-1, -2, -1}}; + edgeDetector->setSobelFilterKernels(sobelHorizontalKernel, sobelVerticalKernel); + +Examples of functionality +######################### + +- :ref:`Edge detector` + +Reference +######### + +.. tabs:: + + .. tab:: Python + + .. autoclass:: depthai.EdgeDetector + :members: + :inherited-members: + :noindex: + + .. tab:: C++ + + .. doxygenclass:: dai::node::EdgeDetector + :project: depthai-core + :members: + :private-members: + :undoc-members: + +.. include:: ../../includes/footer-short.rst From ba167ab8770cf4abda102a2dcc2ba8c04588fe00 Mon Sep 17 00:00:00 2001 From: Erol444 Date: Wed, 14 Jul 2021 10:17:37 +0200 Subject: [PATCH 2/2] Restart RTD workflow --- docs/source/components/nodes/edge_detector.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/components/nodes/edge_detector.rst b/docs/source/components/nodes/edge_detector.rst index ecf76b438..6c30c0528 100644 --- a/docs/source/components/nodes/edge_detector.rst +++ b/docs/source/components/nodes/edge_detector.rst @@ -1,7 +1,7 @@ EdgeDetector ============ -Edge detector uses `Sobel filter `__ to create image that emphasises edges. +Edge detector uses `Sobel filter `__ to create an image that emphasises edges. How to place it ###############