Main Page   Class List   Function List   File List   Examples  

---

CImageWriter Class Reference

The CImageWriter class implements an image writer. More...

Inheritance diagram for CImageWriter:

List of all members.

Public Methods
	~CImageWriter ()
string	getFileName ()
bool	writeFrame (CMotion2DImage< unsigned char > &I)
bool	writeFrame (CMotion2DImage< short > &I)
bool	openStream ()
bool	closeStream ()
void	getType ()
EWriterFormat	getFormat ()

---

Detailed Description

The CImageWriter class implements an image writer.

Image writing manipulations are restricted and only supported for PNG (see WritePNG() function) and PNM file format. The different PNM formats are PGM P5 (see function WritePGM()) and PPM P6 (see function WritePPM()). To know more about this image file format: man png, man pgm or man ppm.

Examples:

Motion2D.cpp, and Warping.cpp.

---

Constructor & Destructor Documentation

CImageWriter::~CImageWriter (    )

Image writer destructor.

---

Member Function Documentation

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

Close an image or video stream. Reimplemented from CWriter.

string CImageWriter::getFileName (    )  [virtual]

Compute and return the image filename. See also: setFileName(), setFrameNumber() Reimplemented from CWriter.

CWriter::EWriterFormat CImageWriter::getFormat (    )  [virtual]

Return the reader image file format. Reimplemented from CWriter.

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

Print the type of the reader. Reimplemented from CWriter.

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

Open an image or video stream. Reimplemented from CWriter.

bool CImageWriter::writeFrame (  CMotion2DImage< short > &    I )  [virtual]

Save an image in a file. Only PNG and PNM (PGM P5 and PPM P6) image format are implemented. The considered format depends on the filename extension. We consider only grey level images even if PNG or PPM P6 format support color images. Parameters: I  The grey level image to save. Returns: true if the frame was saved, false otherwise. Reimplemented from CWriter.

bool CImageWriter::writeFrame (  CMotion2DImage< unsigned char > &    I )  [virtual]

Save an image in a file. Only PNG and PNM (PGM P5 and PPM P6) image format are implemented. The considered format depends on the filename extension. We consider only grey level images even if PNG or PPM P6 format support color images. Parameters: I  The grey level image to save. Returns: true if the frame was saved, false otherwise. Reimplemented from CWriter.

---

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

• CImageWriter.h
• CImageWriter.cpp

---