• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5<title>segmentation: GStreamer Bad Plugins 1.0 Plugins Reference Manual</title>
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Plugins Reference Manual">
8<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
9<link rel="prev" href="gst-plugins-bad-plugins-sdpsrc.html" title="sdpsrc">
10<link rel="next" href="gst-plugins-bad-plugins-sfdec.html" title="sfdec">
11<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
12<link rel="stylesheet" href="style.css" type="text/css">
13</head>
14<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16<td width="100%" align="left" class="shortcuts">
17<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span18                  <a href="#gst-plugins-bad-plugins-segmentation.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span19                  <a href="#gst-plugins-bad-plugins-segmentation.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span20                  <a href="#gst-plugins-bad-plugins-segmentation.properties" class="shortcut">Properties</a></span>
21</td>
22<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
23<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24<td><a accesskey="p" href="gst-plugins-bad-plugins-sdpsrc.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25<td><a accesskey="n" href="gst-plugins-bad-plugins-sfdec.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
26</tr></table>
27<div class="refentry">
28<a name="gst-plugins-bad-plugins-segmentation"></a><div class="titlepage"></div>
29<div class="refnamediv"><table width="100%"><tr>
30<td valign="top">
31<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-segmentation.top_of_page"></a>segmentation</span></h2>
32<p>segmentation</p>
33</td>
34<td class="gallery_image" valign="top" align="right"></td>
35</tr></table></div>
36<div class="refsect1">
37<a name="gst-plugins-bad-plugins-segmentation.properties"></a><h2>Properties</h2>
38<div class="informaltable"><table class="informaltable" border="0">
39<colgroup>
40<col width="150px" class="properties_type">
41<col width="300px" class="properties_name">
42<col width="200px" class="properties_flags">
43</colgroup>
44<tbody>
45<tr>
46<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td>
47<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-segmentation.html#GstSegmentation--learning-rate" title="The “learning-rate” property">learning-rate</a></td>
48<td class="property_flags">Read / Write</td>
49</tr>
50<tr>
51<td class="property_type"><span class="type">GstSegmentationMethod</span></td>
52<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-segmentation.html#GstSegmentation--method" title="The “method” property">method</a></td>
53<td class="property_flags">Read / Write</td>
54</tr>
55<tr>
56<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
57<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-segmentation.html#GstSegmentation--test-mode" title="The “test-mode” property">test-mode</a></td>
58<td class="property_flags">Read / Write</td>
59</tr>
60</tbody>
61</table></div>
62</div>
63<a name="GstSegmentation"></a><div class="refsect1">
64<a name="gst-plugins-bad-plugins-segmentation.other"></a><h2>Types and Values</h2>
65<div class="informaltable"><table class="informaltable" width="100%" border="0">
66<colgroup>
67<col width="150px" class="name">
68<col class="description">
69</colgroup>
70<tbody><tr>
71<td class="datatype_keyword">struct</td>
72<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-segmentation.html#GstSegmentation-struct" title="struct GstSegmentation">GstSegmentation</a></td>
73</tr></tbody>
74</table></div>
75</div>
76<div class="refsect1">
77<a name="gst-plugins-bad-plugins-segmentation.object-hierarchy"></a><h2>Object Hierarchy</h2>
78<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
79    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
80        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
81            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
82                <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a>
83                    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstVideoFilter.html#GstVideoFilter-struct">GstVideoFilter</a>
84                        <span class="lineart">╰──</span> GstOpencvVideoFilter
85                            <span class="lineart">╰──</span> GstSegmentation
86</pre>
87</div>
88<div class="refsect1">
89<a name="gst-plugins-bad-plugins-segmentation.description"></a><h2>Description</h2>
90<p>This element creates and updates a fg/bg model using one of several approaches.
91The one called "codebook" refers to the codebook approach following the opencv
92O'Reilly book [1] implementation of the algorithm described in K. Kim,
93T. H. Chalidabhongse, D. Harwood and L. Davis [2]. BackgroundSubtractorMOG [3],
94or MOG for shorts, refers to a Gaussian Mixture-based Background/Foreground
95Segmentation Algorithm. OpenCV MOG implements the algorithm described in [4].
96BackgroundSubtractorMOG2 [5], refers to another Gaussian Mixture-based
97Background/Foreground segmentation algorithm. OpenCV MOG2 implements the
98algorithm described in [6] and [7].</p>
99<p>[1] Learning OpenCV: Computer Vision with the OpenCV Library by Gary Bradski
100and Adrian Kaehler, Published by O'Reilly Media, October 3, 2008
101[2] "Real-time Foreground-Background Segmentation using Codebook Model",
102Real-time Imaging, Volume 11, Issue 3, Pages 167-256, June 2005.
103[3] http://opencv.itseez.com/modules/video/doc/motion_analysis_and_object_tracking.html<span class="type">backgroundsubtractormog</span>
104[4] P. KadewTraKuPong and R. Bowden, "An improved adaptive background
105mixture model for real-time tracking with shadow detection", Proc. 2nd
106European Workshop on Advanced Video-Based Surveillance Systems, 2001
107[5] http://opencv.itseez.com/modules/video/doc/motion_analysis_and_object_tracking.html<span class="type">backgroundsubtractormog2</span>
108[6] Z.Zivkovic, "Improved adaptive Gausian mixture model for background
109subtraction", International Conference Pattern Recognition, UK, August, 2004.
110[7] Z.Zivkovic, F. van der Heijden, "Efficient Adaptive Density Estimation
111per Image Pixel for the Task of Background Subtraction", Pattern Recognition
112Letters, vol. 27, no. 7, pages 773-780, 2006.</p>
113<div class="refsect2">
114<a name="id-1.2.194.7.4"></a><h3>Example launch line</h3>
115<div class="informalexample">
116  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
117    <tbody>
118      <tr>
119        <td class="listing_lines" align="right"><pre>1</pre></td>
120        <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span>  v4l2src device<span class="gtkdoc opt">=/</span>dev<span class="gtkdoc opt">/</span>video0 <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> segmentation test<span class="gtkdoc opt">-</span>mode<span class="gtkdoc opt">=</span><span class="keyword">true</span> method<span class="gtkdoc opt">=</span><span class="number">2</span> <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> ximagesink</pre></td>
121      </tr>
122    </tbody>
123  </table>
124</div>
125
126</div>
127<div class="refsynopsisdiv">
128<h2>Synopsis</h2>
129<div class="refsect2">
130<a name="id-1.2.194.7.5.1"></a><h3>Element Information</h3>
131<div class="variablelist"><table border="0" class="variablelist">
132<colgroup>
133<col align="left" valign="top">
134<col>
135</colgroup>
136<tbody>
137<tr>
138<td><p><span class="term">plugin</span></p></td>
139<td>
140            <a class="link" href="gst-plugins-bad-plugins-plugin-opencv.html#plugin-opencv">opencv</a>
141          </td>
142</tr>
143<tr>
144<td><p><span class="term">author</span></p></td>
145<td>Miguel Casas-Sanchez &lt;miguelecasassanchez@gmail.com&gt;</td>
146</tr>
147<tr>
148<td><p><span class="term">class</span></p></td>
149<td>Filter/Effect/Video</td>
150</tr>
151</tbody>
152</table></div>
153</div>
154<hr>
155<div class="refsect2">
156<a name="id-1.2.194.7.5.2"></a><h3>Element Pads</h3>
157<div class="variablelist"><table border="0" class="variablelist">
158<colgroup>
159<col align="left" valign="top">
160<col>
161</colgroup>
162<tbody>
163<tr>
164<td><p><span class="term">name</span></p></td>
165<td>sink</td>
166</tr>
167<tr>
168<td><p><span class="term">direction</span></p></td>
169<td>sink</td>
170</tr>
171<tr>
172<td><p><span class="term">presence</span></p></td>
173<td>always</td>
174</tr>
175<tr>
176<td><p><span class="term">details</span></p></td>
177<td>video/x-raw, format=(string)RGBA, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
178</tr>
179</tbody>
180</table></div>
181<div class="variablelist"><table border="0" class="variablelist">
182<colgroup>
183<col align="left" valign="top">
184<col>
185</colgroup>
186<tbody>
187<tr>
188<td><p><span class="term">name</span></p></td>
189<td>src</td>
190</tr>
191<tr>
192<td><p><span class="term">direction</span></p></td>
193<td>source</td>
194</tr>
195<tr>
196<td><p><span class="term">presence</span></p></td>
197<td>always</td>
198</tr>
199<tr>
200<td><p><span class="term">details</span></p></td>
201<td>video/x-raw, format=(string)RGBA, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
202</tr>
203</tbody>
204</table></div>
205</div>
206</div>
207</div>
208<div class="refsect1">
209<a name="gst-plugins-bad-plugins-segmentation.functions_details"></a><h2>Functions</h2>
210<p></p>
211</div>
212<div class="refsect1">
213<a name="gst-plugins-bad-plugins-segmentation.other_details"></a><h2>Types and Values</h2>
214<div class="refsect2">
215<a name="GstSegmentation-struct"></a><h3>struct GstSegmentation</h3>
216<pre class="programlisting">struct GstSegmentation;</pre>
217</div>
218</div>
219<div class="refsect1">
220<a name="gst-plugins-bad-plugins-segmentation.property-details"></a><h2>Property Details</h2>
221<div class="refsect2">
222<a name="GstSegmentation--learning-rate"></a><h3>The <code class="literal">“learning-rate”</code> property</h3>
223<pre class="programlisting">  “learning-rate”            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre>
224<p>Speed with which a motionless foreground pixel would become background (inverse of number of frames).</p>
225<p>Flags: Read / Write</p>
226<p>Allowed values: [0,1]</p>
227<p>Default value: 0.01</p>
228</div>
229<hr>
230<div class="refsect2">
231<a name="GstSegmentation--method"></a><h3>The <code class="literal">“method”</code> property</h3>
232<pre class="programlisting">  “method”                   <span class="type">GstSegmentationMethod</span></pre>
233<p>Segmentation method to use.</p>
234<p>Flags: Read / Write</p>
235<p>Default value: Mixture-of-Gaussians segmentation (Zivkovic2004)</p>
236</div>
237<hr>
238<div class="refsect2">
239<a name="GstSegmentation--test-mode"></a><h3>The <code class="literal">“test-mode”</code> property</h3>
240<pre class="programlisting">  “test-mode”                <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
241<p>If true, the output RGB is overwritten with the calculated foreground (white color).</p>
242<p>Flags: Read / Write</p>
243<p>Default value: FALSE</p>
244</div>
245</div>
246</div>
247<div class="footer">
248<hr>Generated by GTK-Doc V1.28</div>
249</body>
250</html>