mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-04-24 17:51:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

[svn-r9161]

Browse Source 
Purpose:
    Revise H5Premove_filter
    H5Pset_chunk bug fix
    Correct H5Premove signature
    Formatting fix
Description:
    H5Premove_filter -- editorial and technical revisions
                        replaced F90 description
    H5Pset_chunk -- specified units of chunk size as "dataset elements"
                    fixes Bugzilla #110
    H5Premove -- corrected signature, removing duplicate mention of parameters
    Corrected "electronic versus print" formatting error in functions index
Platforms tested:
    Mozilla

Misc. update:
This commit is contained in:
Frank Baker 2004-08-26 12:25:36 -05:00
parent 6a452a343f
commit 1fe42a257e
1 changed files with 63 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

113
doc/html/RM_H5P.html
View File

@ -73,7 +73,7 @@ which require many different parameters to be easily manipulated.
<p>
<strong>The C Interfaces:</strong>
<!-- FOR USE WITH ELECTRONIC VERSION -----------------------------------
<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------->
<table border=0>
<tr><td valign=top>
@ -154,12 +154,12 @@ which require many different parameters to be easily manipulated.
<li><a href="#Property-SetFaplStream">H5Pset_fapl_stream</a>
<li><a href="#Property-GetFaplStream">H5Pget_fapl_stream</a>
<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------->
<!--<li><a href="#Property-SetDriver">H5Pset_driver</a> -->
<!-- FOR USE WITH ELECTRONIC VERSION -----------------------------------
<!--<li><a href="#Property-SetDriver">H5Pset_driver</a> -->
<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------->
<li><a href="#Property-GetDriver">H5Pget_driver</a>
<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------->
<!--<li><a href="#Property-GetDriverInfo">H5Pget_driver_info</a> -->
<!-- FOR USE WITH ELECTRONIC VERSION -----------------------------------
<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------->
<li><a href="#Property-SetMetaBlockSize">H5Pset_meta_block_size</a>
<li><a href="#Property-GetMetaBlockSize">H5Pget_meta_block_size</a>
<li><a href="#Property-SetSieveBufSize">H5Pset_sieve_buf_size</a>
@ -179,7 +179,7 @@ which require many different parameters to be easily manipulated.
<li><a href="#Property-xxx">xxx</a>
<li><a href="#Property-xxx">xxx</a>&nbsp;&nbsp;&nbsp;||
-->
<!-- FOR USE WITH ELECTRONIC VERSION -----------------------------------
<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------->
</ul>
<br>&nbsp;
@ -211,7 +211,7 @@ which require many different parameters to be easily manipulated.
<li><a href="#Property-SetCompression">H5Pset_compression</a>
<li><a href="#Property-GetCompression">H5Pget_compression</a>
-->
<!-- FOR USE WITH ELECTRONIC VERSION -----------------------------------
<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------->
<li><a href="#Property-SetFillValue">H5Pset_fill_value</a>
<li><a href="#Property-GetFillValue">H5Pget_fill_value</a>
<li><a href="#Property-FillValueDefined">H5Pfill_value_defined</a>
@ -225,13 +225,13 @@ which require many different parameters to be easily manipulated.
<li><a href="#Property-GetFilter">H5Pget_filter</a>
<li><a href="#Property-GetFilterById">H5Pget_filter_by_id</a>
<li><a href="#Property-ModifyFilter">H5Pmodify_filter</a>
<li><a href="#Property-RemoveFilter">H5Premove_filter</a>
<li><a href="#Property-SetFletcher32">H5Pset_fletcher32</a>
<li><a href="#Property-SetShuffle">H5Pset_shuffle</a>
<li><a href="#Property-SetSzip">H5Pset_szip</a>
<li><a href="#Property-SetExternal">H5Pset_external</a>
<li><a href="#Property-GetExternalCount">H5Pget_external_count</a>
<li><a href="#Property-GetExternal">H5Pget_external</a>
<li><a href="#Property-DeleteFilter">H5Premove_filter</a>
</ul>
<p><i>Dataset Access, Memory, and <br> Transfer Properties</i>
@ -268,11 +268,13 @@ which require many different parameters to be easily manipulated.
||&nbsp;&nbsp;&nbsp;<i>Available only in the parallel HDF5 library.</i>
</td></tr>
-->
<!-- FOR USE WITH ELECTRONIC VERSION -----------------------------------
<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------->
</table>
-- FOR USE WITH ELECTRONIC VERSION ----------------------------------->
<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------->
<!-- FOR USE WITH PRINT VERSION ---------------------------------------->
<!-- FOR USE WITH PRINT VERSION ----------------------------------------
<table border="0" width="95%">
<tr>
<td valign="top" width="31%">
@ -333,12 +335,12 @@ which require many different parameters to be easily manipulated.
<li><a href="#Property-SetFaplStream">H5Pset_fapl_stream</a>
<li><a href="#Property-GetFaplStream">H5Pget_fapl_stream</a>
<!-- FOR USE WITH PRINT VERSION ---------------------------------------->
<!--<li><a href="#Property-SetDriver">H5Pset_driver</a> -->
<!-- FOR USE WITH PRINT VERSION ---------------------------------------->
<!--<li><a href="#Property-SetDriver">H5Pset_driver</a> -->
<!-- FOR USE WITH PRINT VERSION ----------------------------------------
<li><a href="#Property-GetDriver">H5Pget_driver</a>
<!-- FOR USE WITH PRINT VERSION ---------------------------------------->
<!--<li><a href="#Property-GetDriverInfo">H5Pget_driver_info</a> -->
<!-- FOR USE WITH PRINT VERSION ---------------------------------------->
<!--<li><a href="#Property-GetDriverInfo">H5Pget_driver_info</a> -->
<!-- FOR USE WITH PRINT VERSION ----------------------------------------
<li><a href="#Property-SetMetaBlockSize">H5Pset_meta_block_size</a>
<li><a href="#Property-GetMetaBlockSize">H5Pget_meta_block_size</a>
<li><a href="#Property-SetSieveBufSize">H5Pset_sieve_buf_size</a>
@ -358,7 +360,7 @@ which require many different parameters to be easily manipulated.
<li><a href="#Property-xxx">xxx</a>
<li><a href="#Property-xxx">xxx</a>&nbsp;&nbsp;&nbsp;||
-->
<!-- FOR USE WITH PRINT VERSION ---------------------------------------->
<!-- FOR USE WITH PRINT VERSION ----------------------------------------
</ul>
</td>
<td valign="top" width="3%">&nbsp;</td>
@ -395,7 +397,7 @@ which require many different parameters to be easily manipulated.
<!-- NEW PAGE -->
<!-- FOR USE WITH PRINT VERSION ---------------------------------------->
<!-- FOR USE WITH PRINT VERSION ----------------------------------------
<table border="0" width="95%">
<tr>
<td valign="top" width="31%">
@ -412,7 +414,7 @@ which require many different parameters to be easily manipulated.
<li><a href="#Property-SetCompression">H5Pset_compression</a>
<li><a href="#Property-GetCompression">H5Pget_compression</a>
-->
<!-- FOR USE WITH PRINT VERSION ---------------------------------------->
<!-- FOR USE WITH PRINT VERSION ----------------------------------------
<li><a href="#Property-SetFillValue">H5Pset_fill_value</a>
<li><a href="#Property-GetFillValue">H5Pget_fill_value</a>
<li><a href="#Property-FillValueDefined">H5Pfill_value_defined</a>
@ -426,6 +428,7 @@ which require many different parameters to be easily manipulated.
<li><a href="#Property-GetFilter">H5Pget_filter</a>
<li><a href="#Property-GetFilterById">H5Pget_filter_by_id</a>
<li><a href="#Property-ModifyFilter">H5Pmodify_filter</a>
<li><a href="#Property-RemoveFilter">H5Premove_filter</a>
<li><a href="#Property-SetFletcher32">H5Pset_fletcher32</a>
<li><a href="#Property-SetShuffle">H5Pset_shuffle</a>
<li><a href="#Property-SetSzip">H5Pset_szip</a>
@ -495,7 +498,6 @@ See further notes in the description of each function.
<li><a href="#Property-Create">H5Pcreate</a>
<li><a href="#Property-CreateClass">H5Pcreate_class</a>
<li><a href="#Property-CreateList">H5Pcreate_list</a>
<li><a href="#Property-Equal">H5Premove_filter</a>
<li><a href="#Property-Equal">H5Pequal</a>
<li><a href="#Property-Exist">H5Pexist</a>
<li><a href="#Property-FillValueDefined">H5Pfill_value_defined</a>
@ -560,6 +562,7 @@ See further notes in the description of each function.
<li><a href="#Property-ModifyFilter">H5Pmodify_filter</a>
<li><a href="#Property-Register">H5Pregister</a>
<li><a href="#Property-Remove">H5Premove</a>
<li><a href="#Property-RemoveFilter">H5Premove_filter</a>
<li><a href="#Property-Set">H5Pset</a>
<li><a href="#Property-SetAlignment">H5Pset_alignment</a>
<li><a href="#Property-SetAllocTime">H5Pset_alloc_time</a>
@ -717,13 +720,13 @@ as the corresponding C function.
<li><a href="#Property-GetFilter">h5pget_filter_f</a>
<li><a href="#Property-GetFilterById">h5pget_filter_by_id_f</a>
<li><a href="#Property-ModifyFilter">h5pmodify_filter_f</a>
<li><a href="#Property-RemoveFilter">h5premove_filter_f</a>
<li><a href="#Property-SetFletcher32">h5pset_fletcher32_f</a>
<li><a href="#Property-SetShuffle">h5pset_shuffle_f</a>
<li><a href="#Property-SetSzip">h5pset_szip_f</a>
<li><a href="#Property-SetExternal">h5pset_external_f</a>
<li><a href="#Property-GetExternalCount">h5pget_external_count_f</a>
<li><a href="#Property-GetExternal">h5pget_external_f</a>
<li><a href="#Property-DeleteFilter">h5premove_filter_f</a>
</ul>
<!--
@ -1410,7 +1413,7 @@ SUBROUTINE
<!-- HEADER RIGHT "H5Premove_filter" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-RemoveFilter">H5Pdelete_filter</a>
<dt><strong>Name:</strong> <a name="Property-RemoveFilter">H5Premove_filter</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Premove_filter</code>(<em>hid_t</em> <code>plist</code>,
<em>H5Z_filter_t</em> <code>filter</code>
@ -1419,10 +1422,11 @@ SUBROUTINE
<dd>Delete one or more filters in the filter pipeline.
<dt><strong>Description:</strong>
<dd><code>H5Premove_filter</code> removes the specified
<code>filter</code> from the filter pipeline in <code>plist</code>.
<code>filter</code> from the filter pipeline in the
dataset creation property list <code>plist</code>.
<p>
The <code>filter</code> parameter specifies the filter to be removed.
Valid values of filters to remove are as follows:
Valid values for use in <code>filter</code> are as follows:
<center>
<table width=75%>
@ -1454,9 +1458,9 @@ SUBROUTINE
</table>
</center>
<p>
Additionally, user defined filters can be removed with this routine
as well by passing the filter ID they were registered with the library
with.
Additionally, user-defined filters can be removed with this routine
by passing the filter identifier with which they were registered
with the HDF5 Library.
<p>
Attempting to remove a filter that is not in the permanent filter
pipeline is an error.
@ -1467,9 +1471,9 @@ SUBROUTINE
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist_id</code>
<dd>IN: Property list identifier.
<dd>IN: Dataset creation property list identifier.
<dt><em>H5Z_filter_t</em> <code>filter</code>
<dd>IN: Type of filter to be deleted.
<dd>IN: Filter to be deleted.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
@ -1479,19 +1483,20 @@ SUBROUTINE
<dd>
<pre>
SUBROUTINE h5premove_filter_f(prp_id, filter, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
INTEGER, INTENT(IN) :: filter ! Filter to be modified
! Valid values are:
!
! H5Z_FILTER_ALL_F
! H5Z_FILTER_DEFLATE_F
! H5Z_FILTER_SHUFFLE_F
! H5Z_FILTER_FLETCHER32_F
! H5Z_FILTER_SZIP_F
!
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
INTEGER(HID_T), INTENT(IN) :: prp_id ! Dataset creation property
! list identifier
INTEGER, INTENT(IN) :: filter ! Filter to be removed
! Valid values are:
! H5Z_FILTER_ALL_F
! H5Z_FILTER_DEFLATE_F
! H5Z_FILTER_SHUFFLE_F
! H5Z_FILTER_FLETCHER32_F
! H5Z_FILTER_SZIP_F
!
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success, -1 on failure
END SUBROUTINE h5premove_filter_f
</pre>
@ -5539,7 +5544,7 @@ END SUBROUTINE h5pregister_f
<dt><strong>Name:</strong> <a name="Property-Remove">H5Premove</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Premove</code>(<code>plid, name</code>)
<dd><em>herr_t</em> <code>H5Premove</code>(
<em>hid_t</em> <code>plid</code>;
<em>const char *</em><code>name</code>
)
@ -6093,22 +6098,30 @@ END SUBROUTINE h5pset_cache_f
<dd><code>H5Pset_chunk</code> sets the size of the chunks used to
store a chunked layout dataset. This function is only valid
for dataset creation property lists.
<p>
The <code>ndims</code> parameter currently must be the same size
as the rank of the dataset. The values of the <code>dim</code>
as the rank of the dataset.
<p>
The values of the <code>dim</code>
array define the size of the chunks to store the dataset's raw data.
As a side-effect, the layout of the dataset is changed to
<code>H5D_CHUNKED</code>, if it is not already.
The unit of measure for <code>dim</code> values is
<em>dataset elements</em>.
<p>
As a side-effect of this function, the layout of the dataset is
changed to <code>H5D_CHUNKED</code>, if it is not already so set.
(See <a href="#Property-SetLayout"><code>H5Pset_layout</code></a>.)
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>plist</code></td>
<td valign="top">IN: Identifier for property list to query.</td></tr>
<td valign="top"><em>hid_t</em> <code>plist</code></td>
<td valign="top">IN: Identifier for property list to query.</td></tr>
<tr>
<td valign="top"><em>int</em> <code>ndims</code></td>
<td valign="top">IN: The number of dimensions of each chunk.</td></tr>
<td valign="top"><em>int</em> <code>ndims</code></td>
<td valign="top">IN: The number of dimensions of each chunk.</td></tr>
<tr>
<td valign="top"><em>const&nbsp;hsize_t&nbsp;*</em>&nbsp;<code>dim&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">IN: An array containing the size of each chunk.</td></tr>
<td valign="top"><em>const&nbsp;hsize_t&nbsp;*</em>&nbsp;<code>dim&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">IN: An array defining the size, in dataset elements,
of each chunk.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
@ -9695,7 +9708,7 @@ And in this document, the
Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0
</address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT">
<!--
document.writeln("Last modified: 2 July 2004");
document.writeln("Last modified: 26 August 2004");
-->
</SCRIPT>