Static Public Member Functions | |
static MXA_EXPORT herr_t | H5IM_find_palette (hid_t loc_id) |
Find the attribute const_cast<std::string&>(H5ImageConst::Palette) in the image dataset. | |
static MXA_EXPORT herr_t | H5IMmake_image_8bit (hid_t loc_id, std::string datasetName, hsize_t width, hsize_t height, const std::string &displayOrigin, const unsigned char *buffer) |
Creates and writes an image as an 8 bit image. | |
static MXA_EXPORT herr_t | H5IMmake_image_24bit (hid_t loc_id, std::string datasetName, hsize_t width, hsize_t height, const std::string &interlace, const unsigned char *buffer) |
Creates and writes a 24Bit RGB image. | |
static MXA_EXPORT herr_t | H5IMget_image_info (hid_t loc_id, std::string datasetName, hsize_t *width, hsize_t *height, hsize_t *planes, std::string &interlace, hssize_t *npals) |
Gets information about an image dataset (dimensions, interlace mode and number of associated palettes). | |
static MXA_EXPORT herr_t | H5IMread_image (hid_t loc_id, std::string datasetName, unsigned char *buffer) |
Reads image data from disk. | |
static MXA_EXPORT herr_t | H5IMmake_palette (hid_t loc_id, std::string pal_name, const hsize_t *pal_dims, const unsigned char *pal_data) |
Creates and writes a palette. | |
static MXA_EXPORT herr_t | H5IMlink_palette (hid_t loc_id, std::string imageName, std::string pal_name) |
This function attaches a palette to an existing image dataset. | |
static MXA_EXPORT herr_t | H5IMunlink_palette (hid_t loc_id, std::string imageName, std::string pal_name) |
This function dettaches a palette from an existing image dataset. | |
static MXA_EXPORT herr_t | H5IMget_npalettes (hid_t loc_id, std::string imageName, hssize_t *npals) |
Gets the number of palettes associated to an image. | |
static MXA_EXPORT herr_t | H5IMget_palette_info (hid_t loc_id, std::string imageName, int32 pal_number, hsize_t *pal_dims) |
Get palette information. | |
static MXA_EXPORT herr_t | H5IMget_palette (hid_t loc_id, std::string imageName, int32 pal_number, unsigned char *pal_data) |
Read palette. | |
static MXA_EXPORT herr_t | H5IMis_image (hid_t loc_id, std::string datasetName) |
Is a data set an Image. | |
static MXA_EXPORT herr_t | H5IMis_palette (hid_t loc_id, std::string datasetName) |
Is a dataset a Palette. | |
static MXA_EXPORT herr_t | H5IMget_image_dimensions (hid_t fileId, const std::string datasetPath, int imageDims[2]) |
Retrieves the image dimensions from the mxa file. |
herr_t H5Image::H5IM_find_palette | ( | hid_t | loc_id | ) | [static] |
Find the attribute const_cast<std::string&>(H5ImageConst::Palette) in the image dataset.
loc_id | HDF5 File or Group ID |
herr_t H5Image::H5IMmake_image_8bit | ( | hid_t | loc_id, | |
std::string | datasetName, | |||
hsize_t | width, | |||
hsize_t | height, | |||
const std::string & | displayOrigin, | |||
const unsigned char * | buffer | |||
) | [static] |
Creates and writes an image as an 8 bit image.
loc_id | HDF5 File or Group ID | |
datasetName | The name of the data set | |
width | The Width of the image in pixels | |
height | The height of the image in pixels | |
displayOrigin | One of UL,UR,LL,LR | |
buffer | Where to store the image data or where to read the image data into |
herr_t H5Image::H5IMmake_image_24bit | ( | hid_t | loc_id, | |
std::string | datasetName, | |||
hsize_t | width, | |||
hsize_t | height, | |||
const std::string & | interlace, | |||
const unsigned char * | buffer | |||
) | [static] |
Creates and writes a 24Bit RGB image.
loc_id | HDF5 File or Group ID | |
datasetName | The name of the data set | |
width | The Width of the image in pixels | |
height | The height of the image in pixels | |
interlace | Interlace mode of the image | |
buffer | Where to store the image data or where to read the image data into |
herr_t H5Image::H5IMget_image_info | ( | hid_t | loc_id, | |
std::string | datasetName, | |||
hsize_t * | width, | |||
hsize_t * | height, | |||
hsize_t * | planes, | |||
std::string & | interlace, | |||
hssize_t * | npals | |||
) | [static] |
Gets information about an image dataset (dimensions, interlace mode and number of associated palettes).
loc_id | HDF5 File or Group ID | |
datasetName | The name of the data set | |
width | The Width of the image in pixels | |
height | The height of the image in pixels | |
planes | The Image Planes | |
interlace | Interlace mode of the image | |
npals | Number of palettes |
herr_t H5Image::H5IMread_image | ( | hid_t | loc_id, | |
std::string | datasetName, | |||
unsigned char * | buffer | |||
) | [static] |
Reads image data from disk.
loc_id | HDF5 File or Group ID | |
datasetName | The name of the data set | |
buffer | Where to store the image data or where to read the image data into |
herr_t H5Image::H5IMmake_palette | ( | hid_t | loc_id, | |
std::string | pal_name, | |||
const hsize_t * | pal_dims, | |||
const unsigned char * | pal_data | |||
) | [static] |
Creates and writes a palette.
loc_id | HDF5 File or Group ID | |
pal_name | The name of the Palette | |
pal_dims | The dimensions of the Palette | |
pal_data | The Palette Data to write to the file |
herr_t H5Image::H5IMlink_palette | ( | hid_t | loc_id, | |
std::string | imageName, | |||
std::string | pal_name | |||
) | [static] |
This function attaches a palette to an existing image dataset.
loc_id | HDF5 File or Group ID | |
imageName | The name of the image | |
pal_name | The name of the Palette |
herr_t H5Image::H5IMunlink_palette | ( | hid_t | loc_id, | |
std::string | imageName, | |||
std::string | pal_name | |||
) | [static] |
This function dettaches a palette from an existing image dataset.
loc_id | HDF5 File or Group ID | |
imageName | The name of the image | |
pal_name | THe name of the Palette |
herr_t H5Image::H5IMget_npalettes | ( | hid_t | loc_id, | |
std::string | imageName, | |||
hssize_t * | npals | |||
) | [static] |
Gets the number of palettes associated to an image.
loc_id | HDF5 File or Group ID | |
imageName | The name of the image | |
npals | Number of Palettes |
herr_t H5Image::H5IMget_palette_info | ( | hid_t | loc_id, | |
std::string | imageName, | |||
int32 | pal_number, | |||
hsize_t * | pal_dims | |||
) | [static] |
Get palette information.
loc_id | HDF5 File or Group ID | |
imageName | The name of the image | |
pal_number | The index of the palette | |
pal_dims | The dimensions of the palette |
herr_t H5Image::H5IMget_palette | ( | hid_t | loc_id, | |
std::string | imageName, | |||
int32 | pal_number, | |||
unsigned char * | pal_data | |||
) | [static] |
Read palette.
loc_id | HDF5 File or Group ID | |
imageName | The name of the image | |
pal_number | The index of the palette | |
pal_data | A buffer to store the Palette data into |
herr_t H5Image::H5IMis_image | ( | hid_t | loc_id, | |
std::string | datasetName | |||
) | [static] |
Is a data set an Image.
loc_id | HDF5 File or Group ID | |
datasetName | The name of the data set |
herr_t H5Image::H5IMis_palette | ( | hid_t | loc_id, | |
std::string | datasetName | |||
) | [static] |
Is a dataset a Palette.
loc_id | HDF5 File or Group ID | |
datasetName | The name of the data set |
int H5Image::H5IMget_image_dimensions | ( | hid_t | fileId, | |
const std::string | datasetPath, | |||
int | imageDims[2] | |||
) | [static] |
Retrieves the image dimensions from the mxa file.
fileId | The hdf5 fileid of the mxa file | |
datasetPath | The complete path to the image data set. | |
imageDims | The dimensions (width, height) of the image |