Gets information about an image dataset (dimensions, interlace mode and number of associated palettes).


H5IM_GET_IMAGE_INFO(loc_id, dset_name, width, height, planes, interlace, npals)


<pre><code class="language-c">herr_t H5IMget_image_info( hid_t loc_id, const char *dset_name, hsize_t *width, hsize_t *height, hsize_t *planes, char*interlace, hssize_t *npals)</code></pre>

<pre><code class="language-fortran">subroutine h5imget_image_info_f(loc_id, dset_name, width, height, planes, &
                                interlace, npals, errcode)
  implicit none
  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(INOUT) :: width        ! width of image  
  integer(HSIZE_T), intent(INOUT) :: height       ! height of image
  integer(HSIZE_T), intent(INOUT) :: planes       ! color planes
  integer(HSIZE_T), intent(INOUT) :: npals        ! palettes
  character(LEN=*), intent(INOUT) :: interlace    ! interlace 
  integer :: errcode                              ! error code
end subroutine h5imget_image_info_f</code></pre>

hid_t loc_idIN: Identifier of the file or group in which the dataset is located.
const char *dset_name    IN: The name of the dataset.
hsize_t * widthOUT: The width of the image.
hsize_t * heightOUT: The height of the image.
hsize_t * planesOUT: The number of color planes of the image.
char * interlaceOUT: The interlace mode of the image.
hssize_t * npalsOUT: The number of palettes associated to the image.


H5IMget_image_info gets information about an image named dset_name attached to the file or group specified by the identifier loc_id. .


Returns a non-negative value if successful; otherwise returns a negative value.


Coming Soon!