WXP::ImageFile Class Reference

This class reads and writes image files. More...

#include "../include/ImageFile.h"

Public Types
enum	Type {   UNK , IMG , IMGZ , TIFF ,   GIF , PNG , GINIP }

Public Member Functions
	ImageFile ()
int	setVer (int v)
int	open (const char *filename, int raccess, int rtype)
int	open (const char *filename, int raccess, const char *rtype)
int	open (const char *filename, int raccess)
int	open (const char *filename)
bool	isOpen ()
int	close ()
int	getType (const char *str)
int	read (Image &image)
int	read (const char *filename, Image &image)
int	write (Image &image)
int	write (const char *filename, int rtype, Image &image)
int	write (const char *filename, Image &image)

Static Public Member Functions
static int	checkType (const char *filename)
static int	checkFilename (const char *filename)

Detailed Description

This class reads and writes image files.

Author

Dan Vietor

Member Enumeration Documentation

Type

enum WXP::ImageFile::Type

Type of image file

Enumerator
UNK	Unknown type
IMG	Uncompressed WXP image
IMGZ	Compressed WXP image
TIFF	TIFF image
GIF	GIF image
PNG	PNG image
GINIP	GINI PNG compressed image

Constructor & Destructor Documentation

ImageFile()

ImageFile::ImageFile

(

)

Constructor. Initializes class values

References UNK.

Member Function Documentation

checkFilename()

int ImageFile::checkFilename ( const char *  filename )

static

Checks for the type of data in the file based on filename

Parameters

filename

The file type

References GIF, GINIP, WXP::StrLib::iequal(), IMG, IMGZ, PNG, TIFF, and UNK.

Referenced by open().

checkType()

int ImageFile::checkType ( const char *  filename )

static

Checks the type of data in the file based on contents

Parameters

filename

File to check

References WXP::File::close(), WXP::StrLib::equal(), GIF, IMG, WXP::File::isOpen(), PNG, WXP::File::read(), TIFF, and UNK.

Referenced by open().

close()

int ImageFile::close

(

)

Closes the file

References WXP::GifFile::close(), WXP::GiniFile::close(), WXP::ImgWxpFile::close(), WXP::PngFile::close(), WXP::TiffFile::close(), GIF, GINIP, IMG, IMGZ, PNG, and TIFF.

Referenced by read(), and write().

getType()

int ImageFile::getType

(

const char *

str

)

Gets the satellite type based on string

Parameters

str	The type string

References WXP::StrLib::equal(), GIF, GINIP, IMG, IMGZ, PNG, TIFF, and UNK.

Referenced by open().

isOpen()

bool WXP::ImageFile::isOpen ( )

inline

Returns if file is open or not

Referenced by WXP::ImagePlot::draw(), WXP::RadPlot::draw(), and WXP::ImagePlot::getDomain().

open() [1/4]

int ImageFile::open

(

const char *

filename

)

Opens a file for read (unknown type)

Parameters

filename

File to open

References open(), WXP::FileAttr::READ, and UNK.

open() [2/4]

int ImageFile::open	(	const char *	filename,
		int	raccess
	)

Opens a file (unknown type)

Parameters

filename	File to open
raccess	File access (FileAttr::READ, FileAttr::WRITE)

References open(), and UNK.

open() [3/4]

int ImageFile::open	(	const char *	filename,
		int	access,
		const char *	rtype
	)

Opens a image file

Parameters

filename	File to open
access	Access (File::READ, File::WRITE)
rtype	File type (unk, img, imgz, gif, png)

References getType(), and open().

open() [4/4]

int ImageFile::open	(	const char *	filename,
		int	raccess,
		int	rtype
	)

Opens an image file

Parameters

filename	File to open
raccess	Access to the file (FileAttr::READ, FileAttr::WRITE)
rtype	Type of image file (UNK, IMG, IMGZ, GIF, PNG)

References checkFilename(), checkType(), GIF, GINIP, IMG, WXP::ImgWxpFile::IMG, IMGZ, WXP::ImgWxpFile::IMGZ, WXP::GifFile::isOpen(), WXP::GiniFile::isOpen(), WXP::ImgWxpFile::isOpen(), WXP::PngFile::isOpen(), WXP::TiffFile::isOpen(), WXP::GifFile::open(), WXP::PngFile::open(), WXP::TiffFile::open(), WXP::ImgWxpFile::open(), WXP::GiniFile::open(), PNG, WXP::FileAttr::READ, TIFF, UNK, and WXP::FileAttr::WRITE.

Referenced by WXP::ImagePlot::draw(), WXP::RadPlot::draw(), WXP::ImagePlot::getDomain(), open(), read(), and write().

read() [1/2]

int ImageFile::read	(	const char *	filename,
		Image &	image
	)

Opens and reads an image from the file

Parameters

filename

File to read

Return values

image

Image class to put file data into

References close(), open(), WXP::FileAttr::READ, and read().

read() [2/2]

int ImageFile::read

(

Image &

image

)

Reads an image from the file

Return values

image

Image class to put file data into

References GIF, GINIP, IMG, IMGZ, PNG, WXP::FileAttr::READ, WXP::GiniFile::read(), WXP::GifFile::read(), WXP::ImgWxpFile::read(), WXP::PngFile::read(), WXP::TiffFile::read(), and TIFF.

Referenced by WXP::ImagePlot::draw(), WXP::RadPlot::draw(), WXP::ImagePlot::getDomain(), and read().

setVer()

int ImageFile::setVer

(

int

v

)

Sets the version number of data

Parameters

v	The version

See also

ImgWxpFile

References WXP::ImgWxpFile::setVer().

write() [1/3]

int ImageFile::write	(	const char *	filename,
		Image &	image
	)

Writes an image to file

Parameters

filename	File to write to
image	Image class to write to file

References close(), open(), WXP::FileAttr::WRITE, and write().

write() [2/3]

int ImageFile::write	(	const char *	filename,
		int	rtype,
		Image &	image
	)

Writes an image to file

Parameters

filename	File to write to
rtype	Type of file to write (IMG, IMGZ, GIF, PNG)
image	Image class to write to file

References close(), open(), WXP::FileAttr::WRITE, and write().

write() [3/3]

int ImageFile::write

(

Image &

image

)

Writes an image to file

Parameters

image

Image to write

References GIF, GINIP, IMG, IMGZ, PNG, WXP::FileAttr::WRITE, WXP::GiniFile::write(), WXP::GifFile::write(), WXP::ImgWxpFile::write(), and WXP::PngFile::write().

Referenced by write().

---

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

• ImageFile.h
• ImageFile.cc