Classes
class	AviReader
class	AviWriter
class	CoeffInformation
class	ColorBuffer
class	ColorImage
class	ColorVideo
class	ColumnVector
class	FileName
class	FullVector
class	GreymapFile
class	GreymapReader
class	GreymapWriter
class	ResizeFillFunc
class	Image
class	ImageArray< T >
class	ImageVector
class	JpgReader
class	JpgWriter
class	PfcReader
class	PfcWriter
class	PfgReader
class	PfgWriter
class	PgmReader
class	PgmWriter
class	PixmapFile
class	PixmapReader
class	PixmapWriter
class	PpmReader
class	PpmWriter
class	RawReader
class	RawWriter
class	ReferenceVector
class	RowVector
class	StillImage
class	VideoArray< T >
class	VideoFile
class	VideoFrame
class	VideoReader
class	VideoWriter
class	VidReader
class	VidWriter
Defines
#define	DPRINTF(x)
#define	NEW(a) new a
#define	DELETE(a) delete (a), (a) = NULL
#define	DELETEAR(a) delete [] (a), (a) = NULL
#define	DELETENOTNULL(a) if (a) { DELETE (a); } else {}
#define	DELETENOTNULLAR(a) if (a) { DELETEAR (a); } else {}
#define	COEFF_EPSILON ((coeff)DBL_EPSILON)
#define	COEFF_MAX ((coeff)DBL_MAX)
#define	COEFF_MIN ((coeff)DBL_MIN)
#define	MIN(x, y) ((x) < (y)? (x): (y))
#define	MAX(x, y) ((x) > (y)? (x): (y))
#define	DIV2(x) ((unsigned)(x)>>1u)
#define	MUL2(x) ((unsigned)(x)<<1u)
#define	TWOPOW(n) (1u<<(unsigned)(n))
#define	SQUARE(n) ((n)*(n))
#define	FMT0 0
Typedefs
typedef unsigned char	pixel
typedef double	coeff
Enumerations
enum	filetype { fn_pgm, fn_raw, fn_pfi, fn_ppm, fn_jpg, fn_vid, fn_avi, fn_png, fn_gif, fn_unknown }
enum	ExtendFunc { ef_mirror, ef_outerBorder }
enum	area { LL = 0, HL, LH, HH, areaINVALID }
enum	clrmodel { cm_rgb, cm_yuv, cm_grey, cm_unknown }
enum	yuv { yuv_y = 0, yuv_u, yuv_v, yuv_unknown }
enum	rgb { rgb_r = 0, rgb_g, rgb_b, rgb_unknown }
Functions
pixel *	ppm_read (const char fname, int height, int width, int cmax)
pixel	tools_coeff2pixel (coeff c)
int	tools_coeff2int (coeff c)
bool	tools_equals (double d1, double d2)
bool	tools_epsilons (double d1, double d2, double epsilon)
bool	tools_areaFromString (char a1, char a2, area &result)
bool	tools_areaFromString (char *a, area &result)
const char *	tools_areaToString (const area a)
bool	tools_powerOfTwo (int value, int &power)
int	tools_startFromCenter (int pos, int length)
int	tools_fileSize (const char *fname)
Variables
const area	areas [areaINVALID]

Define Documentation

#define COEFF_EPSILON ((coeff)DBL_EPSILON)

Coeff epsilon. The epsilon for equals-operations on the {coeff} type.

Definition at line 51 of file miscdefs.h.

#define COEFF_MAX ((coeff)DBL_MAX)

Coeff maximal value.

Definition at line 54 of file miscdefs.h.

#define COEFF_MIN ((coeff)DBL_MIN)

Coeff minimal value.

Definition at line 57 of file miscdefs.h.

#define DELETE ( a ) delete (a), (a) = NULL

Definition at line 30 of file miscdefs.h.

Referenced by NTree< CoeffInformation >::destroyAt().

#define DELETEAR ( a ) delete [] (a), (a) = NULL

Definition at line 33 of file miscdefs.h.

#define DELETENOTNULL ( a ) if (a) { DELETE (a); } else {}

Definition at line 36 of file miscdefs.h.

#define DELETENOTNULLAR ( a ) if (a) { DELETEAR (a); } else {}

Definition at line 39 of file miscdefs.h.

#define DIV2 ( x ) ((unsigned)(x)>>1u)

Macro for dividing a number by two using a shift operation.

Definition at line 66 of file miscdefs.h.

#define DPRINTF ( x )

Definition at line 29 of file debug.h.

#define FMT0 0

Macro to circumvent problems with g++-3.0

Definition at line 80 of file miscdefs.h.

#define MAX	(	x,
		y
	)	((x) > (y)? (x): (y))

A two-tuple's minimum value.

Definition at line 63 of file miscdefs.h.

#define MIN	(	x,
		y
	)	((x) < (y)? (x): (y))

A two-tuple's maximum value.

Definition at line 60 of file miscdefs.h.

#define MUL2 ( x ) ((unsigned)(x)<<1u)

Macro for multiplying a number by two using a shift operation.

Definition at line 69 of file miscdefs.h.

#define NEW ( a ) new a

Definition at line 27 of file miscdefs.h.

#define SQUARE ( n ) ((n)*(n))

Definition at line 74 of file miscdefs.h.

#define TWOPOW ( n ) (1u<<(unsigned)(n))

Macro for calculating pow (2, n) using a shift operation.

Definition at line 72 of file miscdefs.h.

Typedef Documentation

typedef double coeff

A coefficient value. A long floating point type to represent one greyscale value for transforms or the pfi image format.

Definition at line 47 of file miscdefs.h.

typedef unsigned char pixel

A pixel value. A one-byte integer type to store one greyscale value in image files.

Definition at line 44 of file miscdefs.h.

Enumeration Type Documentation

enum area

The four regions of a one-step transform. If there was more than one step performed we'll find the same structure in the {LL} part again. The two rows are: {LL}, {HL}, {LH} and {HH}.

Enumerator:

LL
HL
LH
HH
areaINVALID

Definition at line 86 of file miscdefs.h.

enum clrmodel

Color models. Either RGB or YUV.

Enumerator:

cm_rgb
cm_yuv
cm_grey
cm_unknown

Definition at line 92 of file miscdefs.h.

enum ExtendFunc

Enumeration on built-in extension functions (implementations of the ResizeFillFunc type above).

Enumerator:

ef_mirror
ef_outerBorder

Definition at line 64 of file Image.hh.

enum filetype

File types. These are tags standing for known and supported file formats or unknown files.

Enumerator:

fn_pgm
fn_raw
fn_pfi
fn_ppm
fn_jpg
fn_vid
fn_avi
fn_png
fn_gif
fn_unknown

Definition at line 19 of file FileName.hh.

enum rgb

RGB color model channel names.

Enumerator:

rgb_r
rgb_g
rgb_b
rgb_unknown

Definition at line 98 of file miscdefs.h.

enum yuv

YUV color model channel names.

Enumerator:

yuv_y
yuv_u
yuv_v
yuv_unknown

Definition at line 95 of file miscdefs.h.

Function Documentation

pixel* ppm_read	(	const char *	fname,
		int *	height,
		int *	width,
		int *	cmax
	)

Read a PPM file from the filesystem.

Parameters:

fname	the filename
height	the number of pixel rows, returned by the function
width	the number of pixel cols, returned by the function
cmax	the maximal color value, returned by the function

Returns:: an array containing the pixels as RGB triples if successful else NULL

bool tools_areaFromString	(	char	a1,
		char	a2,
		area &	result
	)

Calculate an area from a string split to two characters

Parameters:

a1	the first character
a2	the second character
result	the result

Returns:: true if a valid area name was passed, else false

bool tools_areaFromString	(	char *	a,
		area &	result
	)

Calculate an area from a string

Parameters:

a	the string containing the area name
result	the result

Returns:: true if a valid area name was passed, else false

const char* tools_areaToString ( const area a )

Return an external string constant containing the name of the area passed to the function.

Parameters:

a the area

Returns:: the area's name

int tools_coeff2int ( coeff c )

Convert a coeff value to a integer

Parameters:

c	the coefficient

Returns:: the integer value

pixel tools_coeff2pixel ( coeff c )

Convert a coeff value to a pixel.

Parameters:

c	the coefficient

Returns:: the pixel value

bool tools_epsilons	(	double	d1,
		double	d2,
		double	epsilon
	)

Return true if two double values are almost equal

Parameters:

d1	the first value
d2	the second value
epsilon	the comparison epsilon

Returns:: true if almost equal

bool tools_equals	(	double	d1,
		double	d2
	)

Return true if two double values are equal

Parameters:

d1	the first value
d2	the second value

Returns:: true if equal

int tools_fileSize ( const char * fname )

Return the size of a file in bytes.

Exceptions:

invalid_argument if the file cannot be opened

Parameters:

fname the file name

Returns:: the size in bytes.

bool tools_powerOfTwo	(	int	value,
		int &	power
	)

Find out whether a number is a power of two.

Parameters:

value	the value to test
power	(returned value) the power of two if the result is true.

Returns:: true if value is a power of two.

int tools_startFromCenter	(	int	pos,
		int	length
	)

Calculate a vector's start index so that a given position is in its center.

Parameters:

pos	the position
length	the vector's length

Returns:: the start index

Variable Documentation

const area areas[areaINVALID]

Array for easier iteration over the areas.

Classes

Defines

Typedefs

Enumerations

Functions

Variables

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation