H5BmpIO Class Reference

General IO class for Bmp images. More...

List of all members.

Public Member Functions

 H5BmpIO (hid_t fileId)
virtual ~H5BmpIO ()
herr_t importBmp (const std::string &filename, hid_t fileId, const std::string &datasetName, bool asGrayscale=true)
 imports a Bmp image into the MXADataModel
herr_t exportBmp (hid_t fileId, const std::string &filename, const std::string &datasetPath)
 exports a BMP image from the MXADataModel

Protected Member Functions

herr_t _importGrayscaleBmpImage (hid_t fileId, const std::string &datasetName, MXABmpIO &reader)
 Stores a True Color image in the form of a Pixel interlaced buffer as a Grayscale image in the provided HDF5 data set.
herr_t _importRGBFullColorBmp (hid_t fileId, const std::string &datasetName, MXABmpIO &reader)
 Stores a True Color image in the form of a Pixel interlaced buffer as an RGB image in the provided HDF5 data set.

Private Member Functions

 H5BmpIO (const H5BmpIO &)
void operator= (const H5BmpIO &)

Private Attributes

hid_t _fileId


Detailed Description

General IO class for Bmp images.

Author:
Mike Jackson/Herb Mullens
Date:
October 2007
Version:
Revision
1.2


Constructor & Destructor Documentation

H5BmpIO::H5BmpIO ( hid_t  fileId  )  [explicit]

H5BmpIO::~H5BmpIO (  )  [virtual]

H5BmpIO::H5BmpIO ( const H5BmpIO  )  [private]


Member Function Documentation

herr_t H5BmpIO::importBmp ( const std::string &  filename,
hid_t  fileId,
const std::string &  datasetName,
bool  asGrayscale = true 
)

imports a Bmp image into the MXADataModel

Parameters:
filename The absolute path to the Bmp file
fileId The HDF Group/FileId to store the imported data
datasetName The Name of the HDF5 dataset to store the data
asGrayscale Should the Bmp be stored as a grayscale image
Returns:
Error < 0 Error

herr_t H5BmpIO::exportBmp ( hid_t  fileId,
const std::string &  filename,
const std::string &  datasetPath 
)

exports a BMP image from the MXADataModel

Parameters:
fileId - the hdf fileID
filename - the output file to write the bmp to
datasetPath - the image dataset in the MXA HDF5 file

herr_t H5BmpIO::_importGrayscaleBmpImage ( hid_t  fileId,
const std::string &  datasetName,
MXABmpIO reader 
) [protected]

Stores a True Color image in the form of a Pixel interlaced buffer as a Grayscale image in the provided HDF5 data set.

Parameters:
fileId The HDF5 file id
datasetName The name of the data set to store the RGB image into
reader The reader object for reading BMP files
Returns:
Error Condition

herr_t H5BmpIO::_importRGBFullColorBmp ( hid_t  fileId,
const std::string &  datasetName,
MXABmpIO reader 
) [protected]

Stores a True Color image in the form of a Pixel interlaced buffer as an RGB image in the provided HDF5 data set.

Parameters:
fileId The HDF5 file id
datasetName The name of the data set to store the RGB image into
reader The reader object for reading BMP files
Returns:
Error Condition

void H5BmpIO::operator= ( const H5BmpIO  )  [private]


Member Data Documentation

hid_t H5BmpIO::_fileId [private]


The documentation for this class was generated from the following files:
Generated on Tue Nov 17 18:43:11 2009 for MXADataModel by  doxygen 1.5.2