TPTImage Class Reference

Image class for Tiled Pyramidal Images: Inherits from IIPImage. Uses libtiff. More...

#include <TPTImage.h>

Inheritance diagram for TPTImage:

Public Member Functions
	TPTImage ()
	Constructor.
	TPTImage (const std::string &path)
	Constructor.
	TPTImage (const IIPImage &image)
	Copy Constructor.
	~TPTImage ()
	Destructor.
void	openImage () throw (std::string)
	Overloaded function for opening a TIFF image.
void	loadImageInfo (int x, int y) throw (std::string)
	Overloaded function for loading TIFF image information.
void	closeImage ()
	Overloaded function for closing a TIFF image.
RawTile	getTile (int x, int y, unsigned int r, int l, unsigned int t) throw (std::string)
	Overloaded function for getting a particular tile.
Public Member Functions inherited from IIPImage
	IIPImage ()
	Default Constructor.
	IIPImage (const std::string &)
	Constructer taking the image path as paramter.
	IIPImage (const IIPImage &)
	Copy Constructor taking reference to another IIPImage object.
virtual	~IIPImage ()
	Virtual Destructor.
void	Initialise ()
	Test the image and initialise some parameters.
std::list< int >	getVerticalViewsList ()
	Return a list of available vertical angles.
std::list< int >	getHorizontalViewsList ()
	Return a list of horizontal angles.
const std::string &	getImagePath ()
	Return the image path.
const std::string	getFileName (int x, int y)
	Return the full file path for a particular horizontal and vertical angle.
const std::string &	getImageType ()
	Get the image type.
void	updateTimestamp (const std::string &)
	Get the image timestamp.
const std::string	getTimestamp ()
	Get a HTTP RFC 1123 formatted timestamp.
bool	set ()
	Check whether this object has been initialised.
void	setFileSystemPrefix (const std::string &prefix)
	Set a file system prefix for added security.
void	setFileNamePattern (const std::string &pattern)
	Set the file name pattern used in image sequences.
int	getNumResolutions ()
	Return the number of available resolutions in the image.
unsigned int	getNumBitsPerPixel ()
	Return the number of bits per pixel for this image.
unsigned int	getNumChannels ()
	Return the number of channels for this image.
unsigned int	getImageWidth (int n=0)
	Return the image width in pixels for a given resolution.
unsigned int	getImageHeight (int n=0)
	Return the image height in pixels for a given resolution.
unsigned int	getTileHeight ()
	Return the base tile height in pixels for a given resolution.
unsigned int	getTileWidth ()
	Return the base tile width in pixels.
ColourSpaces	getColourSpace ()
	Return the colour space for this image.
std::string	getMetadata (const std::string &index)
	Return image metadata.
virtual void	Load (const std::string &module)
	Load the appropriate codec module for this image type.
virtual const std::string	getDescription ()
	Return codec description: Overloaded by child class.
virtual void	getRegion (int ha, int va, unsigned int r, int layers, int x, int y, unsigned int w, unsigned int h, unsigned char *b)
	Return a region for a given angle and resolution.
const IIPImage &	operator= (const IIPImage &)
	Assignment operator.

Additional Inherited Members
Public Attributes inherited from IIPImage
std::string	type
	Return the image type e.g. tif.
std::vector< unsigned int >	image_widths
	The image pixel dimensions.
std::vector< unsigned int >	image_heights
unsigned int	tile_width
	The base tile pixel dimensions.
unsigned int	tile_height
ColourSpaces	colourspace
	The colour space of the image.
unsigned int	numResolutions
	The number of available resolutions in this image.
unsigned int	bpp
	The bits per pixel for this image.
unsigned int	channels
	The number of channels for this image.
bool	isSet
	Indicate whether we have opened and initialised some paramters for this image.
int	currentX
	If we have an image sequence, the current X and Y position.
int	currentY
std::map< const std::string, std::string >	metadata
	STL map to hold string metadata.
time_t	timestamp
	Image modification timestamp.

Detailed Description

Image class for Tiled Pyramidal Images: Inherits from IIPImage. Uses libtiff.

Constructor & Destructor Documentation

TPTImage::TPTImage ( const std::string &  path )

inline

Constructor.

Parameters

path	image path

References IIPImage::numResolutions, and IIPImage::tile_width.

TPTImage::TPTImage ( const IIPImage &  image )

inline

Copy Constructor.

Parameters

image

IIPImage object

References IIPImage::numResolutions, and IIPImage::tile_width.

Member Function Documentation

RawTile TPTImage::getTile ( int  x, int  y, unsigned int  r, int  l, unsigned int  t  ) throw (std::string)

virtual

Overloaded function for getting a particular tile.

Parameters

x	horizontal sequence angle
y	vertical sequence angle
r	resolution
l	quality layers
t	tile number

Reimplemented from IIPImage.

void TPTImage::loadImageInfo ( int  x, int  y  ) throw (std::string)

virtual

Overloaded function for loading TIFF image information.

Parameters

x	horizontal sequence angle
y	vertical sequence angle

Reimplemented from IIPImage.

---

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

• TPTImage.h