dirac::Frame Class Reference

A class for encapsulating all the data relating to a frame. More...

#include <frame.h>

List of all members.

Public Member Functions

 Frame (const FrameParams &fp)
 Constructor.
 Frame (const Frame &cpy)
 Copy constructor. Private as not currently used [may want to implement reference counting later.].
virtual ~Frame ()
 Destructor.
Frameoperator= (const Frame &rhs)
 Assignment =. Private as not currently used [may want to implement reference counting later.].
const FrameParamsGetFparams () const
 Gets the frame parameters.
void SetFrameSort (const FrameSort fs)
 Sets the frame sort.
PicArrayYdata ()
 Returns the luma data array.
PicArrayUdata ()
 Returns the U component.
PicArrayVdata ()
 Returns the V component.
const PicArrayYdata () const
 Returns the luma data array.
const PicArrayUdata () const
 Returns the U component.
const PicArrayVdata () const
 Returns the V component.
PicArrayData (CompSort cs)
 Returns a given component.
const PicArrayData (CompSort cs) const
 Returns a given component.
PicArrayUpYdata ()
 Returns upconverted Y data.
PicArrayUpUdata ()
 Returns upconverted U data.
PicArrayUpVdata ()
 Returns upconverted V data.
PicArrayUpData (CompSort cs)
 Returns a given upconverted component.
const PicArrayUpYdata () const
 Returns upconverted Y data.
const PicArrayUpUdata () const
 Returns upconverted U data.
const PicArrayUpVdata () const
 Returns upconverted V data.
const PicArrayUpData (CompSort cs) const
 Returns a given upconverted component.
void Clip ()
 Clip the data to prevent overshoot.


Detailed Description

A class for encapsulating all the data relating to a frame.

A class for encapsulating all the data relating to a frame - all the component data, including upconverted data.

Definition at line 50 of file frame.h.


Constructor & Destructor Documentation

Frame::Frame const FrameParams fp  ) 
 

Constructor.

Constructor initialises the frame parameters and the data

Definition at line 50 of file frame.cpp.


Member Function Documentation

void Frame::Clip  ) 
 

Clip the data to prevent overshoot.

Clips the data to lie between 0 and 1020 (4*255) in 10-bit form to prevent overshoot/wraparound.

Definition at line 343 of file frame.cpp.

References dirac::FrameParams::CFormat().

Referenced by dirac::FrameCompressor::Compress(), and dirac::FrameDecompressor::Decompress().


The documentation for this class was generated from the following files:
Generated on Tue Dec 13 14:49:21 2005 for guliverkli by  doxygen 1.4.5