CSubband Class Reference

PGF wavelet channel subband class. More...

#include <Subband.h>

List of all members.

Public Member Functions
	CSubband ()
	~CSubband ()
bool	AllocMemory ()
UINT32	BufferWidth () const
void	Dequantize (int quantParam, int level)
void	ExtractTile (CEncoder &encoder, int quant, bool tile=false, UINT32 tileX=0, UINT32 tileY=0) THROW_
void	FreeMemory ()
DataT *	GetBuffer ()
DataT	GetData (UINT32 pos) const
int	GetHeight () const
int	GetLevel () const
Orientation	GetOrientation () const
int	GetWidth () const
void	IncBuffRow (UINT32 pos)
void	PlaceTile (CDecoder &decoder, int quantParam, bool tile=false, UINT32 tileX=0, UINT32 tileY=0) THROW_
void	Quantize (int quantParam)
void	SetData (UINT32 pos, DataT v)

---

Detailed Description

PGF wavelet channel subband class.

Author:

C. Stamm, R. Spuler

Definition at line 36 of file Subband.h.

---

Constructor & Destructor Documentation

CSubband::CSubband

(

)

Standard constructor.

Definition at line 30 of file Subband.cpp.

CSubband::~CSubband

(

)

Destructor.

Definition at line 39 of file Subband.cpp.

---

Member Function Documentation

bool CSubband::AllocMemory

(

)

Allocate a memory buffer to store all wavelet coefficients of this subband.

Returns:

True if the allocation did work without any problems

Definition at line 64 of file Subband.cpp.

UINT32 CSubband::BufferWidth

(

)

const [inline]

Return data buffer line width.

Definition at line 135 of file Subband.h.

void CSubband::Dequantize	(	int	quantParam,
		int	level
	)

Perform subband dequantization with given quantization parameter.

A scalar quantization (with dead-zone) is used. A large quantization value results in strong quantization and therefore in big quality loss.

Parameters:

quantParam

A quantization parameter (larger or equal to 0) Level

A scalar quantization (with dead-zone) is used. A large quantization value results in strong quantization and therefore in big quality loss.

Parameters:

	quantParam	A quantization parameter (larger or equal to 0)
	level	Level

Definition at line 148 of file Subband.cpp.

void CSubband::ExtractTile	(	CEncoder &	encoder,
		int	quant,
		bool	tile = false,
		UINT32	tileX = 0,
		UINT32	tileY = 0
	)

Extracts a rectangular subregion of this subband.

Write wavelet coefficients into buffer. It might throw an IOException.

Parameters:

	encoder	An encoder instance
	quant	A quantization value (linear scalar quantization)
	tile	True if just a rectangular region is extracted, false if the entire subband is extracted.
	tileX	Tile index in x-direction
	tileY	Tile index in y-direction

Definition at line 172 of file Subband.cpp.

void CSubband::FreeMemory

(

)

Delete the memory buffer of this subband.

Definition at line 94 of file Subband.cpp.

DataT* CSubband::GetBuffer

(

)

[inline]

Get a pointer to an array of all wavelet coefficients of this subband.

Returns:

Pointer to array of wavelet coefficients

Definition at line 102 of file Subband.h.

DataT CSubband::GetData

(

UINT32

pos

)

const [inline]

Return wavelet coefficient at given position.

Parameters:

pos

A subband position (>= 0)

Returns:

Wavelet coefficient

Definition at line 108 of file Subband.h.

int CSubband::GetHeight

(

)

const [inline]

Return height of this subband.

Returns:

Height of this subband (in pixels)

Definition at line 118 of file Subband.h.

int CSubband::GetLevel

(

)

const [inline]

Return level of this subband.

Returns:

Level of this subband

Definition at line 113 of file Subband.h.

Orientation CSubband::GetOrientation

(

)

const [inline]

Return orientation of this subband.

LL LH HL HH

Returns:

Orientation of this subband (LL, HL, LH, HH)

Definition at line 130 of file Subband.h.

int CSubband::GetWidth

(

)

const [inline]

Return width of this subband.

Returns:

Width of this subband (in pixels)

Definition at line 123 of file Subband.h.

void CSubband::IncBuffRow

(

UINT32

pos

)

[inline]

Set data buffer position to given position + one row.

Parameters:

pos

Given position

Definition at line 140 of file Subband.h.

void CSubband::PlaceTile	(	CDecoder &	decoder,
		int	quantParam,
		bool	tile = false,
		UINT32	tileX = 0,
		UINT32	tileY = 0
	)

Decoding and dequantization of this subband.

It might throw an IOException.

Parameters:

	decoder	A decoder instance
	quantParam	Dequantization value
	tile	True if just a rectangular region is placed, false if the entire subband is placed.
	tileX	Tile index in x-direction
	tileY	Tile index in y-direction

Definition at line 200 of file Subband.cpp.

void CSubband::Quantize

(

int

quantParam

)

Perform subband quantization with given quantization parameter.

A scalar quantization (with dead-zone) is used. A large quantization value results in strong quantization and therefore in big quality loss.

Parameters:

quantParam

A quantization parameter (larger or equal to 0)

Definition at line 105 of file Subband.cpp.

void CSubband::SetData	(	UINT32	pos,
		DataT	v
	)			[inline]

Store wavelet coefficient in subband at given position.

Parameters:

	pos	A subband position (>= 0)
	v	A wavelet coefficient

Definition at line 97 of file Subband.h.

---

The documentation for this class was generated from the following files:

• Subband.h
• Subband.cpp