Microscopy Image Browser  1.233
All Classes Files Functions Variables Pages
image2hdf5.m File Reference

Save image into hdf5 format. More...

Functions

function result = image2hdf5 (filename, imageS, options)
 Save image into hdf5 format. More...
 

Detailed Description

Save image into hdf5 format.

Function Documentation

function result = image2hdf5 (   filename,
  imageS,
  options 
)

Save image into hdf5 format.

Parameters
filenamefilename for hdf file
imageSoriginal dataset [1:height, 1:width, 1:colors, 1:no_stacks] or [1:height, 1:width, 1:no_stacks]
options[optional] a structure with additional parameters
  • .ChunkSize - a matrix [y, x, z] of chunk size
  • .Deflate - a number 0-9, defines gzip compression level (0-9)
  • .overwrite, if 1 do not check whether file with provided filename alaready exists
  • .showWaitbar, 1 - show the progress bar, 0 - do not show
  • .lutColors, - not yet implemented
  • .pixSize, - not yet implemented
  • .ImageDescription, - a cell string with dataset description
  • .DatasetName, - a cell string or a containers.Map with metadata
  • .order, - a string with order of the axes, yxczt
  • .height - height of the full dataset, required for the initialization (i.e. when options.t==1);
  • .width - width of the full dataset, required for the initialization (i.e. when options.t==1);
  • .colors - number of colors of the full dataset, required for the initialization (i.e. when options.t==1);
  • .depth - depth of the full dataset, required for the initialization (i.e. when options.t==1);
  • .time - time of the full dataset, required for the initialization (i.e. when options.t==1);
  • .x - define a minimal X point for data to store
  • .y - define a minimal Y point for data to store
  • .z - define a minimal Z point for data to store
  • .t - define a minimal T point for data to store
Return values
resultresult of the function run, 1 - success, 0 - fail
Required fields of options:

Referenced by menuFileSaveImageAs(), menuModelsSaveAs(), and mibchopDatasetGui>chopBtn_Callback().

Here is the caller graph for this function: