subroutine h5immake_image_24bit_f(loc_id, dset_name, width, height, il, &
integer(HID_T), intent(IN) :: loc_id ! file or group identifier
character(LEN=*), intent(IN) :: dset_name ! name of the dataset
integer(HSIZE_T), intent(IN) :: width ! width of image
integer(HSIZE_T), intent(IN) :: height ! height of image
character(LEN=*), intent(IN) :: il ! interlace
integer*1, intent(IN), dimension(*) :: buf ! 1 byte integer data buffer
integer :: errcode ! error code
end subroutine h5immake_image_24bit_f
IN: Identifier of the file or group to create the dataset within.
const char *dset_name
IN: The name of the dataset to create.
IN: The width of the image.
IN: The height of the image.
const char *interlace
IN: String defining the interlace mode.
const unsigned char *buffer
IN: Buffer with data to be written to the dataset.
H5Lmake_image_24bitcreates and writes a dataset nameddset_nameattached to the file or group specified by the identifierloc_id. This function defines a true color image conforming to the HDF5 Image and Palette specification. The function assumes that the image data is of the type H5T_NATIVE_UCHAR.
A true color image is an image where the pixel storage contains several color planes. In a 24 bit RGB color model, these planes are red, green and blue. In a true color image the stream of bytes can be stored in several different ways, thus defining the interlace (or interleaving) mode. The 2 most used types of interlace mode are interlace by pixel and interlace by plane. In the 24 bit RGB color model example, interlace by plane means all the red components for the entire dataset are stored first, followed by all the green components, and then by all the blue components. Interlace by pixel in this example means that for each pixel the sequence red, green, blue is defined. In this function, the interlace mode is defined in the parameter interlace, a string that can have the values INTERLACE_PIXEL or INTERLACE_PLANE.
Returns a non-negative value if successful; otherwise returns a negative value.