<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Dirac Video Codec</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<h1 align="center" color="#606080">
Dirac - A Video Codec
</h1>
<p align="center">
Created by the <a href="http://www.bbc.co.uk">British Broadcasting Corporation</a>.
</p>
<hr>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navpath"><a class="el" href="a00235.html">dirac_instr</a>::<a class="el" href="a00101.html">OverlayParams</a>
</div>
<div class="contents">
<h1>dirac_instr::OverlayParams Class Reference</h1><!-- doxytag: class="dirac_instr::OverlayParams" -->Class holding instrumentation overlay information.
<p>
<code>#include <<a class="el" href="a00207_source.html">overlay.h</a>></code>
<p>
<p>
<a href="a00389.html">List of all members.</a><h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="a00235.html#e4384603fcfba735dd9d69fab4fe1c1e">OverlayOption</a> <a class="el" href="a00101.html#df1914b342104341cec04c32bc4cc59d">Option</a> () const
<dl class="el"><dd class="mdescRight">Get functions. <a href="#df1914b342104341cec04c32bc4cc59d"></a><br></dl><li>int <a class="el" href="a00101.html#f4dec313cb4996a367a377f7451306e7">Reference</a> () const
<dl class="el"><dd class="mdescRight">Returns which reference is to be used. <a href="#f4dec313cb4996a367a377f7451306e7"></a><br></dl><li>int <a class="el" href="a00101.html#6b5994e118d93c4af488df8b69a39760">Background</a> () const
<dl class="el"><dd class="mdescRight">Returns true if input picture background is used, false if grey. <a href="#6b5994e118d93c4af488df8b69a39760"></a><br></dl><li>int <a class="el" href="a00101.html#f703b817f84dd70f5ccfc6ba69f6e2c7">Legend</a> () const
<dl class="el"><dd class="mdescRight">Returns true if colour legend is displayed. <a href="#f703b817f84dd70f5ccfc6ba69f6e2c7"></a><br></dl><li>int <a class="el" href="a00101.html#84d580207f6f5a169504e608ac58bf43">MvClip</a> () const
<dl class="el"><dd class="mdescRight">Returns clip value for motion vectors. <a href="#84d580207f6f5a169504e608ac58bf43"></a><br></dl><li>int <a class="el" href="a00101.html#1841347a546e26043996c0ac0495f9de">SADClip</a> () const
<dl class="el"><dd class="mdescRight">Returns clip value for sad. <a href="#1841347a546e26043996c0ac0495f9de"></a><br></dl><li>void <a class="el" href="a00101.html#e7143cc9bc59d59b7d26c0b087a3462e">SetOption</a> (<a class="el" href="a00235.html#e4384603fcfba735dd9d69fab4fe1c1e">OverlayOption</a> o)
<dl class="el"><dd class="mdescRight">Set functions. <a href="#e7143cc9bc59d59b7d26c0b087a3462e"></a><br></dl><li>void <a class="el" href="a00101.html#d4232d038298ddefb0e1bec6dd572125">SetReference</a> (int r)
<dl class="el"><dd class="mdescRight">Set which reference picture is to be used. <a href="#d4232d038298ddefb0e1bec6dd572125"></a><br></dl><li>void <a class="el" href="a00101.html#fa115846e3389b6974e658bf40d017c6">SetBackground</a> (bool b)
<dl class="el"><dd class="mdescRight">Set whether input picture or grey is used as background. <a href="#fa115846e3389b6974e658bf40d017c6"></a><br></dl><li>void <a class="el" href="a00101.html#9d1d67417d1e5a1b9eb9df2d34c7d17e">SetLegend</a> (bool l)
<dl class="el"><dd class="mdescRight">Set display of colour legend. <a href="#9d1d67417d1e5a1b9eb9df2d34c7d17e"></a><br></dl><li>void <a class="el" href="a00101.html#fecf15b85b95e91e50d5a873a593a3be">SetMvClip</a> (int c)
<dl class="el"><dd class="mdescRight">Set clip for motion vectors. <a href="#fecf15b85b95e91e50d5a873a593a3be"></a><br></dl><li>void <a class="el" href="a00101.html#3626ca88b1563662b4032db2b5bb6ee9">SetSADClip</a> (int c)
<dl class="el"><dd class="mdescRight">Set clip for sad. <a href="#3626ca88b1563662b4032db2b5bb6ee9"></a><br></dl></ul>
<h2>Private Attributes</h2>
<ul>
<li><a class="el" href="a00235.html#e4384603fcfba735dd9d69fab4fe1c1e">OverlayOption</a> <a class="el" href="a00101.html#6c95e9d4732fe1ddd26be9e6a47eb0bb">m_option</a>
<dl class="el"><dd class="mdescRight">Instrumentation command line option. <a href="#6c95e9d4732fe1ddd26be9e6a47eb0bb"></a><br></dl><li>int <a class="el" href="a00101.html#4f7fa0de32daf112742df9f8bfb98f44">m_ref</a>
<dl class="el"><dd class="mdescRight">Reference picture. <a href="#4f7fa0de32daf112742df9f8bfb98f44"></a><br></dl><li>bool <a class="el" href="a00101.html#3d95804b313b00d924666dbfdc0cc5da">m_bg</a>
<dl class="el"><dd class="mdescRight">Background - original luma or mid-grey. <a href="#3d95804b313b00d924666dbfdc0cc5da"></a><br></dl><li>bool <a class="el" href="a00101.html#b3001d15bfbb47d7771ea961830083fd">m_legend</a>
<dl class="el"><dd class="mdescRight">Instrumentation legend off. <a href="#b3001d15bfbb47d7771ea961830083fd"></a><br></dl><li>int <a class="el" href="a00101.html#60d4b819a7b9631ac8c648f614fb3846">m_mv_clip</a>
<dl class="el"><dd class="mdescRight">Motion vector clip value. <a href="#60d4b819a7b9631ac8c648f614fb3846"></a><br></dl><li>int <a class="el" href="a00101.html#0952b0dca95a612d37b414c0af148561">m_sad_clip</a>
<dl class="el"><dd class="mdescRight">SAD clip value. <a href="#0952b0dca95a612d37b414c0af148561"></a><br></dl></ul>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6b5994e118d93c4af488df8b69a39760"></a><!-- doxytag: member="dirac_instr::OverlayParams::Background" ref="6b5994e118d93c4af488df8b69a39760" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dirac_instr::OverlayParams::Background </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="a00207_source.html#l00127">m_bg</a>.</p>
</div>
</div><p>
<a class="anchor" name="f703b817f84dd70f5ccfc6ba69f6e2c7"></a><!-- doxytag: member="dirac_instr::OverlayParams::Legend" ref="f703b817f84dd70f5ccfc6ba69f6e2c7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dirac_instr::OverlayParams::Legend </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="a00207_source.html#l00130">m_legend</a>.</p>
</div>
</div><p>
<a class="anchor" name="84d580207f6f5a169504e608ac58bf43"></a><!-- doxytag: member="dirac_instr::OverlayParams::MvClip" ref="84d580207f6f5a169504e608ac58bf43" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dirac_instr::OverlayParams::MvClip </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="a00207_source.html#l00133">m_mv_clip</a>.</p>
</div>
</div><p>
<a class="anchor" name="df1914b342104341cec04c32bc4cc59d"></a><!-- doxytag: member="dirac_instr::OverlayParams::Option" ref="df1914b342104341cec04c32bc4cc59d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00235.html#e4384603fcfba735dd9d69fab4fe1c1e">OverlayOption</a> dirac_instr::OverlayParams::Option </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
.. Returns instrumentation command line option
<p>References <a class="el" href="a00207_source.html#l00121">m_option</a>.</p>
</div>
</div><p>
<a class="anchor" name="f4dec313cb4996a367a377f7451306e7"></a><!-- doxytag: member="dirac_instr::OverlayParams::Reference" ref="f4dec313cb4996a367a377f7451306e7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dirac_instr::OverlayParams::Reference </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="a00207_source.html#l00124">m_ref</a>.</p>
</div>
</div><p>
<a class="anchor" name="1841347a546e26043996c0ac0495f9de"></a><!-- doxytag: member="dirac_instr::OverlayParams::SADClip" ref="1841347a546e26043996c0ac0495f9de" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dirac_instr::OverlayParams::SADClip </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="a00207_source.html#l00136">m_sad_clip</a>.</p>
</div>
</div><p>
<a class="anchor" name="fa115846e3389b6974e658bf40d017c6"></a><!-- doxytag: member="dirac_instr::OverlayParams::SetBackground" ref="fa115846e3389b6974e658bf40d017c6" args="(bool b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dirac_instr::OverlayParams::SetBackground </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>b</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="a00207_source.html#l00127">m_bg</a>.</p>
</div>
</div><p>
<a class="anchor" name="9d1d67417d1e5a1b9eb9df2d34c7d17e"></a><!-- doxytag: member="dirac_instr::OverlayParams::SetLegend" ref="9d1d67417d1e5a1b9eb9df2d34c7d17e" args="(bool l)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dirac_instr::OverlayParams::SetLegend </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>l</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="a00207_source.html#l00130">m_legend</a>.</p>
</div>
</div><p>
<a class="anchor" name="fecf15b85b95e91e50d5a873a593a3be"></a><!-- doxytag: member="dirac_instr::OverlayParams::SetMvClip" ref="fecf15b85b95e91e50d5a873a593a3be" args="(int c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dirac_instr::OverlayParams::SetMvClip </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>c</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="a00207_source.html#l00133">m_mv_clip</a>.</p>
</div>
</div><p>
<a class="anchor" name="e7143cc9bc59d59b7d26c0b087a3462e"></a><!-- doxytag: member="dirac_instr::OverlayParams::SetOption" ref="e7143cc9bc59d59b7d26c0b087a3462e" args="(OverlayOption o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dirac_instr::OverlayParams::SetOption </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00235.html#e4384603fcfba735dd9d69fab4fe1c1e">OverlayOption</a> </td>
<td class="paramname"> <em>o</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
.. Set type of instrumentation
<p>References <a class="el" href="a00207_source.html#l00121">m_option</a>.</p>
</div>
</div><p>
<a class="anchor" name="d4232d038298ddefb0e1bec6dd572125"></a><!-- doxytag: member="dirac_instr::OverlayParams::SetReference" ref="d4232d038298ddefb0e1bec6dd572125" args="(int r)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dirac_instr::OverlayParams::SetReference </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>r</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="a00207_source.html#l00124">m_ref</a>.</p>
</div>
</div><p>
<a class="anchor" name="3626ca88b1563662b4032db2b5bb6ee9"></a><!-- doxytag: member="dirac_instr::OverlayParams::SetSADClip" ref="3626ca88b1563662b4032db2b5bb6ee9" args="(int c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dirac_instr::OverlayParams::SetSADClip </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>c</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="a00207_source.html#l00136">m_sad_clip</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="3d95804b313b00d924666dbfdc0cc5da"></a><!-- doxytag: member="dirac_instr::OverlayParams::m_bg" ref="3d95804b313b00d924666dbfdc0cc5da" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="a00101.html#3d95804b313b00d924666dbfdc0cc5da">dirac_instr::OverlayParams::m_bg</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="a00207_source.html#l00089">Background()</a>, and <a class="el" href="a00207_source.html#l00108">SetBackground()</a>.</p>
</div>
</div><p>
<a class="anchor" name="b3001d15bfbb47d7771ea961830083fd"></a><!-- doxytag: member="dirac_instr::OverlayParams::m_legend" ref="b3001d15bfbb47d7771ea961830083fd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="a00101.html#b3001d15bfbb47d7771ea961830083fd">dirac_instr::OverlayParams::m_legend</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="a00207_source.html#l00092">Legend()</a>, and <a class="el" href="a00207_source.html#l00111">SetLegend()</a>.</p>
</div>
</div><p>
<a class="anchor" name="60d4b819a7b9631ac8c648f614fb3846"></a><!-- doxytag: member="dirac_instr::OverlayParams::m_mv_clip" ref="60d4b819a7b9631ac8c648f614fb3846" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="a00101.html#60d4b819a7b9631ac8c648f614fb3846">dirac_instr::OverlayParams::m_mv_clip</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="a00207_source.html#l00095">MvClip()</a>, and <a class="el" href="a00207_source.html#l00114">SetMvClip()</a>.</p>
</div>
</div><p>
<a class="anchor" name="6c95e9d4732fe1ddd26be9e6a47eb0bb"></a><!-- doxytag: member="dirac_instr::OverlayParams::m_option" ref="6c95e9d4732fe1ddd26be9e6a47eb0bb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00235.html#e4384603fcfba735dd9d69fab4fe1c1e">OverlayOption</a> <a class="el" href="a00101.html#6c95e9d4732fe1ddd26be9e6a47eb0bb">dirac_instr::OverlayParams::m_option</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="a00207_source.html#l00083">Option()</a>, and <a class="el" href="a00207_source.html#l00102">SetOption()</a>.</p>
</div>
</div><p>
<a class="anchor" name="4f7fa0de32daf112742df9f8bfb98f44"></a><!-- doxytag: member="dirac_instr::OverlayParams::m_ref" ref="4f7fa0de32daf112742df9f8bfb98f44" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="a00101.html#4f7fa0de32daf112742df9f8bfb98f44">dirac_instr::OverlayParams::m_ref</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="a00207_source.html#l00086">Reference()</a>, and <a class="el" href="a00207_source.html#l00105">SetReference()</a>.</p>
</div>
</div><p>
<a class="anchor" name="0952b0dca95a612d37b414c0af148561"></a><!-- doxytag: member="dirac_instr::OverlayParams::m_sad_clip" ref="0952b0dca95a612d37b414c0af148561" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="a00101.html#0952b0dca95a612d37b414c0af148561">dirac_instr::OverlayParams::m_sad_clip</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="a00207_source.html#l00098">SADClip()</a>, and <a class="el" href="a00207_source.html#l00117">SetSADClip()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00207_source.html">overlay.h</a></ul>
</div>
<hr>
<p align="center"><small>
© 2004 British Broadcasting Corporation.
Dirac code licensed under the <a href="http://www.mozilla.org/MPL/">Mozilla Public License (MPL) Version 1.1</a>.<br>
HTML documentation generated by Dimitri van Heesch's
excellent <a href="http://www.doxygen.org">Doxygen</a> tool.
</small></p>
</body>
</html>
