Skip to content

Commit 4131d9c

Browse files
authored
Turn HTML table into Markdown (#164)
1 parent 2f485bf commit 4131d9c

File tree

1 file changed

+17
-41
lines changed

1 file changed

+17
-41
lines changed

docs/RegisteredFilterPlugins.md

Lines changed: 17 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -14,36 +14,13 @@ To register a filter please contact The HDF Helpdesk with the following informat
1414

1515
The current policy for filter identifier assignment is as follows:
1616

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>
17+
| Filter Identifier Values | Description |
18+
|--------------------------|-------------|
19+
| `0-255` | These values are reserved for filters predefined and registered by the HDF5 library and of use to the general public. |
20+
| `256-511` | 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. |
21+
| `512-32,767` | 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 [HDF5 development team](mailto:[email protected]) to reserve a value or range of values for use by your filters. |
22+
| `32,768-65,535` | 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. |
23+
4724

4825
List of Filters Registered with The HDF Group
4926
---------------------------------------------
@@ -85,7 +62,7 @@ List of Filters Registered with The HDF Group
8562
|32029 |<a href="#trpx">TERSE/PROLIX</a> |A lossless and fast compression of the diffraction data|
8663
|32030 |<a href="#ffmpeg">FFMPEG</a> |A lossy compression filter based on ffmpeg video library|
8764

88-
> [!NOTE]
65+
> [!NOTE]
8966
> Please contact the maintainer of a filter for help with the filter/compression support in HDF5.
9067
9168
## <center>The Filters</center>
@@ -212,8 +189,8 @@ http://wr.informatik.uni-hamburg.de/research/projects/icomex/mafisc
212189

213190
#### Contact Information:
214191

215-
Nathanael Huebbe
216-
Email: nathanael.huebbe at informatik dot uni-hamburg dot de
192+
Nathanael Huebbe
193+
Email: nathanael.huebbe at informatik dot uni-hamburg dot de
217194

218195
##
219196

@@ -272,7 +249,7 @@ Appears to be no longer available
272249
#### Filter ID: 32006
273250

274251
#### Filter Description:
275-
All imgCIF/CBF compressions and decompressions, including Canonical, Packed, Packed Vesrsion 2, Byte Offset and Nibble Offset.
252+
All imgCIF/CBF compressions and decompressions, including Canonical, Packed, Packed Vesrsion 2, Byte Offset and Nibble Offset.
276253
License Information: GPL and LGPL
277254

278255
#### Contact Information:
@@ -296,7 +273,7 @@ JPEG-XR Filter for HDF5
296273

297274
#### Contact Information:
298275

299-
Marvin Albert
276+
Marvin Albert
300277
Email: marvin dot albert at gmail dot com
301278

302279
##
@@ -569,7 +546,7 @@ This filter is used by Oxford Nanopore specifically to compress raw dna signal d
569546

570547
streamvbyte (https://github.com/lemire/streamvbyte)
571548

572-
zstd (https://github.com/facebook/zstd)
549+
zstd (https://github.com/facebook/zstd)
573550

574551
#### Contact Information:
575552

@@ -651,13 +628,13 @@ Charlie Zender (University of California, Irvine)
651628

652629
#### Filter Description:
653630

654-
SZ3 is a modular error-bounded lossy compression framework for scientific datasets, which allows users to customize their own compression pipeline to adapt to diverse datasets and user-requirements. Compared with SZ2 (filter id: 32017), SZ3 has integrated a more effective prediction such that its compression qualities/ratios are much higher than that of SZ2 in most of cases.
631+
SZ3 is a modular error-bounded lossy compression framework for scientific datasets, which allows users to customize their own compression pipeline to adapt to diverse datasets and user-requirements. Compared with SZ2 (filter id: 32017), SZ3 has integrated a more effective prediction such that its compression qualities/ratios are much higher than that of SZ2 in most of cases.
655632

656633
#### Filter Information:
657634

658635
This filter is documented, implemented, and maintained in github: https://github.com/szcompressor/SZ3.
659636

660-
License: https://github.com/szcompressor/SZ/blob/master/copyright-and-BSD-license.txt
637+
License: https://github.com/szcompressor/SZ/blob/master/copyright-and-BSD-license.txt
661638

662639
#### Contact Information:
663640

@@ -675,7 +652,7 @@ Email: cappello at mcs dot anl dot gov
675652

676653
#### Filter Description:
677654

678-
Lossless compression algorithm optimized for digitized analog signals based on delta encoding and rice coding.
655+
Lossless compression algorithm optimized for digitized analog signals based on delta encoding and rice coding.
679656

680657
#### Filter Information:
681658

@@ -684,7 +661,7 @@ This filter is documented, implemented, and maintained at: https://gitlab.com/dg
684661
#### Contact Information:
685662

686663
David Mathews
687-
Email: david dot mathews dot 1994 at gmail dot com
664+
Email: david dot mathews dot 1994 at gmail dot com
688665

689666
##
690667

@@ -789,4 +766,3 @@ License: Under MIT License
789766

790767
#### Contact Information:
791768
Cai Lab at University of Michigan: https://www.cai-lab.org
792-

0 commit comments

Comments
 (0)