Dirac - A Video Codec
Created by the British Broadcasting Corporation.
dirac::Subband Class Reference
Class encapsulating all the metadata relating to a wavelet subband.
#include <wavelet_utils.h>
Collaboration diagram for dirac::Subband:
[legend]List of all members.Public Member Functions
- Subband ()
- Default constructor.
- Subband (int xpos, int ypos, int xlen, int ylen)
- Constructor.
- Subband (int xpos, int ypos, int xlen, int ylen, int d)
- Constructor.
- ~Subband ()
- Destructor.
- int Xl () const
- Return the width of the subband.
- int Xp () const
- Return the horizontal position of the subband.
- int Yl () const
- Return the height of the subband.
- int Yp () const
- Return the vertical position of the subband.
- int Max () const
- Return the index of the maximum bit of the largest coefficient.
- double Wt () const
- Return the subband perceptual weight.
- int Depth () const
- Return the depth of the subband in the transform.
- int Scale () const
- Return the scale of the subband, viewed as a subsampled version of the picture.
- int QIndex () const
- Return a quantisation factor.
- bool UsingMultiQuants () const
- Return a flag indicating whether we have separate quantisers for each code block.
- int Parent () const
- Return the index of the parent subband.
- const std::vector< int > & Children () const
- Return the indices of any child subbands.
- int Child (const int n) const
- Return the index of a specific child band.
- TwoDArray< CodeBlock > & GetCodeBlocks ()
- Return the code blocks.
- const TwoDArray< CodeBlock > & GetCodeBlocks () const
- Return the code blocks.
- bool Skipped () const
- Returns true if subband is skipped, false if not.
- void SetWt (const float w)
- Set the perceptual weight.
- void SetParent (const int p)
- Set the parent index.
- void SetDepth (const int d)
- Set the subband depth.
- void SetMax (const int m)
- Set the index of the maximum bit of the largest coefficient.
- void SetChildren (const std::vector< int > &clist)
- Set the indices of the children of the subband.
- void AddChild (const int c)
- Add a child to the list of child subbands.
- void SetNumBlocks (const int ynum, const int xnum)
- Set the number of (spatial) quantisers in the subband. Creates code block structure.
- void SetQIndex (const int idx)
- Set the quantisation index.
- void SetUsingMultiQuants (const bool multi)
- Set the number of (spatial) quantisers in the subband. Creates code block structure.
- void SetSkip (const bool skip)
- Set whether the subband is skipped or not.
Private Attributes
Constructor & Destructor Documentation
dirac::Subband::Subband |
( |
|
) |
|
|
dirac::Subband::Subband |
( |
int |
xpos, |
|
|
int |
ypos, |
|
|
int |
xlen, |
|
|
int |
ylen |
|
) |
|
|
|
The constructor parameters are - Parameters:
-
| xpos | the xposition of the subband when packed into a big array with all the others |
| ypos | the xposition of the subband |
| xlen | the width of the subband |
| ylen | the height of the subband |
|
dirac::Subband::Subband |
( |
int |
xpos, |
|
|
int |
ypos, |
|
|
int |
xlen, |
|
|
int |
ylen, |
|
|
int |
d |
|
) |
|
|
|
The constructor parameters are - Parameters:
-
| xpos | the xposition of the subband when packed into a big array with all the others |
| ypos | the xposition of the subband |
| xlen | the width of the subband |
| ylen | the height of the subband |
| d | the depth of the subband in the wavelet transform |
|
dirac::Subband::~Subband |
( |
|
) |
|
|
Member Function Documentation
void dirac::Subband::AddChild |
( |
const int |
c |
) |
[inline] |
|
int dirac::Subband::Child |
( |
const int |
n |
) |
const [inline] |
|
const std::vector<int>& dirac::Subband::Children |
( |
|
) |
const [inline] |
|
int dirac::Subband::Depth |
( |
|
) |
const [inline] |
|
int dirac::Subband::Max |
( |
|
) |
const [inline] |
|
int dirac::Subband::Parent |
( |
|
) |
const [inline] |
|
int dirac::Subband::QIndex |
( |
|
) |
const [inline] |
|
int dirac::Subband::Scale |
( |
|
) |
const [inline] |
|
void dirac::Subband::SetChildren |
( |
const std::vector< int > & |
clist |
) |
[inline] |
|
void dirac::Subband::SetDepth |
( |
const int |
d |
) |
[inline] |
|
void dirac::Subband::SetMax |
( |
const int |
m |
) |
[inline] |
|
void dirac::Subband::SetNumBlocks |
( |
const int |
ynum, |
|
|
const int |
xnum |
|
) |
|
|
void dirac::Subband::SetParent |
( |
const int |
p |
) |
[inline] |
|
void dirac::Subband::SetQIndex |
( |
const int |
idx |
) |
[inline] |
|
void dirac::Subband::SetSkip |
( |
const bool |
skip |
) |
[inline] |
|
void dirac::Subband::SetUsingMultiQuants |
( |
const bool |
multi |
) |
[inline] |
|
void dirac::Subband::SetWt |
( |
const float |
w |
) |
|
|
bool dirac::Subband::Skipped |
( |
|
) |
const [inline] |
|
bool dirac::Subband::UsingMultiQuants |
( |
|
) |
const [inline] |
|
double dirac::Subband::Wt |
( |
|
) |
const [inline] |
|
int dirac::Subband::Xl |
( |
|
) |
const [inline] |
|
int dirac::Subband::Xp |
( |
|
) |
const [inline] |
|
int dirac::Subband::Yl |
( |
|
) |
const [inline] |
|
int dirac::Subband::Yp |
( |
|
) |
const [inline] |
|
Member Data Documentation
The documentation for this class was generated from the following file:
© 2004 British Broadcasting Corporation.
Dirac code licensed under the Mozilla Public License (MPL) Version 1.1.
HTML documentation generated by Dimitri van Heesch's
excellent Doxygen tool.