Dirac - A Video Codec

Created by the British Broadcasting Corporation.


Public Member Functions | Private Attributes
dirac::PicArray Class Reference

A class for picture component data. More...

#include <common.h>

Inheritance diagram for dirac::PicArray:
Inheritance graph
[legend]
Collaboration diagram for dirac::PicArray:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 PicArray ()
 Default constructor.
 PicArray (int height, int width, CompSort cs=Y_COMP)
 Constructor.
 ~PicArray ()
 Destructor.
const CompSortCSort () const
 Return which component is stored.
void SetCSort (const CompSort cs)
 Set the type of component being stored.
- Public Member Functions inherited from dirac::TwoDArray< ValueType >
 TwoDArray ()
 Default constructor.
 TwoDArray (const int height, const int width)
 Constructor.
 TwoDArray (const int height, const int width, ValueTypeval)
 Constructor.
 TwoDArray (const TwoDArray< ValueType > &Cpy)
 Copy constructor.
virtual ~TwoDArray ()
 Destructor.
TwoDArray< ValueType > & operator= (const TwoDArray< ValueType > &rhs)
 Assignment =.
bool CopyContents (TwoDArray< ValueType > &out) const
 Copy Contents.
void Fill (ValueTypeval)
 Fill contents.
void Resize (const int height, const int width)
 Resizes the array, deleting the current data.
element_type & operator[] (const int pos)
 Element access.
const element_type & operator[] (const int pos) const
 Element access.
int LengthX () const
 Returns the width.
int LengthY () const
 Returns the height.
int FirstX () const
 Returns the index of the first element of a row.
int FirstY () const
 Returns the index of the first element of a column.
int LastX () const
 Returns the index of the last element of a row.
int LastY () const
 Returns the index of the first element of a column.

Private Attributes

CompSort m_csort

Detailed Description

A class for encapsulating picture data, derived from TwoDArray.


Constructor & Destructor Documentation

dirac::PicArray::PicArray ( )
inline

Default constructor creates an empty array.

dirac::PicArray::PicArray ( int  height,
int  width,
CompSort  cs = Y_COMP 
)
inline

Contructor creates a two-D array, with specified size and colour format.

dirac::PicArray::~PicArray ( )
inline

Member Function Documentation

const CompSort& dirac::PicArray::CSort ( ) const
inline

References m_csort.

void dirac::PicArray::SetCSort ( const CompSort  cs)
inline

References m_csort.


Member Data Documentation

CompSort dirac::PicArray::m_csort
private

Referenced by CSort(), and SetCSort().


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.