opencv/samples/python
Dave Merchant 0ee9c27966
Merge pull request #27810 from D00E:known-foreground-mask
2025-10-14T05:53:31.5387050Z C:\GHA-OCV-1\_work\ci-gha-workflow\ci-gha-workflow\opencv\modules\imgcodecs\src\bitstrm.cpp(156,57): warning C4244: 'argument': conversion from 'int64_t' to 'ptrdiff_t', possible loss of data [C:\GHA-OCV-1\_work\ci-gha-workflow\ci-gha-workflow\build\modules\imgcodecs\opencv_imgcodecs.vcxproj]

### Pull Request Readiness Checklist

Optional Known Foreground Mask for Background Subtractors #27810

See details at https://github.com/opencv/opencv/wiki/How_to_contribute#making-a-good-pull-request

- [x] I agree to contribute to the project under Apache 2 License.
- [x] To the best of my knowledge, the proposed patch is not based on a code under GPL or another license that is incompatible with OpenCV
- [x] The PR is proposed to the proper branch
- [x] There is a reference to the original bug report and related work
- [x] There is accuracy test, performance test and test data in opencv_extra repository, if applicable
      Patch to opencv_extra has the same branch name.
- [x] The feature is well documented and sample code can be built with the project CMake

### Description
This adds an optional foreground input mask parameter to the MOG2 and KNN background subtractors, in line with issue https://github.com/opencv/opencv/issues/26476

4 tests are added under test_bgfg2.cpp:
2 for each subtractor type (1 with shadow detection and 1 without)
A demo shows the feature with only 3 parameters and with a 4th optional foreground mask for both core subtractor types.

Note: To patch contrib inheritance of the background subtraction class, empty apply method which throws a not implemented error is added to contrib subclasses. This is done to keep the overloaded apply function as pure virtual. Contrib PR to be made and linked shortly.  
Contrib Repo Paired Pull Request: https://github.com/opencv/opencv_contrib/pull/4017
2025-10-14 09:56:06 +03:00
..
tutorial_code Updated Tutorial PSNR for identical images 2025-10-02 00:03:28 +01:00
_coverage.py python: 'cv2.' -> 'cv.' via 'import cv2 as cv' 2017-12-11 13:46:55 +03:00
_doc.py Define execfile, file, long, raw_input, xrange for Python 3 2018-05-03 09:19:05 +02:00
_run_winpack_demo.cmd samples: update Python launcher (winpack) 2018-11-15 23:36:26 +00:00
.gitignore rename samples/{python2 -> python} 2015-12-18 11:00:32 +03:00
aruco_detect_board_charuco.py Update aruco_detect_board_charuco.py 2023-05-05 13:23:09 -04:00
asift.py samples: fix python samples compatibility with demo.py 2019-03-20 18:32:34 +03:00
audio_spectrogram.py Merge pull request #20934 from SinM9:spectrogram_samples 2021-12-14 17:33:26 +00:00
background_subtractor_mask.py Merge pull request #27810 from D00E:known-foreground-mask 2025-10-14 09:56:06 +03:00
browse.py fix pylint warnings 2019-10-16 18:49:33 +03:00
calibrate.py Reworked calibrate.py 2023-06-23 22:19:08 +03:00
camera_calibration_show_extrinsics.py Update python samples 2022-01-24 11:13:56 +03:00
camshift.py Fixed Typo Closes #15148 2019-08-19 22:52:00 +05:30
CMakeLists.txt rename samples/{python2 -> python} 2015-12-18 11:00:32 +03:00
coherence.py samples: fix python samples compatibility with demo.py 2019-03-20 18:32:34 +03:00
color_histogram.py fix pylint warnings 2019-10-16 18:49:33 +03:00
common.py Update python samples 2022-01-24 11:13:56 +03:00
contours.py Merge remote-tracking branch 'upstream/3.4' into merge-3.4 2019-03-22 19:31:31 +03:00
deconvolution.py Fix spelling typos 2019-12-27 12:46:53 +00:00
demo.py build: updates for winpack dldt 2020-03-31 22:18:21 +00:00
dft.py samples: fix python samples compatibility with demo.py 2019-03-20 18:32:34 +03:00
digits_adjust.py samples: fix python samples compatibility with demo.py 2019-03-20 18:32:34 +03:00
digits_video.py Merge remote-tracking branch 'upstream/3.4' into merge-3.4 2022-01-31 12:53:45 +00:00
digits.py Update python samples 2022-01-24 11:13:56 +03:00
dis_opt_flow.py pylint: eliminate warnings 2019-11-01 18:59:35 +03:00
distrans.py samples: fix python samples compatibility with demo.py 2019-03-20 18:32:34 +03:00
drawing.py Fix coordinate generation in drawing sample 2025-06-09 23:43:34 +05:30
edge.py fix pylint warnings 2019-10-16 18:49:33 +03:00
essential_mat_reconstr.py Merge pull request #17683 from ivashmak:homography 2020-08-14 22:42:26 +00:00
facedetect.py Update python samples 2022-01-24 11:13:56 +03:00
feature_homography.py python: 'cv2.' -> 'cv.' via 'import cv2 as cv' 2017-12-11 13:46:55 +03:00
find_obj.py prevent index error in find_obj sample 2021-12-23 11:29:27 +03:00
fitline.py fix pylint warnings 2019-10-16 18:49:33 +03:00
floodfill.py samples: fix python samples compatibility with demo.py 2019-03-20 18:32:34 +03:00
gabor_threads.py samples: fix python samples compatibility with demo.py 2019-03-20 18:32:34 +03:00
gaussian_mix.py fix samples 2021-07-01 18:26:17 +03:00
grabcut.py Minor update in grabcut.py 2020-02-20 16:19:24 +03:00
hist.py fix samples 2021-07-01 18:26:17 +03:00
houghcircles.py Update houghcircles.py 2025-04-25 15:39:50 +08:00
houghlines.py fix pylint warnings 2019-10-16 18:49:33 +03:00
inpaint.py samples: fix python samples compatibility with demo.py 2019-03-20 18:32:34 +03:00
kalman.py Merge pull request #20564 from AleksandrPanov:update_kalman_sample 2021-08-20 10:57:05 +00:00
kmeans.py fix pylint warnings 2019-10-16 18:49:33 +03:00
laplace.py Merge pull request #14107 from adityak2920:aditya 2020-02-20 15:41:55 +03:00
lappyr.py fix pylint warnings 2019-10-16 18:49:33 +03:00
letter_recog.py samples: fix python samples compatibility with demo.py 2019-03-20 18:32:34 +03:00
lk_homography.py fix samples 3.4 2021-06-30 12:50:21 +03:00
lk_track.py fix samples 3.4 2021-06-30 12:50:21 +03:00
logpolar.py samples: fix python samples compatibility with demo.py 2019-03-20 18:32:34 +03:00
morphology.py Add MORPH_DIAMOND support to samples and tutorials 2025-06-27 21:09:53 +05:30
mosse.py minor changes : Replace ndarray.ptp() with np.ptp() for NumPy 2.0 Compatibility 2025-03-23 23:38:33 +05:30
mouse_and_match.py Merge pull request #23108 from crackwitz:issue-23107 2023-01-09 09:55:31 +00:00
mser.py samples: fix python samples compatibility with demo.py 2019-03-20 18:32:34 +03:00
opencv_version.py samples: fix python samples compatibility with demo.py 2019-03-20 18:32:34 +03:00
opt_flow.py fix pylint warnings 2019-10-16 18:49:33 +03:00
peopledetect.py fix pylint warnings 2019-10-16 18:49:33 +03:00
plane_ar.py Misc. ./samples typos 2018-02-08 05:52:08 -05:00
plane_tracker.py python: 'cv2.' -> 'cv.' via 'import cv2 as cv' 2017-12-11 13:46:55 +03:00
qrcode.py Added Aruco-based QR code detection method to python sample. 2023-06-13 15:38:26 +03:00
squares.py Update samples 2019-09-20 18:03:26 +03:00
stereo_match.py fix pylint warnings 2019-10-16 18:49:33 +03:00
stitching_detailed.py add GraphCutSeamFinder 2023-01-03 22:45:49 +01:00
stitching.py Added python branch to stitching tutorial. 2024-08-19 16:28:15 +03:00
text_skewness_correction.py Update python samples 2022-01-24 11:13:56 +03:00
texture_flow.py samples: fix python samples compatibility with demo.py 2019-03-20 18:32:34 +03:00
tracker.py sample: tracker parameters updated 2024-09-14 23:36:57 +03:00
tst_scene_render.py Merge pull request #24116 from chaebkimm/update-samples-python-tst_scene_render 2023-08-09 13:46:25 +03:00
turing.py minor changes : Replace ndarray.ptp() with np.ptp() for NumPy 2.0 Compatibility 2025-03-23 23:38:33 +05:30
video_threaded.py fix pylint warnings 2019-10-16 18:49:33 +03:00
video_v4l2.py fix samples 3.4 2021-06-30 12:50:21 +03:00
video.py Removed deprecated 'clock' import. 2019-12-30 13:00:29 +00:00
videocapture_obsensor.py Merge pull request #23531 from kaingwade:orbbec_python_sample 2023-04-24 12:12:01 +03:00
watershed.py samples: fix python samples compatibility with demo.py 2019-03-20 18:32:34 +03:00