Skip to content

Canonical name confirmation for H5Z_class3_t filter plugins #255

@brtnfld

Description

@brtnfld

HDF5 2.x introduces a new filter plugin class, H5Z_class3_t, that turns
the name field from a free-form debug comment into a load-bearing
canonical name — the string identifier used by the new
H5Pappend_filter API, written into the on-disk filter-pipeline message,
and displayed by h5dump / h5repack. See RFC-HDFG-2026-001 (linked in
the companion PR) and the "Canonical Names" section of
docs/RegisteredFilterPlugins.md for the full contract.

This issue tracks maintainer confirmation of the proposed canonical
name for each currently registered plugin. The companion PR pre-fills a
proposed name in the registry table and marks each row (proposed).

What we need from you

Maintainers: please review the proposed name for your filter ID and
reply on this issue with one explicit line naming the ID and the
name so there is no ambiguity. (Please confirm here on the issue, not
on the companion PR #256 — the PR is for review of the doc edit itself
and confirmations would get lost during code review. Also please don't
use a 👍 reaction on the issue body — there's no way to tell which row
a reaction refers to.)

To confirm:

Confirm: ID 32013, canonical name zfp.

To request a correction (subject to the syntactic rules [A-Za-z0-9_.-],
≤255 bytes, case-sensitive):

Correction: ID 32013, canonical name should be zfp-v2.

Once confirmed, we'll drop the (proposed) marker for your row in
docs/RegisteredFilterPlugins.md and flip the row indicator below from
☐ to ✅. (The indicator is a static symbol — GitHub doesn't allow
interactive checkboxes inside a table — so don't try to click it.)

If you don't have a GitHub account, you can also confirm by email to
help@hdfgroup.org and we'll relay it onto this issue.

This change has no effect on existing plugin builds. Canonical names
only become load-bearing when a plugin opts into the new H5Z_class3_t
class — that is a separate, opt-in code change in each plugin's source.

Comment window

~6 weeks from this issue's open date. After that, rows without a
maintainer reply will keep their proposed name with an unconfirmed
marker. First-registered-wins still applies if a later replacement is
needed.

Checklist

Hyperlinks in the For Filter column point at the per-filter section of
docs/RegisteredFilterPlugins.md on master. Maintainer attributions are
copied from the "Contact" subsection of each filter's entry.

ID Canonical Name For Filter Maintainer Short Description
257 hzip hzip Mark Miller (LLNL) hzip compression used in Silo
258 fpzip-legacy fpzip Peter Lindstrom (LLNL) Historical duplicate of 32014 — see Special cases below
305 lzo LZO Francesc Alted LZO lossless compression used by PyTables
307 bzip2 BZIP2 Francesc Alted BZIP2 lossless compression used by PyTables
32000 lzf LZF Andrew Collette (h5py) LZF lossless compression used by the h5py package
32001 blosc BLOSC Francesc Alted (PyTables) Blosc lossless compression used by PyTables
32002 mafisc MAFISC Nathanael Huebbe Modified LZMA compression filter, MAFISC (Multidimensional Adaptive Filtering Improved Scientific data Compression)
32003 snappy Snappy Lucas C. Villa Real Snappy lossless compression
32004 lz4 LZ4 Michael Rissi (Dectris Ltd.) LZ4 fast lossless compression algorithm
32005 apax APAX no current contact Samplify's APAX Numerical Encoding Technology
32006 cbf CBF Herbert J. Bernstein All imgCIF/CBF compressions and decompressions, including Canonical, Packed, Packed Version 2, Byte Offset and Nibble Offset
32007 jpeg-xr JPEG-XR Marvin Albert Enables images to be compressed/decompressed with JPEG-XR compression
32008 bitshuffle bitshuffle Kiyoshi Masui Extreme version of shuffle filter that shuffles data at bit level instead of byte level
32009 spdp SPDP Martin Burtscher SPDP fast lossless compression algorithm for single- and double-precision floating-point data
32010 lpc-rice LPC-Rice Frans van den Bergh LPC-Rice multi-threaded lossless compression
32011 ccsds-123 CCSDS-123 Frans van den Bergh ESA CCSDS-123 multi-threaded compression filter
32012 jpeg-ls JPEG-LS Frans van den Bergh CharLS JPEG-LS multi-threaded compression filter
32013 zfp zfp Peter Lindstrom (LLNL) Lossy & lossless compression of floating point and integer datasets to meet rate, accuracy, and/or precision targets.
32014 fpzip fpzip Peter Lindstrom (LLNL) Fast and Efficient Lossy or Lossless Compressor for Floating-Point Data
32015 zstd Zstandard Mark Kittisopikul Real-time compression algorithm with wide range of compression / speed trade-off and fast decoder
32016 b3d B³D no current contact GPU based image compression method developed for light-microscopy applications
32017 sz SZ Sheng Di (ANL) An error-bounded lossy compressor for scientific floating-point data
32018 fcidecomp FCIDECOMP Dr. Daniel Lee (EUMETSAT) EUMETSAT CharLS compression filter for use with netCDF
32019 jpeg JPEG Mark Rivers Jpeg compression filter
32020 vbz VBZ George Pimm (Oxford Nanopore) Compression filter for raw dna signal data used by Oxford Nanopore
32021 fapec FAPEC Jordi Portell i de Mora (DAPCOM Data Services S.L.) Versatile and efficient data compressor supporting many kinds of data and using an outlier-resilient entropy coder
32022 bitgroom BitGroom Charlie Zender (UC Irvine) The BitGroom quantization algorithm
32023 granular-bitround Granular BitRound (GBR) Charlie Zender (UC Irvine) The GBR quantization algorithm is a significant improvement to the BitGroom filter
32024 sz3 SZ3 Sheng Di (ANL) A modular error-bounded lossy compression framework for scientific datasets
32025 delta-rice Delta-Rice David Mathews Lossless compression algorithm optimized for digitized analog signals based on delta encoding and rice coding
32026 blosc2 BLOSC2 Francesc Alted (Blosc Development Team) The recent new-generation version of the Blosc compression library
32027 flac FLAC Laurie Stephey FLAC audio compression filter in HDF5
32028 sperr SPERR Samuel Li SPERR is a lossy scientific (floating-point) data compressor that produces one of the best rate-distortion curves
32029 terse-prolix TERSE/PROLIX Jan Pieter Abrahams A lossless and fast compression of the diffraction data
32030 ffmpeg FFMPEG Cai Lab (Univ. of Michigan) A lossy compression filter based on ffmpeg video library
32031 jpeg2000 JPEG2000 Mark Harfouche A compression filter for lossy and lossless coding

Special cases

  • 258 fpzip-legacy — ID 258 is a historical duplicate of 32014. The
    proposed canonical name distinguishes it from 32014 fpzip; we'd like
    to hear from anyone actually shipping plugins under ID 258 before
    finalizing.
  • 32005 apax and 32016 b3d — the registry entries have no current
    contact. If you maintain these or know who does, please reply so we can
    attribute the canonical name.

Companion PR

Companion PR: #256

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions