Skip to content

Feature/extract stereo filters #1308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 32 commits into
base: v3_develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
b102b01
Initial depth filter host node implementation
lnotspotl Apr 28, 2025
9d02266
Enable dynamic filter property setting
lnotspotl Apr 28, 2025
d45e14c
Dynamic depth confidence node config
lnotspotl Apr 28, 2025
6e44920
Dynamic depth confidence node config
lnotspotl Apr 28, 2025
373b2a7
Update naming, fix ToF filter
lnotspotl May 6, 2025
af39e67
Move depth filters out of host node folder
lnotspotl May 6, 2025
2d18856
follow camelCase naming
lnotspotl May 6, 2025
9e29e10
Merge branch 'v3_develop' into feature/extract_stereo_filters
lnotspotl May 6, 2025
3dfc5f9
Update variable names
lnotspotl May 6, 2025
d8983c9
remove unused variables
lnotspotl May 6, 2025
e236d5b
follow camelCase naming convention
lnotspotl May 6, 2025
b89c59c
follow camelCase naming convention
lnotspotl May 6, 2025
a0dbb4f
Rename DepthFilters to ImageFilters
lnotspotl May 6, 2025
c1ec546
extract commonalities between image filters and stereo depth node
lnotspotl May 6, 2025
1b53532
Update docstrings
lnotspotl May 6, 2025
79c4e51
Update docstrings
lnotspotl May 6, 2025
22648d5
add filter host node example
lnotspotl May 6, 2025
13435b0
fix temporal filter for different ImgFrame types
lnotspotl May 6, 2025
81c3436
Remove redundant printf
lnotspotl May 6, 2025
8357c13
fix python docs generation
lnotspotl May 7, 2025
ad0e426
fix docs build
lnotspotl May 11, 2025
dbccf99
Update ImageFilters.cpp
lnotspotl May 11, 2025
a977d56
add tof host filters example
lnotspotl May 11, 2025
8e28914
Merge branch 'feature/extract_stereo_filters' of github.com:luxonis/d…
lnotspotl May 11, 2025
bd1d73c
Update ImageFilters.cpp
lnotspotl May 13, 2025
29d69e9
use smart pointers, use depthai checks instead of throws
lnotspotl May 16, 2025
3f1384a
fix confidence
lnotspotl May 22, 2025
c7f23b2
fix confidence
lnotspotl May 22, 2025
02bbfa0
merge v3_develop in [skip ci]
lnotspotl Jun 9, 2025
00fafff
Fix errors, rename DepthConfidenceFilter to ToFDepthConfidenceFilter …
lnotspotl Jun 9, 2025
38d2598
add preset modes, fix warnings and errors [skip ci]
lnotspotl Jun 9, 2025
97525dd
update examples to use the Camera node instead of the depracated Mono…
lnotspotl Jun 9, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ set(THIRDPARTY_OPENCV_LIBRARIES "" CACHE STRING "Optional libraries to link Open
set(TARGET_OPENCV_NAME ${PROJECT_NAME}-opencv)
set(TARGET_OPENCV_ALIAS opencv)
if(DEPTHAI_OPENCV_SUPPORT)
set(REQUIRED_OPENCV_LIBRARIES "opencv_core" "opencv_imgproc" "opencv_videoio" "opencv_highgui")
set(REQUIRED_OPENCV_LIBRARIES "opencv_core" "opencv_imgproc" "opencv_videoio" "opencv_highgui" "opencv_calib3d")
set(OPENCV_SUPPORT_AVAILABLE ${OpenCV_FOUND})
foreach(lib ${REQUIRED_OPENCV_LIBRARIES})
if(NOT (lib IN_LIST OpenCV_LIBS))
Expand Down Expand Up @@ -367,6 +367,7 @@ set(TARGET_OPENCV_SOURCES
src/pipeline/node/host/HostCamera.cpp
src/pipeline/node/host/Record.cpp
src/pipeline/node/host/Replay.cpp
src/pipeline/node/ImageFilters.cpp
src/opencv/RecordReplay.cpp
src/opencv/HolisticRecordReplay.cpp
)
Expand Down
3 changes: 2 additions & 1 deletion bindings/js/bindings.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,8 @@ EMSCRIPTEN_BINDINGS(depthai_js) {
.value("ToFConfig", dai::DatatypeEnum::ToFConfig)
.value("TrackedFeatures", dai::DatatypeEnum::TrackedFeatures)
.value("BenchmarkReport", dai::DatatypeEnum::BenchmarkReport)
.value("MessageGroup", dai::DatatypeEnum::MessageGroup);
.value("MessageGroup", dai::DatatypeEnum::MessageGroup)
.value("ImageFiltersConfig", dai::DatatypeEnum::ImageFiltersConfig);

// structs
value_object<MessageHeader>("MessageHeader")
Expand Down
2 changes: 2 additions & 0 deletions bindings/python/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,8 @@ set(SOURCE_LIST
src/pipeline/node/ReplayBindings.cpp
src/pipeline/node/ImageAlignBindings.cpp
src/pipeline/node/RGBDBindings.cpp
src/pipeline/node/ImageFiltersBindings.cpp
src/pipeline/FilterParamsBindings.cpp

src/pipeline/datatype/ADatatypeBindings.cpp
src/pipeline/datatype/AprilTagConfigBindings.cpp
Expand Down
87 changes: 87 additions & 0 deletions bindings/python/src/pipeline/FilterParamsBindings.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
#include "FilterParamsBindings.hpp"
#include "depthai/pipeline/FilterParams.hpp"

void FilterParamsBindings::bind(pybind11::module& m, void* pCallstack) {
// dai.filters.params
py::module_ filters = m.def_submodule("filters", "Parameters for filters");
py::module_ params = filters.def_submodule("params", "Parameters for filters");

// -- Median Filter --
py::enum_<dai::filters::params::MedianFilter> medianFilter(params, "MedianFilter");
medianFilter.value("MEDIAN_OFF", dai::filters::params::MedianFilter::MEDIAN_OFF)
.value("KERNEL_3x3", dai::filters::params::MedianFilter::KERNEL_3x3)
.value("KERNEL_5x5", dai::filters::params::MedianFilter::KERNEL_5x5)
.value("KERNEL_7x7", dai::filters::params::MedianFilter::KERNEL_7x7);

// -- Spatial Filter --
py::class_<dai::filters::params::SpatialFilter> spatialFilter(params, "SpatialFilter");
spatialFilter.def(py::init<>())
.def_readwrite("enable", &dai::filters::params::SpatialFilter::enable, DOC(dai, filters, params, SpatialFilter, enable))
.def_readwrite(
"holeFillingRadius", &dai::filters::params::SpatialFilter::holeFillingRadius, DOC(dai, filters, params, SpatialFilter, holeFillingRadius))
.def_readwrite("alpha", &dai::filters::params::SpatialFilter::alpha, DOC(dai, filters, params, SpatialFilter, alpha))
.def_readwrite("delta", &dai::filters::params::SpatialFilter::delta, DOC(dai, filters, params, SpatialFilter, delta))
.def_readwrite("numIterations", &dai::filters::params::SpatialFilter::numIterations, DOC(dai, filters, params, SpatialFilter, numIterations));

// -- Temporal Filter --
py::class_<dai::filters::params::TemporalFilter> temporalFilter(
params, "TemporalFilter", DOC(dai, filters, params, TemporalFilter));
temporalFilter.def(py::init<>())
.def_readwrite("enable", &dai::filters::params::TemporalFilter::enable, DOC(dai, filters, params, TemporalFilter, enable))
.def_readwrite(
"persistencyMode", &dai::filters::params::TemporalFilter::persistencyMode, DOC(dai, filters, params, TemporalFilter, persistencyMode))
.def_readwrite("alpha", &dai::filters::params::TemporalFilter::alpha, DOC(dai, filters, params, TemporalFilter, alpha))
.def_readwrite("delta", &dai::filters::params::TemporalFilter::delta, DOC(dai, filters, params, TemporalFilter, delta));

py::enum_<dai::filters::params::TemporalFilter::PersistencyMode> persistencyMode(
temporalFilter, "PersistencyMode", DOC(dai, filters, params, TemporalFilter, PersistencyMode));
persistencyMode
.value("PERSISTENCY_OFF",
dai::filters::params::TemporalFilter::PersistencyMode::PERSISTENCY_OFF,
DOC(dai, filters, params, TemporalFilter, PersistencyMode, PERSISTENCY_OFF))
.value("VALID_8_OUT_OF_8",
dai::filters::params::TemporalFilter::PersistencyMode::VALID_8_OUT_OF_8,
DOC(dai, filters, params, TemporalFilter, PersistencyMode, VALID_8_OUT_OF_8))
.value("VALID_2_IN_LAST_3",
dai::filters::params::TemporalFilter::PersistencyMode::VALID_2_IN_LAST_3,
DOC(dai, filters, params, TemporalFilter, PersistencyMode, VALID_2_IN_LAST_3))
.value("VALID_2_IN_LAST_4",
dai::filters::params::TemporalFilter::PersistencyMode::VALID_2_IN_LAST_4,
DOC(dai, filters, params, TemporalFilter, PersistencyMode, VALID_2_IN_LAST_4))
.value("VALID_2_OUT_OF_8",
dai::filters::params::TemporalFilter::PersistencyMode::VALID_2_OUT_OF_8,
DOC(dai, filters, params, TemporalFilter, PersistencyMode, VALID_2_OUT_OF_8))
.value("VALID_1_IN_LAST_2",
dai::filters::params::TemporalFilter::PersistencyMode::VALID_1_IN_LAST_2,
DOC(dai, filters, params, TemporalFilter, PersistencyMode, VALID_1_IN_LAST_2))
.value("VALID_1_IN_LAST_5",
dai::filters::params::TemporalFilter::PersistencyMode::VALID_1_IN_LAST_5,
DOC(dai, filters, params, TemporalFilter, PersistencyMode, VALID_1_IN_LAST_5))
.value("VALID_1_IN_LAST_8",
dai::filters::params::TemporalFilter::PersistencyMode::VALID_1_IN_LAST_8,
DOC(dai, filters, params, TemporalFilter, PersistencyMode, VALID_1_IN_LAST_8))
.value("PERSISTENCY_INDEFINITELY",
dai::filters::params::TemporalFilter::PersistencyMode::PERSISTENCY_INDEFINITELY,
DOC(dai, filters, params, TemporalFilter, PersistencyMode, PERSISTENCY_INDEFINITELY));

// -- Speckle filter --
py::class_<dai::filters::params::SpeckleFilter> speckleFilter(params, "SpeckleFilter");
speckleFilter.def(py::init<>())
.def_readwrite("enable", &dai::filters::params::SpeckleFilter::enable, DOC(dai, filters, params, SpeckleFilter, enable))
.def_readwrite("speckleRange", &dai::filters::params::SpeckleFilter::speckleRange, DOC(dai, filters, params, SpeckleFilter, speckleRange))
.def_readwrite("differenceThreshold",
&dai::filters::params::SpeckleFilter::differenceThreshold,
DOC(dai, filters, params, SpeckleFilter, differenceThreshold));

// Aliases for backward compatibility
m.attr("MedianFilter") = medianFilter;
m.attr("StereoDepthConfig").attr("MedianFilter") = medianFilter;
m.attr("StereoDepthConfig").attr("PostProcessing").attr("SpatialFilter") = spatialFilter;
m.attr("StereoDepthConfig").attr("PostProcessing").attr("TemporalFilter") = temporalFilter;
m.attr("StereoDepthConfig").attr("PostProcessing").attr("SpeckleFilter") = speckleFilter;

Callstack* callstack = (Callstack*)pCallstack;
auto cb = callstack->top();
callstack->pop();
cb(m, pCallstack);
}
6 changes: 6 additions & 0 deletions bindings/python/src/pipeline/FilterParamsBindings.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#pragma once
#include "pybind11_common.hpp"

struct FilterParamsBindings {
static void bind(pybind11::module& m, void* pCallstack);
};
Original file line number Diff line number Diff line change
Expand Up @@ -20,26 +20,17 @@ void bind_stereodepthconfig(pybind11::module& m, void* pCallstack) {
// RawStereoDepthConfig));
py::class_<StereoDepthConfig, Py<StereoDepthConfig>, Buffer, std::shared_ptr<StereoDepthConfig>> stereoDepthConfig(
m, "StereoDepthConfig", DOC(dai, StereoDepthConfig));
py::enum_<StereoDepthConfig::MedianFilter> medianFilter(m, "MedianFilter", DOC(dai, MedianFilter));
py::class_<StereoDepthConfig::ConfidenceMetrics> _ConfidenceMetrics(stereoDepthConfig, "ConfidenceMetrics", DOC(dai, StereoDepthConfig, ConfidenceMetrics));
py::class_<StereoDepthConfig::AlgorithmControl> algorithmControl(stereoDepthConfig, "AlgorithmControl", DOC(dai, StereoDepthConfig, AlgorithmControl));
py::enum_<StereoDepthConfig::AlgorithmControl::DepthAlign> depthAlign(
algorithmControl, "DepthAlign", DOC(dai, StereoDepthConfig, AlgorithmControl, DepthAlign));
py::enum_<StereoDepthConfig::AlgorithmControl::DepthUnit> depthUnit(
algorithmControl, "DepthUnit", DOC(dai, StereoDepthConfig, AlgorithmControl, DepthUnit));
py::class_<StereoDepthConfig::PostProcessing> postProcessing(stereoDepthConfig, "PostProcessing", DOC(dai, StereoDepthConfig, PostProcessing));
py::class_<StereoDepthConfig::PostProcessing::SpatialFilter> spatialFilter(
postProcessing, "SpatialFilter", DOC(dai, StereoDepthConfig, PostProcessing, SpatialFilter));
py::class_<StereoDepthConfig::PostProcessing::TemporalFilter> temporalFilter(
postProcessing, "TemporalFilter", DOC(dai, StereoDepthConfig, PostProcessing, TemporalFilter));
py::enum_<StereoDepthConfig::PostProcessing::TemporalFilter::PersistencyMode> persistencyMode(
temporalFilter, "PersistencyMode", DOC(dai, StereoDepthConfig, PostProcessing, TemporalFilter, PersistencyMode));
py::class_<StereoDepthConfig::PostProcessing::ThresholdFilter> thresholdFilter(
postProcessing, "ThresholdFilter", DOC(dai, StereoDepthConfig, PostProcessing, ThresholdFilter));
py::class_<StereoDepthConfig::PostProcessing::BrightnessFilter> brightnessFilter(
postProcessing, "BrightnessFilter", DOC(dai, StereoDepthConfig, PostProcessing, BrightnessFilter));
py::class_<StereoDepthConfig::PostProcessing::SpeckleFilter> speckleFilter(
postProcessing, "SpeckleFilter", DOC(dai, StereoDepthConfig, PostProcessing, SpeckleFilter));
py::class_<StereoDepthConfig::PostProcessing::DecimationFilter> decimationFilter(
postProcessing, "DecimationFilter", DOC(dai, StereoDepthConfig, PostProcessing, DecimationFilter));
py::enum_<StereoDepthConfig::PostProcessing::DecimationFilter::DecimationMode> decimationMode(
Expand Down Expand Up @@ -73,13 +64,6 @@ void bind_stereodepthconfig(pybind11::module& m, void* pCallstack) {
///////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////

// Metadata / raw
medianFilter.value("MEDIAN_OFF", StereoDepthConfig::MedianFilter::MEDIAN_OFF)
.value("KERNEL_3x3", StereoDepthConfig::MedianFilter::KERNEL_3x3)
.value("KERNEL_5x5", StereoDepthConfig::MedianFilter::KERNEL_5x5)
.value("KERNEL_7x7", StereoDepthConfig::MedianFilter::KERNEL_7x7);
// m.attr("StereoDepthProperties").attr("MedianFilter") = medianFilter;

depthAlign
.value("RECTIFIED_RIGHT",
StereoDepthConfig::AlgorithmControl::DepthAlign::RECTIFIED_RIGHT,
Expand Down Expand Up @@ -145,55 +129,6 @@ void bind_stereodepthconfig(pybind11::module& m, void* pCallstack) {
.def_readwrite(
"flatnessOverride", &StereoDepthConfig::ConfidenceMetrics::flatnessOverride, DOC(dai, StereoDepthConfig, ConfidenceMetrics, flatnessOverride));

spatialFilter.def(py::init<>())
.def_readwrite("enable", &StereoDepthConfig::PostProcessing::SpatialFilter::enable, DOC(dai, StereoDepthConfig, PostProcessing, SpatialFilter, enable))
.def_readwrite("holeFillingRadius",
&StereoDepthConfig::PostProcessing::SpatialFilter::holeFillingRadius,
DOC(dai, StereoDepthConfig, PostProcessing, SpatialFilter, holeFillingRadius))
.def_readwrite("alpha", &StereoDepthConfig::PostProcessing::SpatialFilter::alpha, DOC(dai, StereoDepthConfig, PostProcessing, SpatialFilter, alpha))
.def_readwrite("delta", &StereoDepthConfig::PostProcessing::SpatialFilter::delta, DOC(dai, StereoDepthConfig, PostProcessing, SpatialFilter, delta))
.def_readwrite("numIterations",
&StereoDepthConfig::PostProcessing::SpatialFilter::numIterations,
DOC(dai, StereoDepthConfig, PostProcessing, SpatialFilter, numIterations));

persistencyMode
.value("PERSISTENCY_OFF",
StereoDepthConfig::PostProcessing::TemporalFilter::PersistencyMode::PERSISTENCY_OFF,
DOC(dai, StereoDepthConfig, PostProcessing, TemporalFilter, PersistencyMode, PERSISTENCY_OFF))
.value("VALID_8_OUT_OF_8",
StereoDepthConfig::PostProcessing::TemporalFilter::PersistencyMode::VALID_8_OUT_OF_8,
DOC(dai, StereoDepthConfig, PostProcessing, TemporalFilter, PersistencyMode, VALID_8_OUT_OF_8))
.value("VALID_2_IN_LAST_3",
StereoDepthConfig::PostProcessing::TemporalFilter::PersistencyMode::VALID_2_IN_LAST_3,
DOC(dai, StereoDepthConfig, PostProcessing, TemporalFilter, PersistencyMode, VALID_2_IN_LAST_3))
.value("VALID_2_IN_LAST_4",
StereoDepthConfig::PostProcessing::TemporalFilter::PersistencyMode::VALID_2_IN_LAST_4,
DOC(dai, StereoDepthConfig, PostProcessing, TemporalFilter, PersistencyMode, VALID_2_IN_LAST_4))
.value("VALID_2_OUT_OF_8",
StereoDepthConfig::PostProcessing::TemporalFilter::PersistencyMode::VALID_2_OUT_OF_8,
DOC(dai, StereoDepthConfig, PostProcessing, TemporalFilter, PersistencyMode, VALID_2_OUT_OF_8))
.value("VALID_1_IN_LAST_2",
StereoDepthConfig::PostProcessing::TemporalFilter::PersistencyMode::VALID_1_IN_LAST_2,
DOC(dai, StereoDepthConfig, PostProcessing, TemporalFilter, PersistencyMode, VALID_1_IN_LAST_2))
.value("VALID_1_IN_LAST_5",
StereoDepthConfig::PostProcessing::TemporalFilter::PersistencyMode::VALID_1_IN_LAST_5,
DOC(dai, StereoDepthConfig, PostProcessing, TemporalFilter, PersistencyMode, VALID_1_IN_LAST_5))
.value("VALID_1_IN_LAST_8",
StereoDepthConfig::PostProcessing::TemporalFilter::PersistencyMode::VALID_1_IN_LAST_8,
DOC(dai, StereoDepthConfig, PostProcessing, TemporalFilter, PersistencyMode, VALID_1_IN_LAST_8))
.value("PERSISTENCY_INDEFINITELY",
StereoDepthConfig::PostProcessing::TemporalFilter::PersistencyMode::PERSISTENCY_INDEFINITELY,
DOC(dai, StereoDepthConfig, PostProcessing, TemporalFilter, PersistencyMode, PERSISTENCY_INDEFINITELY));

temporalFilter.def(py::init<>())
.def_readwrite(
"enable", &StereoDepthConfig::PostProcessing::TemporalFilter::enable, DOC(dai, StereoDepthConfig, PostProcessing, TemporalFilter, enable))
.def_readwrite("persistencyMode",
&StereoDepthConfig::PostProcessing::TemporalFilter::persistencyMode,
DOC(dai, StereoDepthConfig, PostProcessing, TemporalFilter, persistencyMode))
.def_readwrite("alpha", &StereoDepthConfig::PostProcessing::TemporalFilter::alpha, DOC(dai, StereoDepthConfig, PostProcessing, TemporalFilter, alpha))
.def_readwrite("delta", &StereoDepthConfig::PostProcessing::TemporalFilter::delta, DOC(dai, StereoDepthConfig, PostProcessing, TemporalFilter, delta));

thresholdFilter.def(py::init<>())
.def_readwrite(
"minRange", &StereoDepthConfig::PostProcessing::ThresholdFilter::minRange, DOC(dai, StereoDepthConfig, PostProcessing, ThresholdFilter, minRange))
Expand All @@ -208,15 +143,6 @@ void bind_stereodepthconfig(pybind11::module& m, void* pCallstack) {
&StereoDepthConfig::PostProcessing::BrightnessFilter::maxBrightness,
DOC(dai, StereoDepthConfig, PostProcessing, BrightnessFilter, maxBrightness));

speckleFilter.def(py::init<>())
.def_readwrite("enable", &StereoDepthConfig::PostProcessing::SpeckleFilter::enable, DOC(dai, StereoDepthConfig, PostProcessing, SpeckleFilter, enable))
.def_readwrite("speckleRange",
&StereoDepthConfig::PostProcessing::SpeckleFilter::speckleRange,
DOC(dai, StereoDepthConfig, PostProcessing, SpeckleFilter, speckleRange))
.def_readwrite("differenceThreshold",
&StereoDepthConfig::PostProcessing::SpeckleFilter::differenceThreshold,
DOC(dai, StereoDepthConfig, PostProcessing, SpeckleFilter, differenceThreshold));

decimationMode
.value("PIXEL_SKIPPING",
StereoDepthConfig::PostProcessing::DecimationFilter::DecimationMode::PIXEL_SKIPPING,
Expand Down Expand Up @@ -375,8 +301,6 @@ void bind_stereodepthconfig(pybind11::module& m, void* pCallstack) {
.def_readwrite("costMatching", &StereoDepthConfig::costMatching, DOC(dai, StereoDepthConfig, costMatching))
.def_readwrite("costAggregation", &StereoDepthConfig::costAggregation, DOC(dai, StereoDepthConfig, costAggregation))
.def_readwrite("confidenceMetrics", &StereoDepthConfig::confidenceMetrics, DOC(dai, StereoDepthConfig, confidenceMetrics));
// legacy
m.attr("StereoDepthConfig").attr("MedianFilter") = medianFilter;

// Message
stereoDepthConfig.def(py::init<>())
Expand Down Expand Up @@ -416,7 +340,6 @@ void bind_stereodepthconfig(pybind11::module& m, void* pCallstack) {
py::arg("filtersBackend"),
DOC(dai, StereoDepthConfig, setFiltersComputeBackend))
.def("getFiltersComputeBackend", &StereoDepthConfig::getFiltersComputeBackend, DOC(dai, StereoDepthConfig, getFiltersComputeBackend));
m.attr("StereoDepthConfig").attr("MedianFilter") = medianFilter;
m.attr("StereoDepthConfig").attr("AlgorithmControl") = algorithmControl;
m.attr("StereoDepthConfig").attr("PostProcessing") = postProcessing;
m.attr("StereoDepthConfig").attr("CensusTransform") = censusTransform;
Expand Down
Loading
Loading