Skip to content

Commit 8e8e4d3

Browse files
authored
Revised the filter ID description (#162)
* updated filter id assignment to match HDF5 documentation
1 parent b9ec059 commit 8e8e4d3

File tree

1 file changed

+34
-7
lines changed

1 file changed

+34
-7
lines changed

docs/RegisteredFilterPlugins.md

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,38 @@ To register a filter please contact The HDF Helpdesk with the following informat
1212
* Short description of the new filter
1313
* Links to any relevant information including licensing information
1414

15-
Here is the current policy regarding filter identifier assignment:
16-
The filter identifier is designed to be a unique identifier for the filter.
17-
Values from `0` to `255` are reserved for internal use by The HDF Group for filters that are part of the HDF5 library itself.
18-
Values from `256` to `511` are available for testing new VOL connectors.
19-
Values from `512` to `32,767` are reserved for filters managed by The HDF Group but are nominally requested, developed, and supported by third parties.
20-
Values from `32768` to `65535` are reserved for non-distributed uses (e.g., internal company usage) or for application usage when testing a feature. The HDF Group does not track or document the usage of filters with identifiers from this range.
21-
Please contact the maintainer of a filter for help with the filter/compression support in HDF5.
15+
The current policy for filter identifier assignment is as follows:
16+
17+
<table>
18+
<tr>
19+
<th>Filter Identifier Values</th><th>Description</th>
20+
</tr>
21+
<tr>
22+
<td><code>0-255</code></td>
23+
<td>These values are reserved for filters predefined and
24+
registered by the HDF5 library and of use to the general public.</td>
25+
</tr>
26+
<tr>
27+
<td><code>256-511</code></td>
28+
<td>Filter values in this range are intended for testing only and can be
29+
temporarily used by any organization. No attempts are made to resolve
30+
numbering conflicts, as all definitions are temporary.</td>
31+
</tr>
32+
<tr>
33+
<td><code>512-32,767</code></td>
34+
<td>Filter values within this range are designated for filters managed by
35+
The HDF Group, but they are nominally requested, developed, and supported
36+
by third parties. Please contact the
37+
<a href="mailto:[email protected]">HDF5 development team</a>
38+
to reserve a value or range of values for use by your filters.</td>
39+
</tr>
40+
<tr>
41+
<td><code>32,768-65,535</code></td>
42+
<td>Filter values in this range are designated for internal company use or
43+
application testing when assessing a feature. The HDF Group does not
44+
track or document the use of filters within this range.</td>
45+
</tr>
46+
</table>
2247

2348
List of Filters Registered with The HDF Group
2449
---------------------------------------------
@@ -60,6 +85,8 @@ List of Filters Registered with The HDF Group
6085
|32029 |<a href="#trpx">TERSE/PROLIX</a> |A lossless and fast compression of the diffraction data|
6186
|32030 |<a href="#ffmpeg">FFMPEG</a> |A lossy compression filter based on ffmpeg video library|
6287

88+
> [!NOTE]
89+
> Please contact the maintainer of a filter for help with the filter/compression support in HDF5.
6390
6491
## <center>The Filters</center>
6592

0 commit comments

Comments
 (0)