---

FrameClass Class Reference

#include <frame.h>

List of all members.

Public Methods
	FrameClass ()
	FrameClass (string fileName)
	FrameClass (ColorImage &image)
	FrameClass (ColorImage *image)
	FrameClass (FrameClass &other)
FrameClass &	operator= (FrameClass &other)
BoxVector &	operator[] (string key)
unsigned int	attribute_size ()
bool	has_attribute (string key)
	~FrameClass ()
	destructor. More...
string	str (void)
Public Attributes
ColorImage *	show
	the color image for this frame, used primarily to show results on. More...
GrayImage *	work
	a grayscale copy of show, used primarily to work on. More...
bool	is_set
Private Attributes
map< const string, BoxVector >	attributes

---

Detailed Description

this class represents a single frame in a movie or just a still image it includes the frame itself plus a map containing several attributes

Author:

Robert Evans

Version:

0.1

Date:

Jan 24 2003

---

Constructor & Destructor Documentation

FrameClass::FrameClass (    )

FrameClass::FrameClass (  string    fileName )

open up a still image and place it in the frame Parameters: fileName  the name of the file with the image in it

FrameClass::FrameClass (  ColorImage &    image )

copy the image into the frame Parameters: image  the image to be copied

FrameClass::FrameClass (  ColorImage *    image )

use this specific image in the frame Note that it will be deleted in the destructor Parameters: image  a pointer to the image in question

FrameClass::FrameClass (  FrameClass &    other )

copy constructor Parameters: other  the other image to be coppied

FrameClass::~FrameClass (    )

destructor.

---

Member Function Documentation

unsigned int FrameClass::attribute_size (    )

return the current size of the attributes Returns: size of the attributes

bool FrameClass::has_attribute (  string    key )

check to see if this string corresponds to an attribute Parameters: key  the string that represents that attribute Returns: true if the attrubute exsista else false

FrameClass & FrameClass::operator= (  FrameClass &    other )

BoxVector & FrameClass::operator[] (  string    key )

simple array like access to the frame's attributes Parameters: key  is the name of the attribute Returns: the attribute associated with key

string FrameClass::str (  void    )

represent this class as a string Returns: this class represented as a string

---

Member Data Documentation

map<const string, BoxVector > FrameClass::attributes [private]

a map containing attributes for this frame these can be accessed through the opperator overloading of [] See also: operator[]

bool FrameClass::is_set

ColorImage* FrameClass::show

the color image for this frame, used primarily to show results on.

GrayImage* FrameClass::work

a grayscale copy of show, used primarily to work on.

---

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

• frame.h
• frame.cpp

---