<!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="a00234.html">dirac</a>::<a class="el" href="a00142.html">SubbandList</a>
</div>
<div class="contents">
<h1>dirac::SubbandList Class Reference</h1><!-- doxytag: class="dirac::SubbandList" -->A class encapulating all the subbands produced by a transform.
<p>
<code>#include <<a class="el" href="a00233_source.html">wavelet_utils.h</a>></code>
<p>
<p>
<a href="a00333.html">List of all members.</a><h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="a00142.html#8c88c233907374705d6326ed92f58f25">SubbandList</a> ()
<dl class="el"><dd class="mdescRight">Constructor. <a href="#8c88c233907374705d6326ed92f58f25"></a><br></dl><li><a class="el" href="a00142.html#d0d0e2f4d752fe35830cc8feecd8e99b">~SubbandList</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <a href="#d0d0e2f4d752fe35830cc8feecd8e99b"></a><br></dl><li>void <a class="el" href="a00142.html#be021fbb7991f3fc71b1b709c7c09852">Init</a> (const int depth, const int xlen, const int ylen)
<dl class="el"><dd class="mdescRight">Initialise the list. <a href="#be021fbb7991f3fc71b1b709c7c09852"></a><br></dl><li>int <a class="el" href="a00142.html#b2854b1a2225a7352849c032fe3f9a92">Length</a> () const
<dl class="el"><dd class="mdescRight">Return the length of the subband list. <a href="#b2854b1a2225a7352849c032fe3f9a92"></a><br></dl><li><a class="el" href="a00140.html">Subband</a> & <a class="el" href="a00142.html#b45845c7135b76c36a099e32b0751a6f">operator()</a> (const int n)
<dl class="el"><dd class="mdescRight">Return the subband at position n (1<=n<=length). <a href="#b45845c7135b76c36a099e32b0751a6f"></a><br></dl><li>const <a class="el" href="a00140.html">Subband</a> & <a class="el" href="a00142.html#af26c146ce1b187e2eb4b2298831839e">operator()</a> (const int n) const
<dl class="el"><dd class="mdescRight">Return the subband at position n (1<=n<=length). <a href="#af26c146ce1b187e2eb4b2298831839e"></a><br></dl><li>void <a class="el" href="a00142.html#432ea85eae8503dba3805bcef16c2e7f">AddBand</a> (const <a class="el" href="a00140.html">Subband</a> &b)
<dl class="el"><dd class="mdescRight">Add a band to the list. <a href="#432ea85eae8503dba3805bcef16c2e7f"></a><br></dl><li>void <a class="el" href="a00142.html#d831463e1f627e5f8fc0d84d2f547d3a">Clear</a> ()
<dl class="el"><dd class="mdescRight">Remove all the bands from the list. <a href="#d831463e1f627e5f8fc0d84d2f547d3a"></a><br></dl></ul>
<h2>Private Member Functions</h2>
<ul>
<li>float <a class="el" href="a00142.html#3cf2b54b1bd10ac1e62372e89ebace46">PerceptualWeight</a> (const float xf, const float yf, const <a class="el" href="a00234.html#39dd89c4c7484412efd87d41548271cd">CompSort</a> cs)
<dl class="el"><dd class="mdescRight">Given x and y spatial frequencies in cycles per degree, returns a weighting value. <a href="#3cf2b54b1bd10ac1e62372e89ebace46"></a><br></dl></ul>
<h2>Private Attributes</h2>
<ul>
<li>std::vector< <a class="el" href="a00140.html">Subband</a> > <a class="el" href="a00142.html#167fb438179076bb9a8525e00ec41523">bands</a>
</ul>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="8c88c233907374705d6326ed92f58f25"></a><!-- doxytag: member="dirac::SubbandList::SubbandList" ref="8c88c233907374705d6326ed92f58f25" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dirac::SubbandList::SubbandList </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="d0d0e2f4d752fe35830cc8feecd8e99b"></a><!-- doxytag: member="dirac::SubbandList::~SubbandList" ref="d0d0e2f4d752fe35830cc8feecd8e99b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dirac::SubbandList::~SubbandList </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="432ea85eae8503dba3805bcef16c2e7f"></a><!-- doxytag: member="dirac::SubbandList::AddBand" ref="432ea85eae8503dba3805bcef16c2e7f" args="(const Subband &b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dirac::SubbandList::AddBand </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00140.html">Subband</a> & </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="a00233_source.html#l00313">bands</a>.</p>
</div>
</div><p>
<a class="anchor" name="d831463e1f627e5f8fc0d84d2f547d3a"></a><!-- doxytag: member="dirac::SubbandList::Clear" ref="d831463e1f627e5f8fc0d84d2f547d3a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dirac::SubbandList::Clear </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="a00233_source.html#l00313">bands</a>.</p>
</div>
</div><p>
<a class="anchor" name="be021fbb7991f3fc71b1b709c7c09852"></a><!-- doxytag: member="dirac::SubbandList::Init" ref="be021fbb7991f3fc71b1b709c7c09852" args="(const int depth, const int xlen, const int ylen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dirac::SubbandList::Init </td>
<td>(</td>
<td class="paramtype">const int </td>
<td class="paramname"> <em>depth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"> <em>xlen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"> <em>ylen</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="b2854b1a2225a7352849c032fe3f9a92"></a><!-- doxytag: member="dirac::SubbandList::Length" ref="b2854b1a2225a7352849c032fe3f9a92" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dirac::SubbandList::Length </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="a00233_source.html#l00313">bands</a>.</p>
</div>
</div><p>
<a class="anchor" name="af26c146ce1b187e2eb4b2298831839e"></a><!-- doxytag: member="dirac::SubbandList::operator()" ref="af26c146ce1b187e2eb4b2298831839e" args="(const int n) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00140.html">Subband</a>& dirac::SubbandList::operator() </td>
<td>(</td>
<td class="paramtype">const int </td>
<td class="paramname"> <em>n</em> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="a00233_source.html#l00313">bands</a>.</p>
</div>
</div><p>
<a class="anchor" name="b45845c7135b76c36a099e32b0751a6f"></a><!-- doxytag: member="dirac::SubbandList::operator()" ref="b45845c7135b76c36a099e32b0751a6f" args="(const int n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00140.html">Subband</a>& dirac::SubbandList::operator() </td>
<td>(</td>
<td class="paramtype">const int </td>
<td class="paramname"> <em>n</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="a00233_source.html#l00313">bands</a>.</p>
</div>
</div><p>
<a class="anchor" name="3cf2b54b1bd10ac1e62372e89ebace46"></a><!-- doxytag: member="dirac::SubbandList::PerceptualWeight" ref="3cf2b54b1bd10ac1e62372e89ebace46" args="(const float xf, const float yf, const CompSort cs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float dirac::SubbandList::PerceptualWeight </td>
<td>(</td>
<td class="paramtype">const float </td>
<td class="paramname"> <em>xf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const float </td>
<td class="paramname"> <em>yf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00234.html#39dd89c4c7484412efd87d41548271cd">CompSort</a> </td>
<td class="paramname"> <em>cs</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="167fb438179076bb9a8525e00ec41523"></a><!-- doxytag: member="dirac::SubbandList::bands" ref="167fb438179076bb9a8525e00ec41523" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector<<a class="el" href="a00140.html">Subband</a>> <a class="el" href="a00142.html#167fb438179076bb9a8525e00ec41523">dirac::SubbandList::bands</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="a00233_source.html#l00302">AddBand()</a>, <a class="el" href="a00233_source.html#l00305">Clear()</a>, <a class="el" href="a00233_source.html#l00293">Length()</a>, and <a class="el" href="a00233_source.html#l00296">operator()()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00233_source.html">wavelet_utils.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>
