mirror of
https://github.com/HDFGroup/hdf5.git
synced 2025-04-12 17:31:09 +08:00
[svn-r9192]
Purpose:
Add H5Zget_filter_info and h5zget_filter_info_f.
Other minor edits.
Platforms tested:
Mozilla
This commit is contained in:
Frank Baker
parent
0914b3606c
commit
8ef6fcba4c
@ -72,15 +72,16 @@ These functions enable the user to configure new filters
|
||||
for the local environment.
|
||||
|
||||
<table border=0 width=80%>
|
||||
<tr><td valign=top>
|
||||
<tr><td valign=top width="30%">
|
||||
<ul>
|
||||
<li><a href="#Compression-FilterAvail">H5Zfilter_avail</a>
|
||||
<li><a href="#Compression-FilterAvail">H5Zfilter_avail</a><br>
|
||||
<li><a href="#Compression-GetFilterInfo">H5Zget_filter_info</a>
|
||||
</ul>
|
||||
</td><td> </td><td valign=top>
|
||||
</td><td> </td><td valign=top width="30%">
|
||||
<ul>
|
||||
<li><a href="#Compression-Register">H5Zregister</a>
|
||||
</ul>
|
||||
</td><td> </td><td valign=top>
|
||||
</td><td> </td><td valign=top width="30%">
|
||||
<ul>
|
||||
<li><a href="#Compression-Unregister">H5Zunregister</a>
|
||||
</ul>
|
||||
@ -95,16 +96,16 @@ as the corresponding C function.
|
||||
<br>
|
||||
|
||||
<table border=0 width=80%>
|
||||
<tr><td valign=top>
|
||||
<tr><td valign=top width="30%">
|
||||
<ul>
|
||||
<li><a href="#Compression-FilterAvail">h5zfilter_avail_f</a>
|
||||
</ul>
|
||||
</td><td> </td><td valign=top>
|
||||
</td><td> </td><td valign=top width="30%">
|
||||
<ul>
|
||||
<!--<li><a href="#Compression-Register">h5zregister_f</a> -->
|
||||
|
||||
<!--<li><a href="#Compression-Register">h5zregister_f</a><br> -->
|
||||
<li><a href="#Compression-GetFilterInfo">h5zget_filter_info_f</a>
|
||||
</ul>
|
||||
</td><td> </td><td valign=top>
|
||||
</td><td> </td><td valign=top width="30%">
|
||||
<ul>
|
||||
<li><a href="#Compression-Unregister">h5zunregister_f</a>
|
||||
</ul>
|
||||
@ -179,7 +180,7 @@ data compression.
|
||||
<td valign="top"><em>H5Z_filter_t</em> <code>filter </code></td>
|
||||
<td valign="top">IN: Filter identifier.
|
||||
See the introduction to this section of the reference manual
|
||||
for a list of valid filter identifiers</td></tr>
|
||||
for a list of valid filter identifiers.</td></tr>
|
||||
</table></ul>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns a non-negative value if successful;
|
||||
@ -210,6 +211,124 @@ END SUBROUTINE h5zfilter_avail_f
|
||||
-->
|
||||
</dl>
|
||||
|
||||
|
||||
<!-- NEW PAGE -->
|
||||
<!-- HEADER RIGHT "H5Zget_filter_info" -->
|
||||
<hr>
|
||||
<dl>
|
||||
<dt><strong>Name:</strong> <a name="Compression-GetFilterInfo">H5Zget_filter_info</a>
|
||||
<dt><strong>Signature:</strong>
|
||||
<dd><em>herr_t</em>
|
||||
<code>H5Zget_filter_info</code>(
|
||||
<em>H5Z_filter_t</em> <code>filter</code>,
|
||||
<em>unsigned int *</em><code>filter_config_flags</code>
|
||||
)
|
||||
<dt><strong>Purpose:</strong>
|
||||
<dd>Retrieves information about a filter.
|
||||
<dt><strong>Description:</strong>
|
||||
<dd>
|
||||
<code>H5Zget_filter_info</code> retrieves information about a filter.
|
||||
At present, this means that the function retrieves a
|
||||
filter's configuration flags, indicating whether the filter is
|
||||
configured to decode data, to encode data, neither, or both.
|
||||
<p>
|
||||
If <code>filter_config_flags</code> is not set to <small>NULL</small>
|
||||
prior to the function call, the returned parameter contains a
|
||||
bit field specifying the available filter configuration.
|
||||
The configuration flag values can then be determined through
|
||||
a series of bitwise <small>AND</small> operations, as described below.
|
||||
<p>
|
||||
Valid filter configuration flags include the following:
|
||||
<table>
|
||||
<tr><td><code> </code></td>
|
||||
<td><code>H5Z_FILTER_CONFIG_ENCODE_ENABLED</code></td>
|
||||
<td>Encoding is enabled for this filter
|
||||
</td></tr>
|
||||
<tr><td> </td>
|
||||
<td><code>H5Z_FILTER_CONFIG_DECODE_ENABLED</code> </td>
|
||||
<td>Decoding is enabled for this filter
|
||||
</td></tr>
|
||||
<tr><td> </td>
|
||||
<td colspan="2" align="right"><small>(These flags
|
||||
are defined in the HDF5 Library source code file
|
||||
<code>H5Zpublic.h</code>.)</small>
|
||||
</td></tr>
|
||||
</table>
|
||||
A bitwise <small>AND</small> of the returned
|
||||
<code>filter_config_flags</code> and a valid
|
||||
filter configuration flag will reveal whether
|
||||
the related configuration option is available.
|
||||
For example, if the value of
|
||||
<br>
|
||||
<code>
|
||||
H5Z_FILTER_CONFIG_ENCODE_ENABLED
|
||||
&
|
||||
filter_config_flags</code>
|
||||
<br>
|
||||
is true, i.e., greater than <code>0</code> (zero),
|
||||
the queried filter is configured to encode data;
|
||||
if the value is <code>FALSE</code>,
|
||||
i.e., equal to <code>0</code> (zero),
|
||||
the filter is not so configured.
|
||||
<p>
|
||||
If a filter is not encode-enabled, the corresponding
|
||||
<code>H5Pset_*</code> function will return an error if the
|
||||
filter is added to a dataset creation property list (which is
|
||||
required if the filter is to be used to encode that dataset).
|
||||
For example, if the <code>H5Z_FILTER_CONFIG_ENCODE_ENABLED</code>
|
||||
flag is not returned for the SZIP filter,
|
||||
<code>H5Z_FILTER_SZIP</code>, a call to <code>H5Pset_szip</code>
|
||||
will fail.
|
||||
<p>
|
||||
If a filter is not decode-enabled, the application will not be
|
||||
able to read an existing file encoded with that filter.
|
||||
<p>
|
||||
This function should be called, and the returned
|
||||
<code>filter_config_flags</code> analyzed, before calling
|
||||
any other function, such as <code>H5Pset_szip</code>,
|
||||
that might require a particular filter configuration.
|
||||
|
||||
<dt><strong>Parameters:</strong>
|
||||
<dl>
|
||||
<dt><em>H5Z_filter_t</em> <code>filter</code>
|
||||
<dd>IN: Identifier of the filter to query.
|
||||
See the introduction to this section of the reference manual
|
||||
for a list of valid filter identifiers.
|
||||
<dt><em>unsigned int *</em><code>filter_config_flags</code>
|
||||
<dd>OUT: A bit field encoding the returned filter information
|
||||
</dl>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns a non-negative value on success,
|
||||
a negative value on failure.
|
||||
|
||||
<dt><strong>Fortran90 Interface:</strong>
|
||||
<dd>
|
||||
<pre>
|
||||
SUBROUTINE h5zget_filter_info_f(filter, config_flags, hdferr)
|
||||
|
||||
IMPLICIT NONE
|
||||
INTEGER, INTENT(IN) :: filter ! Filter, may be one of the
|
||||
! following:
|
||||
! H5Z_FILTER_DEFLATE_F
|
||||
! H5Z_FILTER_SHUFFLE_F
|
||||
! H5Z_FILTER_FLETCHER32_F
|
||||
! H5Z_FILTER_SZIP_F
|
||||
INTEGER, INTENT(OUT) :: config_flags ! Bit field indicating whether
|
||||
! a filter's encoder and/or
|
||||
! decoder are available
|
||||
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
||||
|
||||
END SUBROUTINE h5zfilter_avail_f
|
||||
</pre>
|
||||
<!--<dt><strong>Non-C API(s):</strong>
|
||||
<dd>
|
||||
|
||||
<img src="Graphics/Java.gif">
|
||||
<img src="Graphics/C++.gif">
|
||||
-->
|
||||
</dl>
|
||||
|
||||
|
||||
<!-- NEW PAGE -->
|
||||
<!-- HEADER RIGHT "H5Zregister" -->
|
||||
<hr>
|
||||
@ -446,7 +565,8 @@ END SUBROUTINE h5zfilter_avail_f
|
||||
<td valign="top"><em>H5Z_filter_t</em> <code>filter </code></td>
|
||||
<td valign="top">IN: Identifier of the filter to be unregistered.
|
||||
See the introduction to this section of the reference manual
|
||||
for a list of valid filter identifiers</td></tr>
|
||||
for a list of identifiers for standard filters
|
||||
distributed with the HDF5 Library.</td></tr>
|
||||
</table></ul>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns a non-negative value if successful;
|
||||
@ -515,7 +635,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: 1 July 2004");
|
||||
document.writeln("Last modified: 2 September 2004");
|
||||
-->
|
||||
</SCRIPT>
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user