Main Page   Class List   Function List   File List   Examples  

---

CWriter Class Reference

The CWriter class implements an image or video stream writer. More...

Inheritance diagram for CWriter:

List of all members.

Public Types
enum	EWriterFormat {   FORMAT_NOT_RECOGNIZED, FORMAT_PGM, FORMAT_PPM, FORMAT_RAW8,   FORMAT_RAW16, FORMAT_PNG }
Public Methods
	CWriter ()
void	setFileName (const char *filename)
void	setFileName (string filename)
bool	setFrameNumber (unsigned long framenumber)
virtual EWriterFormat	getFormat ()
virtual string	getFileName ()
virtual bool	writeFrame (CMotion2DImage< unsigned char > &I)
virtual bool	writeFrame (CMotion2DImage< short > &I)
virtual bool	openStream ()
virtual bool	closeStream ()
virtual void	getType ()

---

Detailed Description

The CWriter class implements an image or video stream writer.

Examples:

Motion2D.cpp, and Warping.cpp.

---

Member Enumeration Documentation

enum CWriter::EWriterFormat

The supported image writer format. Enumeration values: FORMAT_NOT_RECOGNIZED  Writer format not supported. FORMAT_PGM  PNM PGM P5 image format. FORMAT_PPM  PNM PPM P6 image format. FORMAT_RAW8  RAW8 image format. FORMAT_RAW16  RAW16 image format. FORMAT_PNG  PNG image format.

---

Constructor & Destructor Documentation

CWriter::CWriter (    )

Image or video stream writer constructor.

---

Member Function Documentation

virtual bool CWriter::closeStream (    )  [inline, virtual]

Close an image or video stream. Reimplemented in CImageWriter.

virtual string CWriter::getFileName (    )  [inline, virtual]

Return the filename of the image or video stream. Reimplemented in CImageWriter. Examples: Motion2D.cpp, and Warping.cpp.

virtual EWriterFormat CWriter::getFormat (    )  [inline, virtual]

Return the considered image writer format. See also: EReaderFormat Reimplemented in CImageWriter.

virtual void CWriter::getType (    )  [inline, virtual]

Print the type of the reader. Reimplemented in CImageWriter.

virtual bool CWriter::openStream (    )  [inline, virtual]

Open an image or video stream. Reimplemented in CImageWriter.

void CWriter::setFileName (  string    filename )

Set the image or video stream filename to save to disk. See also: getFileName()

void CWriter::setFileName (  const char *    filename )

Set the image or video stream filename to save to disk. See also: getFileName() Examples: Motion2D.cpp, and Warping.cpp.

bool CWriter::setFrameNumber (  unsigned long    framenumber )

Set the image or video stream frame number to write. Returns: Allways true. Examples: Motion2D.cpp, and Warping.cpp.

virtual bool CWriter::writeFrame (  CMotion2DImage< short > &    I )  [inline, virtual]

Write a frame to an image filename or video stream. Reimplemented in CImageWriter.

virtual bool CWriter::writeFrame (  CMotion2DImage< unsigned char > &    I )  [inline, virtual]

Write a frame to an image filename or video stream. Reimplemented in CImageWriter. Examples: Motion2D.cpp, and Warping.cpp.

---

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

• CWriter.h
• CWriter.cpp

---