Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revised the filter ID description #162

Merged
merged 5 commits into from
Nov 25, 2024
Merged

Revised the filter ID description #162

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2544a26
Revise the filter ID description to align with the specifications out…
brtnfld Nov 22, 2024
1d47436
updated filter id assignment to match HDF5 documentation
brtnfld Nov 22, 2024
979e336
updated filter id assignment to match HDF5 documentation
brtnfld Nov 22, 2024
d6ccb0b
updated filter id assignment to match HDF5 documentation
brtnfld Nov 22, 2024
dcbbf97
updated filter id assignment to match HDF5 documentation
brtnfld Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 34 additions & 7 deletions docs/RegisteredFilterPlugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,38 @@ To register a filter please contact The HDF Helpdesk with the following informat
* Short description of the new filter
* Links to any relevant information including licensing information

Here is the current policy regarding filter identifier assignment:
The filter identifier is designed to be a unique identifier for the filter.
Values from `0` to `255` are reserved for internal use by The HDF Group for filters that are part of the HDF5 library itself.
Values from `256` to `511` are available for testing new VOL connectors.
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.
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.
Please contact the maintainer of a filter for help with the filter/compression support in HDF5.
The current policy for filter identifier assignment is as follows:

<table>
<tr>
<th>Filter Identifier Values</th><th>Description</th>
</tr>
<tr>
<td><code>0-255</code></td>
<td>These values are reserved for filters predefined and
registered by the HDF5 library and of use to the general public.</td>
</tr>
<tr>
<td><code>256-511</code></td>
<td>Filter values in this range are intended for testing only and can be
temporarily used by any organization. No attempts are made to resolve
numbering conflicts, as all definitions are temporary.</td>
</tr>
<tr>
<td><code>512-32,767</code></td>
<td>Filter values within this range are designated for filters managed by
The HDF Group, but they are nominally requested, developed, and supported
by third parties. Please contact the
<a href="mailto:[email protected]">HDF5 development team</a>
to reserve a value or range of values for use by your filters.</td>
</tr>
<tr>
<td><code>32,768-65,535</code></td>
<td>Filter values in this range are designated for internal company use or
application testing when assessing a feature. The HDF Group does not
track or document the use of filters within this range.</td>
</tr>
</table>

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

> [!NOTE]
> Please contact the maintainer of a filter for help with the filter/compression support in HDF5.

## <center>The Filters</center>

Expand Down