From ea7491e8ebfeb6c515822bb44cc2f9345b1f08e0 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Thu, 17 Apr 2003 14:56:08 -0500 Subject: [svn-r6696] Purpose: Add new function Description: Added H5Pset_szip Platforms tested: Safari, IE 5 --- doc/html/RM_H5P.html | 226 ++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 225 insertions(+), 1 deletion(-) diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html index 4972b8e..f2e23d7 100644 --- a/doc/html/RM_H5P.html +++ b/doc/html/RM_H5P.html @@ -193,6 +193,7 @@ which require many different parameters to be easily manipulated.
  • H5Pget_filter
  • H5Pset_fletcher32
  • H5Pset_shuffle +
  • H5Pset_szip
  • H5Pset_external
  • H5Pget_external_count
  • H5Pget_external @@ -335,6 +336,7 @@ facilitate moving easily between them.
  • h5pget_filter_f
  • h5pset_fletcher32_f
  • h5pset_shuffle_f +
  • h5pset_external_f
  • h5pget_external_count_f
  • h5pget_external_f @@ -3607,6 +3609,7 @@ facilitate moving easily between them. --> +
    Name: H5Pset_fletcher32 @@ -3637,6 +3640,225 @@ facilitate moving easily between them. -->
    + + + + + + + + + + +
    +
    +
    Name: H5Pset_szip +
    Signature: +
    herr_t H5Pset_szip(hid_t plist, + unsigned int options_mask, + unsigned int pixels_per_block) +
    Purpose: +
    Sets up use of the szip compression filter. +
    Description: +
    H5Pset_szip sets the dataset compression method + to szip compression, H5Z_FILTER_SZIP, + a compression designed for use with scientific data. +

    + Szip options are passed in an options mask, options_mask, + as follows. +

    + + + + + + + + + + + + + + + +
    +
    + Option +     		+
    + Description +
    + (Paired options are mutually exclusive.) +
    +
    + CHIP_OPTION_MASK   +     		+
    + Compresses exactly as in hardware. +
    + ALLOW_K13_OPTION_MASK   + + Allows k split = 13 compression mode. (Default) +
    +
    + EC_OPTION_MASK +     		+
    + Selects entropy coding method. (Default) +
    + NN_OPTION_MASK + + Selects nearest neighbor coding method. +
    +
    + LSB_OPTION_MASK +     		+
    + Data format is least significant byte first. (Default) +
    + MSB_OPTION_MASK + + Data format is most significant byte first. +
    +
    + RAW_OPTION_MASK +     		+
    + Do not output szip header.
    + Not a default setting, but should always be set in HDF5. +
    +
    +     		+
    +
    +
    + Some typical usages are as follows: +
      +
    • If the dataset employs more than 8 bits/pixel, + one of LSB_OPTION_MASK or + MSB_OPTION_MASK is specified. +
    • One of the compression methods, + EC_OPTION_MASK or + NN_OPTION_MASK, is specified. +
    • The RAW_OPTION_MASK and + ALLOW_K13_OPTION_MASK are used. +
    +

    + Options are combined to create the options mask by means of + a logical OR operation. For example, the + option mask can be set as follows: +

         + options_mask = MSB_OPTION_MASK | NN_OPTION_MASK | RAW_OPTION_MASK; + +

    + Szip compresses data block by block, with a user-tunable block size. + This block size is passed in the parameter + pixels_per_block and must be even, + with typical values being 8, 10, + 16, and 32. + The more pixel values vary, the smaller this number should be. + For optimal performance, the number of pixels per scan line + (i.e., the size of the fastest-changing dimension in the dataspace) + should be an even multiple of the number of pixels per block. +

    +

    Notes: +
    Szip works only with datasets with 1 through 24 bits/pixel, + 32 pits/pixel, or 64 bits/pixel. +

    + Szip typically requires that the user application also supply + the number of pixels in the object to be compressed, + the number of bits per pixel, and the number of pixels per scan line. + These values need not be independently supplied in the HDF5 + environment as they are derived from the datatype and dataspace, + which are already known. +

    Parameters: +
    +
    hid_t plist +
    IN: Dataset creation or dataset transfer property list + identifier. +
    unsigned int options_mask +
    IN: A bit-mask conveying the desired szip options. +
    unsigned int pixels_per_block +
    IN: The number of pixels or data elements in each data block. +
    +
    Returns: +
    Returns a non-negative value if successful; + otherwise returns a negative value. + + +

    +

    References: + (This material will appear in a separate file in the final release documents.) +
      +
    • J. Venbrux, P.S. Yeh, G. Zweigle, J. Vesel, + "A VLSI Chip Solution for Lossless Medical Imagery Compression," + SPIE conference on Medical Imaging 1994. + Vol. 2164, pp. 561-572, February 13-14, 1994, + Newport Beach, California. + +
    • J. Venbrux, J. Gambles, D. Wiseman, G. Zweigle, W.H. Miller, P.S. Yeh, + "A VLSI Chip Set Development for Lossless Data Compression," + AIAA Computing in Aerospace 9 Conference. + October 1993, San Diego, California. + +
    • J. Venbrux, G. Zweigle, J. Gambles, D.Wiseman, W. Miller, P. Yeh, + "An Adaptive, Lossless Data Compression Algorithm and VLSI + Implementations," + NASA Symposium on VLSI Design. + Pp 1.2.1-1.2.16, November 1993. + +
    • J. Venbrux, P.S. Yeh, and M. N. Liu, + "A VLSI Chip Set for High Speed Lossless Data Compression," + IEEE Transactions on Circuits and Systems for Video + Technology. + Pp. 381-391, December 1992. + +
    • CCSDS 120.0-G-1. + Lossless Data Compression. + Green Book. Issue 1, May 1997. + This Report presents a summary of the key operational concepts and + rationale underlying the requirements for the CCSDS Recommendation, + Lossless Data Compression. Supporting performance information along + with illustrations are also included. This Report also provides a + broad tutorial overview of the CCSDS Lossless Data Compression + algorithm and is aimed at helping first-time readers + to understand the Recommendation. +
      + Appears In: CCSDS Publications TGannett 02/04/2003 387K Services + Check Out View + +
    • CCSDS 121.0-B-1. + Lossless Data Compression. + Blue Book. Issue 1, May 1997. + This Recommendation defines a source-coding data-compression + algorithm and specifies how data compressed using the algorithm + are inserted into source packets for retrieval and decoding. +
      + Appears In: CCSDS Publications + +
    +
    + + + + + + + + + + + + +
    Name: H5Pset_edc_check @@ -3689,6 +3911,7 @@ facilitate moving easily between them. -->
    +
    Name: H5Pget_edc_check @@ -3718,6 +3941,7 @@ facilitate moving easily between them. -->
    +
    Name: H5Pset_filter_callback @@ -6704,7 +6928,7 @@ And in this document, the Describes HDF5 Release 1.5, Unreleased Development Branch -Last modified: 7 April 2003 +Last modified: 16 April 2003 -- cgit v0.12