---

PNMImageHeader Class Reference

#include <pnmImageHeader.h>

Inheritance diagram for PNMImageHeader:

List of all members.

Public Types
enum	ColorType {   CT_invalid = 0, CT_grayscale = 1, CT_two_channel = 2, CT_color = 3,   CT_four_channel = 4 }
Public Member Functions
INLINE	PNMImageHeader ()
INLINE	PNMImageHeader (const PNMImageHeader &copy)
INLINE void	operator= (const PNMImageHeader &copy)
INLINE	~PNMImageHeader ()
INLINE ColorType	get_color_type () const
INLINE int	get_num_channels () const
INLINE bool	is_grayscale () const
INLINE bool	has_alpha () const
INLINE xelval	get_maxval () const
INLINE int	get_x_size () const
INLINE int	get_y_size () const
INLINE bool	has_type () const
INLINE PNMFileType *	get_type () const
INLINE void	set_type (PNMFileType *type)
bool	read_header (const Filename &filename, PNMFileType *type=NULL)
PNMReader *	make_reader (const Filename &filename, PNMFileType *type=NULL) const
PNMReader *	make_reader (istream *file, bool owns_file=true, const Filename &filename=Filename(), string magic_number=string(), PNMFileType *type=NULL) const
PNMWriter *	make_writer (const Filename &filename, PNMFileType *type=NULL) const
PNMWriter *	make_writer (ostream *file, bool owns_file=true, const Filename &filename=Filename(), PNMFileType *type=NULL) const
void	output (ostream &out) const
Static Public Member Functions
INLINE bool	is_grayscale (ColorType color_type)
INLINE bool	has_alpha (ColorType color_type)
bool	read_magic_number (istream *file, string &magic_number, int num_bytes)
Protected Attributes
int	_x_size
int	_y_size
int	_num_channels
xelval	_maxval
PNMFileType *	_type

---

Member Enumeration Documentation

enum PNMImageHeader::ColorType

Enumeration values: CT_invalid  CT_grayscale  CT_two_channel  CT_color  CT_four_channel  Definition at line 53 of file pnmImageHeader.h.

---

Constructor & Destructor Documentation

INLINE PNMImageHeader::PNMImageHeader (   )

INLINE PNMImageHeader::PNMImageHeader (  const PNMImageHeader &  copy  )

INLINE PNMImageHeader::~PNMImageHeader (   )

---

Member Function Documentation

INLINE ColorType PNMImageHeader::get_color_type (   )  const

Referenced by PixelBuffer::load(), PNMFileTypeAlias::Reader::read_row(), PNMImage::set_color_type(), and PNMFileTypeTIFF::Writer::write_data().

INLINE xelval PNMImageHeader::get_maxval (   )  const

Referenced by consider_rescale(), PixelBuffer::load(), and Texture::read().

INLINE int PNMImageHeader::get_num_channels (   )  const

Referenced by consider_downgrade(), consider_rescale(), PNMImage::get_channel_val(), PixelBuffer::load(), and Texture::read().

INLINE PNMFileType* PNMImageHeader::get_type (   )  const

Reimplemented in PNMReader, and PNMWriter. Referenced by consider_rescale(), and Texture::read().

INLINE int PNMImageHeader::get_x_size (   )  const

Referenced by PNMImage::alpha_fill_val(), consider_rescale(), PNMImage::copy_sub_image(), event_T(), PNMImage::fill_val(), filter_image(), PixelBuffer::load(), PNMImage::make_grayscale(), PT(), PNMImage::quick_filter_from(), Texture::read(), PNMImage::set_color_type(), and PNMImage::set_maxval().

INLINE int PNMImageHeader::get_y_size (   )  const

Referenced by PNMImage::alpha_fill_val(), consider_rescale(), PNMImage::copy_sub_image(), event_T(), PNMImage::fill_val(), filter_image(), PixelBuffer::load(), PNMImage::make_grayscale(), PT(), PNMImage::quick_filter_from(), Texture::read(), PNMImage::set_color_type(), and PNMImage::set_maxval().

INLINE bool PNMImageHeader::has_alpha (   )  const

Referenced by PNMImage::alpha_fill_val(), PNMImage::blend(), PNMImage::clear(), PNMImage::copy_from(), PNMImage::copy_header_from(), PNMImage::copy_sub_image(), PNMFileTypeTGA::Reader::get_pixel(), PNMImage::make_grayscale(), PNMImage::quick_filter_from(), PNMFileTypeSGI::Reader::read_row(), PNMFileTypeTIFF::Reader::Reader(), PNMImage::set_color_type(), PNMImage::set_maxval(), PNMFileTypeSoftImage::Writer::write_header(), and PNMFileTypeSoftImage::Writer::write_row().

INLINE bool PNMImageHeader::has_alpha (  ColorType  color_type  )  [static]

Referenced by PNMImage::copy_sub_image(), filter_image(), PixelBuffer::load(), PT(), and PixelBuffer::store().

INLINE bool PNMImageHeader::has_type (   )  const

INLINE bool PNMImageHeader::is_grayscale (   )  const

Referenced by PNMImage::make_grayscale(), PNMFileTypeTGA::Writer::put_rgb(), PNMFileTypeSGI::Reader::read_row(), PNMFileTypeTIFF::Reader::Reader(), PNMImage::set_color_type(), PNMImage::set_maxval(), PNMImage::setup_rc(), PNMFileTypeTIFF::Writer::write_data(), PNMFileTypeTGA::Writer::write_data(), PNMFileTypeJPG::Writer::write_data(), PNMFileTypeJPG2000::Writer::write_data(), PNMFileTypeSoftImage::Writer::write_row(), and PNMFileTypeAlias::Writer::write_row().

INLINE bool PNMImageHeader::is_grayscale (  ColorType  color_type  )  [static]

Referenced by filter_image(), PixelBuffer::load(), and PixelBuffer::store().

PNMReader * PNMImageHeader::make_reader (  istream *  file, bool  owns_file = true, const Filename &  filename = Filename(), string  magic_number = string(), PNMFileType *  type = NULL )  const

Definition at line 141 of file pnmImageHeader.cxx. References _type, PNMFileTypeRegistry::get_ptr(), PNMFileTypeRegistry::get_type_from_extension(), NULL, read_magic_number(), reader(), and type.

PNMReader * PNMImageHeader::make_reader (  const Filename &  filename, PNMFileType *  type = NULL )  const

Definition at line 63 of file pnmImageHeader.cxx. References VirtualFileSystem::get_global_ptr(), NULL, VirtualFileSystem::open_read_file(), and type. Referenced by PNMImage::read(), and read_header().

PNMWriter * PNMImageHeader::make_writer (  ostream *  file, bool  owns_file = true, const Filename &  filename = Filename(), PNMFileType *  type = NULL )  const

Definition at line 305 of file pnmImageHeader.cxx. References _type, PNMFileTypeRegistry::get_ptr(), PNMFileTypeRegistry::get_type_from_extension(), NULL, type, and writer().

PNMWriter * PNMImageHeader::make_writer (  const Filename &  filename, PNMFileType *  type = NULL )  const

Definition at line 240 of file pnmImageHeader.cxx. References NULL, and type. Referenced by PNMImage::write().

INLINE void PNMImageHeader::operator= (  const PNMImageHeader &  copy  )

Referenced by PNMImage::copy_header_from().

void PNMImageHeader::output (  ostream &  out  )  const

Definition at line 383 of file pnmImageHeader.cxx. References _maxval, _num_channels, _x_size, and _y_size. Referenced by operator<<().

bool PNMImageHeader::read_header (  const Filename &  filename, PNMFileType *  type = NULL )

Definition at line 37 of file pnmImageHeader.cxx. References _type, make_reader(), NULL, reader(), and type. Referenced by PT().

bool PNMImageHeader::read_magic_number (  istream *  file, string &  magic_number, int  num_bytes )  [static]

Definition at line 365 of file pnmImageHeader.cxx. Referenced by make_reader(), PNMFileTypeSoftImage::Reader::Reader(), PNMFileTypeSGI::Reader::Reader(), PNMFileTypeIMG::Reader::Reader(), PNMFileTypeBMP::Reader::Reader(), and PNMFileTypeAlias::Reader::Reader().

INLINE void PNMImageHeader::set_type (  PNMFileType *  type  )

---

Member Data Documentation

xelval PNMImageHeader::_maxval [protected]

Definition at line 102 of file pnmImageHeader.h. Referenced by PNMFileTypeSGI::Writer::build_scanline(), PNMImage::clear(), output(), PNMFileTypeTIFF::Reader::read_row(), PNMFileTypeTIFF::Reader::Reader(), PNMFileTypeTGA::Reader::Reader(), PNMFileTypeSoftImage::Reader::Reader(), PNMFileTypeSGI::Reader::Reader(), PNMFileTypeJPG::Reader::Reader(), PNMFileTypeJPG2000::Reader::Reader(), PNMFileTypeIMG::Reader::Reader(), PNMFileTypeBMP::Reader::Reader(), PNMFileTypeAlias::Reader::Reader(), PNMImage::set_maxval(), PNMFileTypeTIFF::Writer::write_data(), PNMFileTypeTGA::Writer::write_data(), PNMFileTypeJPG::Writer::write_data(), PNMFileTypeJPG2000::Writer::write_data(), PNMFileTypeBMP::Writer::write_data(), PNMFileTypeSGI::Writer::write_header(), PNMFileTypeIMG::Writer::write_row(), and PNMFileTypeAlias::Writer::write_row().

int PNMImageHeader::_num_channels [protected]

Definition at line 101 of file pnmImageHeader.h. Referenced by PNMFileTypeSGI::Writer::build_scanline(), PNMImage::clear(), PNMImage::get_channel_val(), PNMImage::make_grayscale(), output(), PNMFileTypeSGI::Reader::read_row(), PNMFileTypeTIFF::Reader::Reader(), PNMFileTypeTGA::Reader::Reader(), PNMFileTypeSoftImage::Reader::Reader(), PNMFileTypeSGI::Reader::Reader(), PNMFileTypeJPG::Reader::Reader(), PNMFileTypeJPG2000::Reader::Reader(), PNMFileTypeIMG::Reader::Reader(), PNMFileTypeBMP::Reader::Reader(), PNMFileTypeAlias::Reader::Reader(), PNMImage::set_channel_val(), PNMImage::set_color_type(), PNMFileTypeSGI::Writer::write_channels(), PNMFileTypeTIFF::Writer::write_data(), PNMFileTypeSGI::Writer::write_header(), PNMFileTypeSGI::Writer::write_rgb_header(), PNMFileTypeSGI::Writer::write_row(), and PNMFileTypeSGI::Writer::write_table().

PNMFileType* PNMImageHeader::_type [protected]

Reimplemented in PNMReader, and PNMWriter. Definition at line 103 of file pnmImageHeader.h. Referenced by PNMImage::clear(), make_reader(), make_writer(), PNMImage::read(), and read_header().

int PNMImageHeader::_x_size [protected]

Definition at line 100 of file pnmImageHeader.h. Referenced by PNMFileTypeSGI::Writer::build_scanline(), PNMImage::clear(), PNMFileTypeSGI::Writer::compress(), PNMImage::copy_from(), output(), PNMReader::read_data(), PNMFileTypeJPG::Reader::read_data(), PNMFileTypeJPG2000::Reader::read_data(), PNMFileTypeBMP::Reader::read_data(), PNMFileTypeTIFF::Reader::read_row(), PNMFileTypeSoftImage::Reader::read_row(), PNMFileTypeSGI::Reader::read_row(), PNMFileTypeIMG::Reader::read_row(), PNMFileTypeAlias::Reader::read_row(), PNMFileTypeTIFF::Reader::Reader(), PNMFileTypeTGA::Reader::Reader(), PNMFileTypeSoftImage::Reader::Reader(), PNMFileTypeSGI::Reader::Reader(), PNMFileTypeJPG::Reader::Reader(), PNMFileTypeJPG2000::Reader::Reader(), PNMFileTypeIMG::Reader::Reader(), PNMFileTypeBMP::Reader::Reader(), PNMFileTypeAlias::Reader::Reader(), PNMImage::set_color_type(), PNMWriter::write_data(), PNMFileTypeTIFF::Writer::write_data(), PNMFileTypeTGA::Writer::write_data(), PNMFileTypeJPG::Writer::write_data(), PNMFileTypeJPG2000::Writer::write_data(), PNMFileTypeBMP::Writer::write_data(), PNMFileTypeSoftImage::Writer::write_header(), PNMFileTypeIMG::Writer::write_header(), PNMFileTypeAlias::Writer::write_header(), PNMFileTypeSGI::Writer::write_rgb_header(), PNMFileTypeSoftImage::Writer::write_row(), PNMFileTypeIMG::Writer::write_row(), and PNMFileTypeAlias::Writer::write_row().

int PNMImageHeader::_y_size [protected]

Definition at line 100 of file pnmImageHeader.h. Referenced by PNMImage::clear(), PNMImage::copy_from(), output(), PNMImage::read(), PNMReader::read_data(), PNMFileTypeJPG::Reader::read_data(), PNMFileTypeJPG2000::Reader::read_data(), PNMFileTypeBMP::Reader::read_data(), PNMFileTypeSGI::Reader::read_row(), PNMFileTypeTIFF::Reader::Reader(), PNMFileTypeTGA::Reader::Reader(), PNMFileTypeSoftImage::Reader::Reader(), PNMFileTypeSGI::Reader::Reader(), PNMFileTypeJPG::Reader::Reader(), PNMFileTypeJPG2000::Reader::Reader(), PNMFileTypeIMG::Reader::Reader(), PNMFileTypeBMP::Reader::Reader(), PNMFileTypeAlias::Reader::Reader(), PNMImage::set_color_type(), PNMImage::write(), PNMWriter::write_data(), PNMFileTypeTIFF::Writer::write_data(), PNMFileTypeTGA::Writer::write_data(), PNMFileTypeJPG::Writer::write_data(), PNMFileTypeJPG2000::Writer::write_data(), PNMFileTypeBMP::Writer::write_data(), PNMFileTypeSoftImage::Writer::write_header(), PNMFileTypeSGI::Writer::write_header(), PNMFileTypeIMG::Writer::write_header(), PNMFileTypeAlias::Writer::write_header(), PNMFileTypeSGI::Writer::write_rgb_header(), and PNMFileTypeSGI::Writer::write_table().

---

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

• pnmImageHeader.h
• pnmImageHeader.cxx

---