vrvis::Image< DataTypeT > Class Template Reference

Represents an image file containing multiple bands/layers of data. More...

#include <Image.hpp>

List of all members.

Public Member Functions
Constructor & Destructor
	Image (const std::string &crFilename)
	Constructor that takes a filename.
	~Image (void)
	Destructor.
Accessors
const std::string &	getFilename (void) const
	Get the filename of the image file.
int	getSizeX (void) const
	Get the horizontal (X) size of the Image.
int	getSizeY (void) const
	Get the vertical (Y) size of the Image.
int	getNumBands (void) const
	Get the number of bands contained in this Image.
DataTypeT	getLowerHistogramLimit (void) const
	Get the lower display limit of this Image's histogram.
DataTypeT	getUpperHistogramLimit (void) const
	Get the upper display limit of this Image's histogram.
ImageBand< DataTypeT > *	getBand (const int cNumBand) const
	Get a certain ImageBand contained in the Image.
Static Public Member Functions
int	mapGDALType (void)
	Maps the template data type to the corresponding GDAL enum.

---

Detailed Description

template<class DataTypeT>
class vrvis::Image< DataTypeT >

This class represents an raster image as read from a file. It is templated to enable easy access to images of the most different data types. The most common types would be Image<float> and Image<int>. An Image object contains several ImageBands, which are the bearers of the real data.

See also:

ImageBand

---

Constructor & Destructor Documentation

template<class DataTypeT> vrvis::Image< DataTypeT >::Image (  const std::string &  crFilename  )  [inline]

Constructs an Image object out of an image file. Furthermore, creates (yet empty) ImageBand objects for each contained band in the file. Parameters: crFilename  Name of the image file to read. See also: ImageBand::ImageBand()

template<class DataTypeT> vrvis::Image< DataTypeT >::~Image (  void   )  [inline]

Destructor. Frees own resources and those of the contained ImageBands.

---

Member Function Documentation

template<class DataTypeT> ImageBand< DataTypeT > * vrvis::Image< DataTypeT >::getBand (  const int  cNumBand  )  const [inline]

Get a contained ImageBand by its number. Parameters: cNumBand  Number/Index n of the ImageBand [1 <= n <= getNumBands()!]. Returns: Pointer to the desired ImageBand. If theBand doesn't exist, the program exits (due to the elementary nature of image data access).

template<class DataTypeT> const std::string & vrvis::Image< DataTypeT >::getFilename (  void   )  const [inline]

Accesses the filename of the image file. Returns: Filename string.

template<class DataTypeT> DataTypeT vrvis::Image< DataTypeT >::getLowerHistogramLimit (  void   )  const [inline]

Access the lower limit of this Image's histogram. Occuring values that are outside the bounds of the histogram limits will be clamped to the limit value. Returns: Lower histogram limit.

template<class DataTypeT> int vrvis::Image< DataTypeT >::getNumBands (  void   )  const [inline]

Accesses the number of bands contained in this Image. Returns: Number of contained bands.

template<class DataTypeT> int vrvis::Image< DataTypeT >::getSizeX (  void   )  const [inline]

Accesses the horizontal size (width) of the Image. Returns: Horizontal size in pixels.

template<class DataTypeT> int vrvis::Image< DataTypeT >::getSizeY (  void   )  const [inline]

Accesses the vertical size (height) of the Image. Returns: Vertical size in pixels.

template<class DataTypeT> DataTypeT vrvis::Image< DataTypeT >::getUpperHistogramLimit (  void   )  const [inline]

Access the upper limit of this Image's histogram. Occuring values that are outside the bounds of the histogram limits will be clamped to the limit value. Returns: Upper histogram limit.

int vrvis::Image<>::mapGDALType (  void   )  [inline, static]

Map the template data type to the corresponding GDAL enum for image loading functionality.

---

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

• Image.hpp
• Image.inl

---