RasterFileFormat.H File Reference

#include <string>

Include dependency graph for RasterFileFormat.H:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	RasterFileFormat {   RASFMT_PNM = 0, RASFMT_PNG, RASFMT_PFM, RASFMT_PFZ,   RASFMT_RAW_VIDEO, RASFMT_RAW_IMAGE, RASFMT_JPEG, RASFMT_TXT,   RASFMT_CCODE, RASFMT_DPX, RASFMT_AUTO }
	Definition of supported Raster file formats. More...
Functions
std::string	convertToString (const RasterFileFormat val)
	RasterFileFormat string conversion.
void	convertFromString (const std::string &str, RasterFileFormat &val)
	RasterFileFormat string conversion.

---

Detailed Description

file formats supported by Raster

Definition in file RasterFileFormat.H.

---

Enumeration Type Documentation

enum RasterFileFormat

Definition of supported Raster file formats.

See Raster.H for functions using these file formats. If you add new formats here, be sure to also update StringConversions.C

Enumerator:

RASFMT_PNM	see PnmWriter, PnmParser
RASFMT_PNG	see PngWriter, PngParser
RASFMT_PFM	see PfmWriter, PfmParser
RASFMT_PFZ	see PfzWriter, PfzParser
RASFMT_RAW_VIDEO	see YuvWriter, YuvParser
RASFMT_RAW_IMAGE	see RawWriter (no parser class currently)
RASFMT_JPEG	see JpegParser (no writer class currently)
RASFMT_TXT	see PlaintextWriter
RASFMT_CCODE	see CcodeWriter
RASFMT_DPX	see DpxParser, DpxFile

Definition at line 46 of file RasterFileFormat.H.

---

Function Documentation

void convertFromString	(	const std::string &	str,
		RasterFileFormat &	val
	)

RasterFileFormat string conversion.

The names used in the definition of the enum RasterFileFormat will be returned

Definition at line 67 of file RasterFileFormat.C.

References RASFMT_CCODE, RASFMT_DPX, RASFMT_JPEG, RASFMT_PFM, RASFMT_PFZ, RASFMT_PNG, RASFMT_PNM, RASFMT_RAW_IMAGE, RASFMT_RAW_VIDEO, and RASFMT_TXT.

std::string convertToString

(

const RasterFileFormat

val

)

RasterFileFormat string conversion.

Use it, for example, if you got a file format as text from the command line and need to convert that to a RasterFileFormat value for a ModelParam. Text strings should match the symbolic names of the RasterFileFormat enum.

Definition at line 47 of file RasterFileFormat.C.

References RASFMT_CCODE, RASFMT_DPX, RASFMT_JPEG, RASFMT_PFM, RASFMT_PFZ, RASFMT_PNG, RASFMT_PNM, RASFMT_RAW_IMAGE, RASFMT_RAW_VIDEO, and RASFMT_TXT.