From 82a89d2c18953ca826f3fa805f01f81255839531 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Mon, 30 Jun 2003 13:52:18 -0500 Subject: [svn-r7125] Purpose: H5Pset_shuffle -- Add note regarding intended use. H5Pset_szip -- Correct options mask list. Copy edits. Description: H5Pset_shuffle -- Added note that the shuffle filter is designed to be used with in combination a compression filter. H5Pset_szip -- Changed 'szip' to 'SZIP' in running text. Removed RAW_OPTIONS_MASK, LSB_OPTIONS_MASK, and MSB-OPTIONS_MASK from options maks list as they are not available for user control. Added 'H5_SZIP_' prefix to all remaining option tags. Made corresponding changes to running text, removing or revising mentions of deleted option tags. Platforms tested: IE 5 --- doc/html/RM_H5P.html | 46 +++++++++++++++++++++++++--------------------- 1 file changed, 25 insertions(+), 21 deletions(-) diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html index 69da68d..6672902 100644 --- a/doc/html/RM_H5P.html +++ b/doc/html/RM_H5P.html @@ -3922,6 +3922,9 @@ facilitate moving easily between them. algorithm because the bytes in each byte position are often closely related to each other and putting them together can increase the compression ratio. +

+ This filter is designed to be used in combination with + a compression filter.

Parameters:
hid_t plist_id @@ -3979,13 +3982,13 @@ facilitate moving easily between them. unsigned int options_mask, unsigned int pixels_per_block)
Purpose: -
Sets up use of the szip compression filter. +
Sets up use of the SZIP compression filter.
Description:
H5Pset_szip sets a filter for the dataset - to szip compression, H5Z_FILTER_SZIP, + to SZIP compression, H5Z_FILTER_SZIP, a compression method designed for use with scientific data.

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

@@ -4001,30 +4004,33 @@ facilitate moving easily between them. + +
- CHIP_OPTION_MASK   + H5_SZIP_CHIP_OPTION_MASK  
Compresses exactly as in hardware.
- ALLOW_K13_OPTION_MASK   + H5_SZIP_ALLOW_K13_OPTION_MASK   Allows k split = 13 compression mode. (Default)
- EC_OPTION_MASK + H5_SZIP_EC_OPTION_MASK
Selects entropy coding method. (Default)
- NN_OPTION_MASK + H5_SZIP_NN_OPTION_MASK Selects nearest neighbor coding method.
@@ -4056,24 +4064,20 @@ facilitate moving easily between them. 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. + H5_SZIP_EC_OPTION_MASK or + H5_SZIP_NN_OPTION_MASK, is specified. +
  • The H5_SZIP_ALLOW_K13_OPTION_MASK is 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; + options_mask = H5_SZIP_NN_OPTION_MASK | H5_SZIP_ALLOW_K13_OPTION_MASK;

- Szip compresses data block by block, with a user-tunable block size. + 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, @@ -4084,10 +4088,10 @@ facilitate moving easily between them. should be an even multiple of the number of pixels per block.

Notes: -
Szip works only with datasets with 1 through 24 bits/pixel, +
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 + 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 @@ -4099,7 +4103,7 @@ facilitate moving easily between them.

IN: Dataset creation or dataset transfer property list identifier.
unsigned int options_mask -
IN: A bit-mask conveying the desired szip options. +
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. @@ -7633,7 +7637,7 @@ And in this document, the Describes HDF5 Release 1.5, Unreleased Development Branch -Last modified: 25 June 2003 +Last modified: 30 June 2003 -- cgit v0.12