WXP::ImgWxpFile Class Reference

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

#include "../include/ImgWxpFile.h"

Public Types
enum	Type { UNK , IMG , IMGZ }

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

Detailed Description

This class reads and writes image files.

Author

Dan Vietor

Member Enumeration Documentation

Type

enum WXP::ImgWxpFile::Type

Enumerator
UNK	Unknown type
IMG	Uncompressed WXP image
IMGZ	Compressed WXP image

Constructor & Destructor Documentation

ImgWxpFile()

ImgWxpFile::ImgWxpFile

(

)

Constructor. Initializes class values

Member Function Documentation

close()

int ImgWxpFile::close

(

)

Closes the file

References WXP::File::close().

Referenced by WXP::ImageFile::close(), and read().

isOpen()

bool ImgWxpFile::isOpen

(

)

Returns if file is open or not

Returns

True if opened

Referenced by WXP::ImageFile::open().

open() [1/3]

int ImgWxpFile::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/3]

int ImgWxpFile::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/3]

int ImgWxpFile::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 WXP::File::close(), WXP::StrLib::equal(), IMG, WXP::File::isOpen(), WXP::File::open(), WXP::File::read(), WXP::FileAttr::READ, and WXP::FileAttr::WRITE.

Referenced by open(), open(), WXP::ImageFile::open(), WXP::SatFile::open(), read(), and write().

read() [1/2]

int ImgWxpFile::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 ImgWxpFile::read

(

Image &

image

)

Reads in a WXP formatted image file

Return values

image

Image class to put satellite image

References WXP::File::isOpen(), readData(), and readHeader().

Referenced by read(), WXP::SatFile::read(), and WXP::ImageFile::read().

readData()

int ImgWxpFile::readData

(

Image &

image

)

Reads a WXP image file

Parameters

image

Image class to put data into

References WXP::Image::allocData(), WXP::File::close(), WXP::Zlib::decomp(), WXP::Zlib::finish(), WXP::Zlib::getAvailIn(), WXP::Zlib::getAvailOut(), WXP::Zlib::isError(), WXP::File::isOpen(), WXP::Zlib::print(), WXP::File::read(), WXP::File::scanf(), WXP::Zlib::set(), and WXP::Image::setPixel().

Referenced by read().

readHeader()

int ImgWxpFile::readHeader

(

Image &

image

)

Reads a WXP image file

Parameters

image

Image class to put data into

References WXP::DomainVal::clat, WXP::DomainVal::clon, WXP::DateTool::decode(), WXP::DomainTool::decode(), WXP::DomainVal::dx, WXP::DomainVal::dy, WXP::StrLib::equal(), WXP::File::getLine(), WXP::StrLib::iequal(), WXP::StrLib::index(), WXP::Image::init(), WXP::Domain::LAMB, WXP::Domain::LATLON, WXP::StrLib::length(), WXP::Domain::MERC, WXP::DomainVal::nx, WXP::DomainVal::ny, WXP::DomainVal::param, WXP::DomainVal::plat, WXP::DomainVal::plon, WXP::DomainVal::proj, WXP::Domain::PSTEREO, WXP::Domain::SAT, WXP::File::scanf(), WXP::Image::set(), and WXP::StrLib::trimWS().

Referenced by WXP::SatFile::getHeader(), and read().

setVer()

int ImgWxpFile::setVer

(

int

v

)

Sets the output file version

Parameters

v	The version

Referenced by WXP::ImageFile::setVer().

write() [1/2]

int ImgWxpFile::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 open(), WXP::FileAttr::WRITE, and write().

write() [2/2]

int ImgWxpFile::write

(

Image &

image

)

Writes a WXP image file

Parameters

image

Image class to write to file

References WXP::File::close(), WXP::Zlib::comp(), WXP::Zlib::COMP, WXP::Zlib::finish(), WXP::Zlib::FINISH, WXP::String::get(), WXP::Domain::getCLat(), WXP::Domain::getCLon(), WXP::Domain::getDx(), WXP::Domain::getDy(), WXP::Domain::getNx(), WXP::Domain::getNy(), WXP::Domain::getParam(), WXP::Image::getPixel(), WXP::Domain::getPLat(), WXP::Domain::getPLon(), WXP::Domain::getProj(), WXP::Zlib::getTotalOut(), IMG, IMGZ, WXP::Zlib::init(), WXP::File::isOpen(), WXP::Domain::LAMB, WXP::Domain::LATLON, WXP::Domain::MERC, WXP::Const::MISS, WXP::File::printf(), WXP::Domain::PSTEREO, WXP::Domain::SAT, WXP::Zlib::set(), WXP::Domain::toString(), and WXP::File::write().

Referenced by write(), and WXP::ImageFile::write().

---

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

• ImgWxpFile.h
• ImgWxpFile.cc