From 39b18b8e0fb1b7d19a178a31ac16b1baaf113d98 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Wed, 12 Jan 2005 13:18:43 -0500 Subject: [svn-r9813] Purpose: Added H5Pset/get_data_transform These are initial entries; they need technical review. Removed several deprecated functions that have been commented out through several release cycles (H5Pget_deflate and H5Pset/get_compression) and several lines of no-longer-used template code. Minor formatting changes. Platforms tested: Mozilla --- doc/html/RM_H5P.html | 362 ++++++++++++++++++++------------------------------- 1 file changed, 138 insertions(+), 224 deletions(-) diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html index 4504519..2d0572a 100644 --- a/doc/html/RM_H5P.html +++ b/doc/html/RM_H5P.html @@ -242,6 +242,8 @@ which require many different parameters to be easily manipulated.
  • H5Pset_edc_check
  • H5Pget_edc_check
  • H5Pset_filter_callback +
  • H5Pset_data_transform +
  • H5Pget_data_transform
  • H5Pset_hyper_vector_size
  • H5Pget_hyper_vector_size
  • H5Pset_btree_ratios @@ -285,7 +287,7 @@ which require many different parameters to be easily manipulated.
  • H5Pcopy
  • H5Pclose - + Generic Properties -

    +

       || Indicates functions
         available only in the
         parallel HDF5 library.     -











    +











       (Function listing
       continues on next page.)     @@ -484,7 +486,7 @@ See further notes in the description of each function. @@ -2310,6 +2312,69 @@ END SUBROUTINE h5pget_class_parent_f + +
    +
    +
    Name: H5Pget_data_transform +
    Signature: +
    ssize_t H5Pget_data_transform + (hid_t plist_id, + char *expression, + size_t size) +
    Purpose: +
    Retrieves a data transform expression. +
    Description: +
    H5Pget_data_transform retrieves the data + transform expression previously set in the dataset transfer + property list plist_id by H5Pset_data_transform. +

    H5Pget_data_transform can be used to both + retrieve the transform expression and to query its size. +

    + If expression is non-NULL, up to size + bytes of the data transform expression are written to the buffer. + If expression is NULL, size is ignored + and the function does not write anything to the buffer. + The function always returns the size of the data transform expression. +

    + If 0 is returned for the size of the expression, + no data transform expression exists for the property list. +

    + If an error occurs, the buffer pointed to by expression + is unchanged and the function returns a negative value. +

    Parameters: +
      -        -        -

      ||  Available only in the parallel HDF5 library.
      + + + + + + + + + +
      hid_t plist_idIN: Identifier of the property list or class
      char *expression  OUT: Pointer to memory where the transform + expression will be copied
      size_t sizeIN: Number of bytes of the transform expression + to copy to
      +
      Returns: +
      Success: size of the transform expression. +
      Failure: a negative value. +
      Fortran90 Interface: +
      None. + + + + + +
      @@ -6153,6 +6218,69 @@ END SUBROUTINE h5pset_chunk_f
      + +
      +
      +
      Name: H5Pset_data_transform +
      Signature: +
      herr_t H5Pset_data_transform + (hid_t plist_id, + const char *expression) +
      Purpose: +
      Sets a data transform expression. +
      Description: +
      H5Pset_data_transform sets the data transform to + be used for reading and writing data. + This function operates on the dataset transfer property lists + plist_id. +

      + The expression parameter is a string containing an algebraic + expression, such as (5/9.0)*(x-32) + or x*(x-5). + When a dataset is read or written with this property list, + the transform expression is applied with the x + being replaced by the values in the dataset. + When reading data, the values in the file are not changed + and the transformed data is returned to the user. +

      + Data transforms can only be applied to integer or floating-point + datasets. Order of operations is obeyed and the only supported + operations are +, -, *, and /. Parentheses can be nested arbitrarily + and can be used to change precedence. +

      + When writing data back to the dataset, the transformed data is + written to the file and there is no way to recover the original + values to which the transform was applied. +

      Parameters: +
        + + + + + + +
        hid_t plist_idIN: Identifier of the property list or class
        const char *expression  IN: Pointer to the null-terminated data transform expression +
      +
      Returns: +
      Success: a non-negative value +
      Failure: a negative value +
      Fortran90 Interface: +
      None. + + + +
      + +
      @@ -9534,220 +9662,6 @@ END SUBROUTINE h5punregister_f
      - - - - - - - - - - - - - - - - -
      @@ -9789,7 +9703,7 @@ And in this document, the Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 -- cgit v0.12