|
libpressio 0.93.0
|
version: 0.0.1
stability: experimental
thread_safety: multiple
preforms a binning operation on the input data on compression and extrapolates on decompression
type: char*
default: <char*> = "noop"
options: binning, bit_grooming, blosc, bzip2, chunking, cusz, delta_encoding, digit_rounding, fault_injector, fpzip, frsz, lambda_fn, linear_quantizer, log_transform, magick, manifest, many_dependent, many_independent, many_independent_threaded, mask_binning, mask_interpolation, ndzip, noop, nvcomp, opt, pressio, pw_rel, qoz, random_error_injector, repeat, resize, roibin, sample, sperr, switch, sz, sz3, sz_omp, sz_threadsafe, transpose, tthresh, zfp
description: noop
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: uint32
default: <uint32> = 1
description: number of cpu threads to use for binning
type: data
default: <data> = data{ type=int32_t dims={4, } has_data=[2, 2, 1, 1, ]}
description: shape of the bins to apply
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: uint32
default: <uint32> = 1
description: number of threads to use
type: char*
value: <char*> = "0.0.1"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 1
description: the patch version number
version: 2.1.9.0
stability: stable
thread_safety: multiple
Various bitgroomimg methods for floating point data which improve compressibility
type: int32
default: <int32> = 0
options: dsd, nsd
description: the error_control_mode code, prefer error_control_mode_str instead for user facing use
type: char*
unset by default
description: the type of error control to use
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: int32
default: <int32> = 0
options: bitgroom, bitset, bitshave
description: the big grooming mode code, prefer mode_str instead for user facing use
type: char*
unset by default
description: the type of bit grooming to use
type: int32
default: <int32> = 5
description: number of significant decimals
type: int32
default: <int32> = 5
description: number of significant digits
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
value: <char*> = "2.1.9.0"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 2
description: the major version number
type: int32
value: <int32> = 1
description: the minor version number
type: int32
value: <int32> = 9
description: the patch version number
version: 1.21.2
stability: stable
thread_safety: multiple
BLOSC is a collection of lossless compressors optimized to transfer data more quickly than a direct memory fetch can preform. More information on BLOSC can be found on its project homepage
type: uint32
default: <uint32> = 0
description: what blocksize should blosc use?
type: int32
default: <int32> = 0
description: compression level
type: char*
default: <char*> = "blosclz"
options: blosclz, lz4, lz4hc, snappy, zlib, zstd
description: what lossless compressors should blosc use
type: int32
default: <int32> = 0
description: should blosc shuffle bits to try to improve compressability
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: int32
default: <int32> = 1
description: number of threads to use internally
type: int32
default: <int32> = 0
description: use lossless compression, the smaller the number the more biased towards speed, the larger the number the more biased towards compression
at this time (may change in the future), individual lossless compressors may internet values less than 1 or greater than 9 differently
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: uint32
default: <uint32> = 1
description: number of threads to use
type: char*
value: <char*> = "1.21.2"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 1
description: the major version number
type: int32
value: <int32> = 21
description: the minor version number
type: int32
value: <int32> = 2
description: the patch version number
version: 1.0.8, 13-Jul-2019
stability: experimental
thread_safety: multiple
the bzip2 lossless compressor https://sourceware.org/bzip2/
type: int32
default: <int32> = 9
description: between 1 and 9, what size block to consider at a time
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: int32
default: <int32> = 0
description: use a alternative decompression algorithm that uses less memory
type: int32
default: <int32> = 0
description: use verbose logging to stdout if >0
type: int32
default: <int32> = 30
description: between 0 and 250. How aggressively to try and compress data
type: int32
default: <int32> = 9
description: use lossless compression, the smaller the number the more biased towards speed, the larger the number the more biased towards compression
at this time (may change in the future), individual lossless compressors may internet values less than 1 or greater than 9 differently
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
value: <char*> = "1.0.8, 13-Jul-2019"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 1
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 8
description: the patch version number
version: 0.1.0
stability: experimental
thread_safety: single
Chunks a larger dataset into smaller datasets for parallel compression
type: uint64
default: <uint64> = 1
description: number of threads to use to chunk the data
type: char*
default: <char*> = "noop"
options: binning, bit_grooming, blosc, bzip2, chunking, cusz, delta_encoding, digit_rounding, fault_injector, fpzip, frsz, lambda_fn, linear_quantizer, log_transform, magick, manifest, many_dependent, many_independent, many_independent_threaded, mask_binning, mask_interpolation, ndzip, noop, nvcomp, opt, pressio, pw_rel, qoz, random_error_injector, repeat, resize, roibin, sample, sperr, switch, sz, sz3, sz_omp, sz_threadsafe, transpose, tthresh, zfp
description: compressor to use after chunking
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: data
default: <data> = data{ type=uint64_t dims={0, } has_data=false}
description: size of the chunks to use
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: uint32
default: <uint32> = 1
description: number of threads to use
type: char*
value: <char*> = "0.1.0"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 1
description: the minor version number
type: int32
value: <int32> = 0
description: the patch version number
version: 0.0.1
stability: experimental
thread_safety: multiple
A GPU based implementation of SZ for Nvidia GPUs
type: double
default: <double> = 1e-05
description: bound of the error bound
type: float
default: <float> = 0
description: assumed density of the code, affects speed
type: char*
default: <char*> = "huffman"
options: huffman, runlength, nvcompcascade, nvcomplz4, nvcompsnappy
description: what compression codec is used
type: bool
default: <bool> = false
description: use variable length encoding to improve rate for speed
type: float
default: <float> = 1.03
description: length factor controls how much memory is over-allocated
type: int32
default: <int32> = 0
description: huffman encoding book length
type: int32
default: <int32> = 0
description: huffman encoding coarse par degree
type: char*
default: <char*> = "tree"
options: tree, canonical
description: what type of book is used
type: char*
default: <char*> = "coarse"
options: coarse, fine
description: what type of coding to use
type: char*
default: <char*> = "device"
options: host, device, none
description: where to execute huffman encoding
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
default: <char*> = "abs"
options: abs, r2r
description: error bound mode
type: char*
default: <char*> = "auto"
options: auto, dense, sparse
description: pipeline type
type: bool
default: <bool> = false
description: is prediction anchored?
type: bool
default: <bool> = false
description: is the predictor non-destructuive; effects memory use
type: char*
default: <char*> = "lorenzoi"
options: lorenzo0, lorenzo1, lorenzoi, lorenzo2, lorenzoii, spline3
description: what predictor type to use
type: bool
default: <bool> = false
description: is quantization_delayed effects speed
type: int32
default: <int32> = 512
description: the quantization_radius effects quality
type: double
default: <double> = 1e-05
description: a pointwise absolute error bound
compressors may provide this value without supporting abs=0. compressors that support abs=0, additionally should also define pressio:lossless
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: double
unset by default
description: a pointwise value-range relative error bound
compressors may provide this value without supporting rel=0. compressors that support rel=0, additionally should also define pressio:lossless
type: char*
value: <char*> = "0.0.1"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 3
description: the minor version number
type: int32
value: <int32> = 0
description: the patch version number
version: 0.0.0
stability: experimental
thread_safety: single
delta_encoding
applies delta encoding to prior to compression and reverses it post decompression.
y[0] = x[0]; y[i] = x[i] - x[i-1];
type: char*
default: <char*> = "noop"
options: binning, bit_grooming, blosc, bzip2, chunking, cusz, delta_encoding, digit_rounding, fault_injector, fpzip, frsz, lambda_fn, linear_quantizer, log_transform, magick, manifest, many_dependent, many_independent, many_independent_threaded, mask_binning, mask_interpolation, ndzip, noop, nvcomp, opt, pressio, pw_rel, qoz, random_error_injector, repeat, resize, roibin, sample, sperr, switch, sz, sz3, sz_omp, sz_threadsafe, transpose, tthresh, zfp
description: compressor to apply after encoding
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
value: <char*> = "0.0.0"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 0
description: the patch version number
version: 2.1.9.0
stability: stable
thread_safety: multiple
Various methods for digit rounding which improve compression
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: int32
default: <int32> = 1970235507
description: The prec parameter of digit rounding (a number between 0 and 64)
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
value: <char*> = "2.1.9.0"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 2
description: the major version number
type: int32
value: <int32> = 1
description: the minor version number
type: int32
value: <int32> = 9
description: the patch version number
version: 0.0.0
stability:
thread_safety: multiple
injects single bit errors of specified distribution
type: char*
default: <char*> = "noop"
description: name of the compressor to inject errors after compression
type: uint32
default: <uint32> = 1
description: the method of performing injections
type: char*
unset by default
options: set, unset, flip
description: human interpretable mode
type: uint32
default: <uint32> = 1
description: the number of injections to make
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: uint32
unset by default
description: random number seed
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
value: <char*> = "0.0.0"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 0
description: the patch version number
version: 1.3.0
stability: stable
thread_safety: multiple
The FPZip lossless floating point compressor. See also Lindstrom, Peter G, and USDOE National Nuclear Security Administration. FPZIP. Computer software. Version 1.2.0. June 10, 2017. https://www.osti.gov//servlets/purl/1579935. doi:https://doi.org/10.11578/dc.20191219.2.
type: int32
default: <int32> = 0
description: output a header on compression
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: int32
default: <int32> = 0
description: the precision to use
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: uint32
value: <uint32> = 69633
description: the FPZip Codec version
type: uint32
value: <uint32> = 30579
description: the FPZip data model
type: uint32
value: <uint32> = 304
description: the FPZip library_version
type: char*
value: <char*> = "1.3.0"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 1
description: the major version number
type: int32
value: <int32> = 3
description: the minor version number
type: int32
value: <int32> = 0
description: the patch version number
version: 0.0.2
stability: experimental
thread_safety: single
a fixed rate version of the SZ Algorithm
type: double
default: <double> = 0.0001
description: "absolute error bound" applied during quantization; because frsz does not store unpredictable values, this is not a true absolute error bound
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
value: <char*> = "0.0.2"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 2
description: the patch version number
version: 0.0.1
stability: experimental
thread_safety: multiple
a meta compressor that reconfigures the child compressor dynamically at runtime
type: char*
default: <char*> = "noop"
options: binning, bit_grooming, blosc, bzip2, chunking, cusz, delta_encoding, digit_rounding, fault_injector, fpzip, frsz, lambda_fn, linear_quantizer, log_transform, magick, manifest, many_dependent, many_independent, many_independent_threaded, mask_binning, mask_interpolation, ndzip, noop, nvcomp, opt, pressio, pw_rel, qoz, random_error_injector, repeat, resize, roibin, sample, sperr, switch, sz, sz3, sz_omp, sz_threadsafe, transpose, tthresh, zfp
description: compressor to configure dynamically
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: int32
default: <int32> = 1
description: nonzero if the script should be called just before the child compressor is invoked, takes effect as soon as it is set
type: int32
default: <int32> = 0
description: nonzero if the script should be called at the end of set_options, takes effect as soon as it is set
type: char*
default: <char*> = ""
description: The actual script to use just before the child compressor in invoked written in lua.
When the script begins several global variables are defined
The lua base and math libraries are exposed by default, this may change in the future to allow the user to specify which libraries are allowed
A number of libpressio enums with all of their values are exposed to lua
pressio_dtype pressio_option_type pressio_options_key_status
Additionally a number of libpressio types are exposed to lua with a subset of their api
new() – constructs an empty pressio_data objectnew(dtype, dims, data) – constructs a pressio_data object with lua tables dims and datadimensions() – return a vector of the dimensionsdtype() – return the dtype type of the data objectto_vector() – convert the data object to a 1d vector that can be manipulatednew() – construct an empty optiontype() – get the current typeget_int8() – get the value as an int8get_int16() – get the value as an int16get_int32() – get the value as an int32get_int64() – get the value as an int64get_uint8() – get the value as an uint8get_uint16() – get the value as an uint16get_uint32() – get the value as an uint32get_uint64() – get the value as an uint64get_float() – get the value as an floatget_double() – get the value as an doubleget_string() – get the value as a stringget_string_arr() – get the value as a string arrayget_data() – get the value as a pressio_data objectset_int8() – set the value as an int8set_int16() – set the value as an int16set_int32() – set the value as an int32set_int64() – set the value as an int64set_uint8() – set the value as an uint8set_uint16() – set the value as an uint16set_uint32() – set the value as an uint32set_uint64() – set the value as an uint64set_float() – set the value as an floatset_double() – set the value as an doubleset_string() – set the value as a stringset_string_arr() – set the value as a string arrayset_data() – set the value as a pressio_data objectkey_status() – get the status of a keyget() – get the pressio_option for a valueset() – set the pressio_option for a valueexample 1:
example 2:
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
value: <char*> = "0.0.1"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 1
description: the patch version number
version: 0.0.0
stability: experimental
thread_safety: single
linear_quantizer
applies linear_quantizer encoding to prior to compression and reverses it post decompression.
y[i] = (x[i])/step
type: int64
default: <int64> = 0
description: the number of steps to assume while automatically determine the step size. 0 means use manual step size
type: char*
default: <char*> = "noop"
options: binning, bit_grooming, blosc, bzip2, chunking, cusz, delta_encoding, digit_rounding, fault_injector, fpzip, frsz, lambda_fn, linear_quantizer, log_transform, magick, manifest, many_dependent, many_independent, many_independent_threaded, mask_binning, mask_interpolation, ndzip, noop, nvcomp, opt, pressio, pw_rel, qoz, random_error_injector, repeat, resize, roibin, sample, sperr, switch, sz, sz3, sz_omp, sz_threadsafe, transpose, tthresh, zfp
description: compressor to apply after encoding
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: double
default: <double> = 0
description: the size of step to use while quantizing
type: double
default: <double> = 0
description: a pointwise absolute error bound
compressors may provide this value without supporting abs=0. compressors that support abs=0, additionally should also define pressio:lossless
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
value: <char*> = "0.0.0"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 0
description: the patch version number
version: 0.0.0
stability: experimental
thread_safety: single
log_transform
applies a log transform to prior to compression and experimental transform post decompression.
y[0] = log(x[0]);
type: char*
default: <char*> = "noop"
options: binning, bit_grooming, blosc, bzip2, chunking, cusz, delta_encoding, digit_rounding, fault_injector, fpzip, frsz, lambda_fn, linear_quantizer, log_transform, magick, manifest, many_dependent, many_independent, many_independent_threaded, mask_binning, mask_interpolation, ndzip, noop, nvcomp, opt, pressio, pw_rel, qoz, random_error_injector, repeat, resize, roibin, sample, sperr, switch, sz, sz3, sz_omp, sz_threadsafe, transpose, tthresh, zfp
description: compressor to apply after encoding
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
value: <char*> = "0.0.0"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 0
description: the patch version number
version: ImageMagick 6.9.12-70 Q16 x86_64 17597 https://legacy.imagemagick.org
stability: unstable
thread_safety: multiple
ImageMagick is a robust library that preforms a wide array of image compression and manipulation. Only a fraction of its api is exposed. More information on ImageMagick can be found on its project homepage
type: char*
default: <char*> = "JPEG"
description: the ImageMagick magick format
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: uint32
default: <uint32> = 100
description: the quality parameter for lossy images
type: char*
default: <char*> = "G"
description: the string for the samples format
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
value: <char*> = "ImageMagick 6.9.12-70 Q16 x86_64 17597 https://legacy.imagemagick.org"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 1692
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 0
description: the patch version number
version: 0.0.1
stability: experimental
thread_safety: single
compressor plugin that records meta data from compression to enable reconstruction
type: char*
default: <char*> = "noop"
options: binning, bit_grooming, blosc, bzip2, chunking, cusz, delta_encoding, digit_rounding, fault_injector, fpzip, frsz, lambda_fn, linear_quantizer, log_transform, magick, manifest, many_dependent, many_independent, many_independent_threaded, mask_binning, mask_interpolation, ndzip, noop, nvcomp, opt, pressio, pw_rel, qoz, random_error_injector, repeat, resize, roibin, sample, sperr, switch, sz, sz3, sz_omp, sz_threadsafe, transpose, tthresh, zfp
description: compressor to use to decompress
type: char*
default: <char*> = ""
description: header for the last compression operation
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: bool
default: <bool> = false
description: update manifest:lineage when decompress is called
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
value: <char*> = "0.0.1"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 1
description: the patch version number
version: 0.0.1
stability: experimental
thread_safety: multiple
Uses MPI to compress multiple buffers in parallel using results of previously successful compressions to guide future compressions
type: void*
default: <void*> = true
description: which MPI communicator to use
type: uint32
default: <uint32> = 0
description: How many groups of workers are there?
type: uint32
default: <uint32> = 0
description: which rank should be considered the root?
type: char*
default: <char*> = "noop"
options: binning, bit_grooming, blosc, bzip2, chunking, cusz, delta_encoding, digit_rounding, fault_injector, fpzip, frsz, lambda_fn, linear_quantizer, log_transform, magick, manifest, many_dependent, many_independent, many_independent_threaded, mask_binning, mask_interpolation, ndzip, noop, nvcomp, opt, pressio, pw_rel, qoz, random_error_injector, repeat, resize, roibin, sample, sperr, switch, sz, sz3, sz_omp, sz_threadsafe, transpose, tthresh, zfp
description: the name of the compressor to pipeline over using MPI
type: char*[]
default: <char*[]> = {}
description: list of metrics to pull the next set of configurations from
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*[]
default: <char*[]> = {}
description: list of options to set on each launch
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: data
default: <data> = data{ type=int32_t dims={0, } has_data=false}
description: which inputs get mapped to which sub compression operations
type: data
default: <data> = data{ type=int32_t dims={0, } has_data=false}
description: which outputs get mapped to which sub compression operations
type: char*
value: <char*> = "0.0.1"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 1
description: the patch version number
version: 0.0.1
stability: experimental
thread_safety: multiple
Uses MPI to compress multiple buffers in parallel
type: void*
default: <void*> = true
description: which MPI communicator to use
type: uint32
default: <uint32> = 0
description: How many groups of workers are there?
type: uint32
default: <uint32> = 0
description: which rank should be considered the root?
type: int32
default: <int32> = 1
description: true if all ranks have the same outputs otherwise just the root has the outputs
type: char*
default: <char*> = "noop"
options: binning, bit_grooming, blosc, bzip2, chunking, cusz, delta_encoding, digit_rounding, fault_injector, fpzip, frsz, lambda_fn, linear_quantizer, log_transform, magick, manifest, many_dependent, many_independent, many_independent_threaded, mask_binning, mask_interpolation, ndzip, noop, nvcomp, opt, pressio, pw_rel, qoz, random_error_injector, repeat, resize, roibin, sample, sperr, switch, sz, sz3, sz_omp, sz_threadsafe, transpose, tthresh, zfp
description: compressor to parallelize using MPI
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: data
default: <data> = data{ type=int32_t dims={0, } has_data=false}
description: which inputs get mapped to which sub compression operations
type: data
default: <data> = data{ type=int32_t dims={0, } has_data=false}
description: which outputs get mapped to which sub compression operations
type: char*
value: <char*> = "0.0.1"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 1
description: the patch version number
version: 0.0.1
stability: experimental
thread_safety: multiple
Uses OpenMP to compress multiple buffers in parallel
On each invocation a key called "many_independent_threaded:idx" with a type of uint64_t is set with the index of the compressor
type: int32
default: <int32> = 0
description: collect metrics after compression
type: int32
default: <int32> = 0
description: collect metrics after decompression
type: char*
unset by default
description: the child compressor to use; if many_independent_threaded:compressors is set, this value is ignored
type: char*[]
default: <char*[]> = {noop, }
options: binning, bit_grooming, blosc, bzip2, chunking, cusz, delta_encoding, digit_rounding, fault_injector, fpzip, frsz, lambda_fn, linear_quantizer, log_transform, magick, manifest, many_dependent, many_independent, many_independent_threaded, mask_binning, mask_interpolation, ndzip, noop, nvcomp, opt, pressio, pw_rel, qoz, random_error_injector, repeat, resize, roibin, sample, sperr, switch, sz, sz3, sz_omp, sz_threadsafe, transpose, tthresh, zfp
description: the child compressor(s) to use
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: uint32
default: <uint32> = 1
description: number of threads to use for compression
type: int32
default: <int32> = 0
description: preserve metrics after compression, and restore them before decompression
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: uint32
default: <uint32> = 1
description: number of threads to use
type: data
default: <data> = data{ type=int32_t dims={0, } has_data=false}
description: which inputs get mapped to which sub compression operations
type: data
default: <data> = data{ type=int32_t dims={0, } has_data=false}
description: which outputs get mapped to which sub compression operations
type: char*
value: <char*> = "0.0.1"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 1
description: the patch version number
version: 0.0.1
stability: experimental
thread_safety: multiple
preforms a mask_binning operation on the input data on compression and extrapolates on decompression
type: char*
default: <char*> = "noop"
options: binning, bit_grooming, blosc, bzip2, chunking, cusz, delta_encoding, digit_rounding, fault_injector, fpzip, frsz, lambda_fn, linear_quantizer, log_transform, magick, manifest, many_dependent, many_independent, many_independent_threaded, mask_binning, mask_interpolation, ndzip, noop, nvcomp, opt, pressio, pw_rel, qoz, random_error_injector, repeat, resize, roibin, sample, sperr, switch, sz, sz3, sz_omp, sz_threadsafe, transpose, tthresh, zfp
description: noop
type: data
default: <data> = data{ type=bool dims={} has_data=false}
description: boolean mask to apply, true means ignore
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: uint32
default: <uint32> = 1
description: number of cpu threads to use for mask_binning
type: data
default: <data> = data{ type=int32_t dims={4, } has_data=[2, 2, 1, 1, ]}
description: shape of the bins to apply
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: uint32
default: <uint32> = 1
description: number of threads to use
type: char*
value: <char*> = "0.0.1"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 1
description: the patch version number
version: 0.0.1
stability: experimental
thread_safety: single
apply interpolation to replace masked values
type: char*
default: <char*> = "noop"
options: binning, bit_grooming, blosc, bzip2, chunking, cusz, delta_encoding, digit_rounding, fault_injector, fpzip, frsz, lambda_fn, linear_quantizer, log_transform, magick, manifest, many_dependent, many_independent, many_independent_threaded, mask_binning, mask_interpolation, ndzip, noop, nvcomp, opt, pressio, pw_rel, qoz, random_error_injector, repeat, resize, roibin, sample, sperr, switch, sz, sz3, sz_omp, sz_threadsafe, transpose, tthresh, zfp
description: compressor to use after masking
type: double
default: <double> = 0
description: for values that cannot be interpolated, what value to fill with
type: data
default: <data> = data{ type=byte dims={} has_data=false}
description: mask of values to replace true means replace
type: char*
default: <char*> = "fill"
options: fill, interp
description: type of interpolation to use for masked values
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: uint32
default: <uint32> = 1
description: number of execution threads
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: uint32
default: <uint32> = 1
description: number of threads to use
type: char*
value: <char*> = "0.0.1"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 1
description: the patch version number
version: 0.0.1
stability: experimental
thread_safety: multiple
A High-Throughput Parallel Lossless Compressor for Scientific Data
only supports 1 type of compression, different values of pressio:lossless are indistinguishable
type: char*
default: <char*> = "cpu"
options: cpu, cpu-mt, cuda
description: which executor to use
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: int32
default: <int32> = 0
description: use lossless compression, the smaller the number the more biased towards speed, the larger the number the more biased towards compression
at this time (may change in the future), individual lossless compressors may internet values less than 1 or greater than 9 differently
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: int32
value: <int32> = 1
description: compiled with Cuda support
type: int32
value: <int32> = 1
description: compiled with OpenMP support
type: int32
value: <int32> = 0
description: compiled with Sycl support
type: char*
value: <char*> = "0.0.1"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 1
description: the patch version number
version: noop 0.0.0.0
stability: stable
thread_safety: multiple
A no-op compressor useful for testing and defaults
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
value: <char*> = "noop 0.0.0.0"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 0
description: the patch version number
version: 2.4.1
stability: experimental
thread_safety: multiple
nvcomp
libpressio bindings for the NVIDIA nvcomp GPU compressors
type: int32
default: <int32> = 0
description: which algorithm to use
type: char*
unset by default
description: which algorithm to use as a string
type: int32
default: <int32> = 65536
description: chunk size: default 4096, valid values are 512 to 16384
type: int32
default: <int32> = 0
description: nvidia device to execute on
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: int32
default: <int32> = 1
description: number of delta encodings to preform
type: int32
default: <int32> = 2
description: number of run length encoding to preform
type: int32
default: <int32> = 0
description: for nvcomp algorithms that support it, which variant to use
type: int32
default: <int32> = 1
description: preform bit comp as the last step
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
value: <char*> = "2.4.1"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 2
description: the major version number
type: int32
value: <int32> = 4
description: the minor version number
type: int32
value: <int32> = 1
description: the patch version number
version: 0.13.5
stability:
thread_safety: single
Uses optimization to automatically configure compressors
type: char*
default: <char*> = "noop"
options: binning, bit_grooming, blosc, bzip2, chunking, cusz, delta_encoding, digit_rounding, fault_injector, fpzip, frsz, lambda_fn, linear_quantizer, log_transform, magick, manifest, many_dependent, many_independent, many_independent_threaded, mask_binning, mask_interpolation, ndzip, noop, nvcomp, opt, pressio, pw_rel, qoz, random_error_injector, repeat, resize, roibin, sample, sperr, switch, sz, sz3, sz_omp, sz_threadsafe, transpose, tthresh, zfp
description: the compressor to optimize over
type: int32
default: <int32> = 1
description: preform decompression while tuning
type: char*[]
default: <char*[]> = {}
description: list of input settings
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
unset by default
description: the name for the optimization method
type: char*[]
default: <char*[]> = {}
description: list of output settings
type: char*
default: <char*> = "guess"
options: binary, dist_gridsearch, fraz, guess, guess_first, guess_midpoint, nrt, random_search, sdr
description: search method to use
type: char*
default: <char*> = "progress_printer"
options: composite_search, noop, progress_printer, record_search
description: search metrics to collect
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
value: <char*> = "0.13.5"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 13
description: the minor version number
type: int32
value: <int32> = 5
description: the patch version number
version: 0.0.1
stability: experimental
thread_safety: single
a set of helpers to convert between common error bounds
type: char*
unset by default
description: passthrough the bound that is provided
type: char*
default: <char*> = "noop"
options: binning, bit_grooming, blosc, bzip2, chunking, cusz, delta_encoding, digit_rounding, fault_injector, fpzip, frsz, lambda_fn, linear_quantizer, log_transform, magick, manifest, many_dependent, many_independent, many_independent_threaded, mask_binning, mask_interpolation, ndzip, noop, nvcomp, opt, pressio, pw_rel, qoz, random_error_injector, repeat, resize, roibin, sample, sperr, switch, sz, sz3, sz_omp, sz_threadsafe, transpose, tthresh, zfp
description: the underlying compressor to use
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: bool
unset by default
description: reset mode back to none
type: char*
value: <char*> = "0.0.1"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 1
description: the patch version number
version: 0.0.1
stability: experimental
thread_safety: single
abstraction for adapting an absolute error bound to a pw_rel error bound
Adapted for LibPressio by Robert Underwood Algorithm by X. Liang, S. Di, D. Tao, Z. Chen, and F. Cappello, “An Efficient Transformation Scheme for Lossy Data Compression with Point-Wise Relative Error Bound,” in 2018 IEEE International Conference on Cluster Computing (CLUSTER), Sep. 2018, pp. 179–189. doi: 10.1109/CLUSTER.2018.00036.
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: double
default: <double> = 0.001
description: point wise relative error bound mode
type: char*
default: <char*> = "noop"
options: binning, bit_grooming, blosc, bzip2, chunking, cusz, delta_encoding, digit_rounding, fault_injector, fpzip, frsz, lambda_fn, linear_quantizer, log_transform, magick, manifest, many_dependent, many_independent, many_independent_threaded, mask_binning, mask_interpolation, ndzip, noop, nvcomp, opt, pressio, pw_rel, qoz, random_error_injector, repeat, resize, roibin, sample, sperr, switch, sz, sz3, sz_omp, sz_threadsafe, transpose, tthresh, zfp
description: compressor that supports an absolute error bound
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
default: <char*> = "noop"
options: binning, bit_grooming, blosc, bzip2, chunking, cusz, delta_encoding, digit_rounding, fault_injector, fpzip, frsz, lambda_fn, linear_quantizer, log_transform, magick, manifest, many_dependent, many_independent, many_independent_threaded, mask_binning, mask_interpolation, ndzip, noop, nvcomp, opt, pressio, pw_rel, qoz, random_error_injector, repeat, resize, roibin, sample, sperr, switch, sz, sz3, sz_omp, sz_threadsafe, transpose, tthresh, zfp
description: compressor that compresses signs
type: char*
value: <char*> = "0.0.1"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 1
description: the patch version number
version: 0.1.0.0
stability: experimental
thread_safety: multiple
QoZ is the evolution of SZ3 a modular compression framework
type: double
default: <double> = 1e-06
description: a pointwise absolute error bound
compressors may provide this value without supporting abs=0. compressors that support abs=0, additionally should also define pressio:lossless
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: double
unset by default
description: a pointwise value-range relative error bound
compressors may provide this value without supporting rel=0. compressors that support rel=0, additionally should also define pressio:lossless
type: double
default: <double> = 1e-06
description: absolute error bound
type: uint8
default: <uint8> = 1
description: compression algorithm
type: char*
unset by default
options: ALGO_INTERP, ALGO_INTERP_BLOCKED, ALGO_INTERP_LORENZO, ALGO_LORENZO_REG
description: compression algorithm
type: uint8
default: <uint8> = 1
description: which encoder to use, 0 skip encoder, 1 huffman, 2 arithmatic
type: uint8
default: <uint8> = 0
description: error bound mode to apply
type: char*
unset by default
options: ABS, ABS_AND_REL, ABS_OR_REL, NORM, PSNR, REL
description: error bound
type: uint8
default: <uint8> = 1
description: which intrepolation algorithm to use
type: int32
default: <int32> = 32
description: what block size to use for interpolation to use
type: uint8
default: <uint8> = 0
description: which interpolation direction to use
type: char*
unset by default
options: INTERP_ALGO_CUBIC, INTERP_ALGO_LINEAR
description: interpolation algorithm mode
type: double
default: <double> = 1.47197e-319
description: l2 norm error bound
type: bool
default: <bool> = true
description: use the lorenzo predictor
type: bool
default: <bool> = false
description: use the 2-level lorenzo predictor
type: uint8
default: <uint8> = 1
description: lossless compression method to apply; 1 bypass lossless, 1 zstd
type: uint64
default: <uint64> = 0
description: set the maximum step size
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: bool
default: <bool> = false
description: use openmp parallelization
type: int32
default: <int32> = 0
description: prediction dimension
type: double
default: <double> = 8.87707e+252
description: psnr error bound
type: int32
default: <int32> = 65536
description: number of quantization bins
type: bool
default: <bool> = true
description: use the regression predictor
type: bool
default: <bool> = false
description: use the 2nd order regression predictor
type: double
default: <double> = -1
description: value range relative error bound
type: int32
default: <int32> = 6
description: stride between items
type: int32
default: <int32> = 0
description: test lorenzo predictor and use it when it is better
type: uint8
default: <uint8> = 0
description: the tuning target for quality
type: char*
unset by default
description: the tuning target as a string
type: bool
default: <bool> = true
description: enable extra quality preserving features
type: char*
value: <char*> = "0.1.0.0"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 1
description: the minor version number
type: int32
value: <int32> = 0
description: the patch version number
version: 0.0.0
stability:
thread_safety: multiple
injects errors according to the specified distribution
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
default: <char*> = "noop"
description: compressor to use after applying errors
type: data
default: <data> = data{ type=byte dims={} has_data=false}
description: the distribution arguments
type: char*
default: <char*> = "uniform_real_distribution"
description: name of the error distribution to use
type: char*
default: <char*> = "mt19937_64"
description: name of the random number generator to use
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: uint32
unset by default
description: random seed to use
type: char*
value: <char*> = "0.0.0"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 0
description: the patch version number
type: char*[]
value: <char*[]> = {knuth_b, minstd_rand, mt19937_64, ranlux48_base, }
description: available distribution generators
type: char*[]
value: <char*[]> = {binomial_distribution, geometric_distribution, negative_binomial_distribution, poisson_distribution, uniform_int_distribution, }
description: available distributions for integer numbers
type: char*[]
value: <char*[]> = {cauchy_distribution, chi_squared_distribution, extreme_value_distribution, fisher_f_distribution, gamma_distribution, lognormal_distribution, normal_distribution, student_t_distribution, uniform_real_distribution, weibull_distribution, }
description: available distributions for real numbers
version: 0.0.1
stability: experimental
thread_safety: single
call a compressor multiple times i.e. to get an average timing
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: bool
default: <bool> = false
description: clone output or re-use existing output
type: char*
default: <char*> = "noop"
options: binning, bit_grooming, blosc, bzip2, chunking, cusz, delta_encoding, digit_rounding, fault_injector, fpzip, frsz, lambda_fn, linear_quantizer, log_transform, magick, manifest, many_dependent, many_independent, many_independent_threaded, mask_binning, mask_interpolation, ndzip, noop, nvcomp, opt, pressio, pw_rel, qoz, random_error_injector, repeat, resize, roibin, sample, sperr, switch, sz, sz3, sz_omp, sz_threadsafe, transpose, tthresh, zfp
description: compressor to call repeatedly
type: uint32
default: <uint32> = 1
description: how many repeats to do
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
value: <char*> = "0.0.1"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 1
description: the patch version number
version: 0.0.1
stability: stable
thread_safety: multiple
A meta-compressor which applies a re-size operation prior to compression
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: data
default: <data> = data{ type=uint64_t dims={0, } has_data=false}
description: how to reshape the dimensions pre compression
type: char*
default: <char*> = "noop"
options: binning, bit_grooming, blosc, bzip2, chunking, cusz, delta_encoding, digit_rounding, fault_injector, fpzip, frsz, lambda_fn, linear_quantizer, log_transform, magick, manifest, many_dependent, many_independent, many_independent_threaded, mask_binning, mask_interpolation, ndzip, noop, nvcomp, opt, pressio, pw_rel, qoz, random_error_injector, repeat, resize, roibin, sample, sperr, switch, sz, sz3, sz_omp, sz_threadsafe, transpose, tthresh, zfp
description: compressor to use after resizing
type: data
default: <data> = data{ type=uint64_t dims={0, } has_data=false}
description: how to reshape the dimensions post decompression
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
value: <char*> = "0.0.1"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 1
description: the patch version number
version: 0.0.1
stability: experimental
thread_safety: multiple
ROIBIN metacompressor
This module treats compression as two tasks: region of interest saving + background saving Each is then forwarded on to a separate compressor for additional compression.
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: uint32
default: <uint32> = 1
description: number of threads to use
type: char*
default: <char*> = "noop"
options: binning, bit_grooming, blosc, bzip2, chunking, cusz, delta_encoding, digit_rounding, fault_injector, fpzip, frsz, lambda_fn, linear_quantizer, log_transform, magick, manifest, many_dependent, many_independent, many_independent_threaded, mask_binning, mask_interpolation, ndzip, noop, nvcomp, opt, pressio, pw_rel, qoz, random_error_injector, repeat, resize, roibin, sample, sperr, switch, sz, sz3, sz_omp, sz_threadsafe, transpose, tthresh, zfp
description: background compression
type: data
default: <data> = data{ type=byte dims={} has_data=false}
description: centers of the region of interest
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: uint32
default: <uint32> = 1
description: number of threads for region of interest
type: char*
default: <char*> = "noop"
options: binning, bit_grooming, blosc, bzip2, chunking, cusz, delta_encoding, digit_rounding, fault_injector, fpzip, frsz, lambda_fn, linear_quantizer, log_transform, magick, manifest, many_dependent, many_independent, many_independent_threaded, mask_binning, mask_interpolation, ndzip, noop, nvcomp, opt, pressio, pw_rel, qoz, random_error_injector, repeat, resize, roibin, sample, sperr, switch, sz, sz3, sz_omp, sz_threadsafe, transpose, tthresh, zfp
description: region of interest compression
type: data
default: <data> = data{ type=int32_t dims={4, } has_data=[5, 5, 0, 0, ]}
description: region of interest size
type: char*
value: <char*> = "0.0.1"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 1
description: the patch version number
version: 0.0.1
stability: unstable
thread_safety: multiple
A "compressor" which samples the data by row
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
default: <char*> = ""
options: wr, wor, decimate
description: what kind of sampling to apply
type: double
default: <double> = 0
description: the sampling rate to use
type: int32
default: <int32> = 0
description: the seed to use
type: char*
value: <char*> = "0.0.1"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 1
description: the patch version number
version: 640305d
stability: experimental
thread_safety: multiple
the sperr lossless compressor https://github.com/shaomeng/SPERR
type: double
default: <double> = 1e-06
description: a pointwise absolute error bound
compressors may provide this value without supporting abs=0. compressors that support abs=0, additionally should also define pressio:lossless
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: data
default: <data> = data{ type=uint64_t dims={3, } has_data=[256, 256, 256, ]}
description: how to chunk the data during compression – for best performance use a large multiple of the input size
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: int32
default: <int32> = 3
description: mode name
type: char*
unset by default
options: bpp, psnr, pwe
description: mode name
type: uint64
default: <uint64> = 1
description: number of threads to use
type: double
default: <double> = 1e-06
description: value for the error bound mode
type: char*
value: <char*> = "640305d"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 2
description: the minor version number
type: int32
value: <int32> = 0
description: the patch version number
version: 0.0.0
stability: experimental
thread_safety: single
switch_compressor
Allows switching between different compressors at runtime
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: uint64
default: <uint64> = 0
description: the compressor to actually use
type: int32
unset by default
description: write-only clear the invocation count metric
type: char*[]
default: <char*[]> = {}
description: compressor ids to configure
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*[]
default: <char*[]> = {}
description: allows naming sub-compressors
type: char*
value: <char*> = "0.0.0"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 0
description: the patch version number
version: 2.1.12.4
stability: stable
thread_safety: serialized
SZ is an error bounded lossy compressor that uses prediction based methods to compress data. This version of SZ is not threadsafe. Please refer to sz_threadsafe if a threadsafe version of SZ is desired. More information can be found about SZ on its project homepage.
type: double
unset by default
description: a pointwise absolute error bound
compressors may provide this value without supporting abs=0. compressors that support abs=0, additionally should also define pressio:lossless
type: int32
unset by default
description: use lossless compression, the smaller the number the more biased towards speed, the larger the number the more biased towards compression
at this time (may change in the future), individual lossless compressors may internet values less than 1 or greater than 9 differently
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: double
unset by default
description: a pointwise relative error bound
compressors may provide this value without supporting pw_rel=0. compressors that support pw_rel=0, additionally should also define pressio:lossless
type: double
unset by default
description: a pointwise value-range relative error bound
compressors may provide this value without supporting rel=0. compressors that support rel=0, additionally should also define pressio:lossless
type: double
default: <double> = 0.0001
description: the absolute error bound
type: int32
default: <int32> = 1
description: trade compression ratio for a faster pw_rel compression
type: char*
default: <char*> = "SZ"
description: access a application specific mode of SZ
type: char*
unset by default
description: filepath passed to SZ_Init()
type: void*
unset by default
description: structure passed to SZ_Init_Params()
type: double
unset by default
description: an internal option to control compression
type: int32
default: <int32> = 4
description: integer code used to determine error bound mode
type: char*
unset by default
options: abs, abs_and_pw_rel, abs_and_rel, abs_or_pw_rel, abs_or_rel, norm, psnr, pw_rel, rel, rel_and_pw_rel, rel_or_pw_rel, vr_rel
description: human readable string to set the error bound mode
type: uint32
default: <uint32> = 0
description: for ROIBIN-SZ, the size of the binning applied
type: data
default: <data> = data{ type=byte dims={} has_data=false}
description: for ROIBIN-SZ the size of the calibration panel
type: uint32
default: <uint32> = 0
description: for ROIBIN-SZ the number of peaks
type: uint32
default: <uint32> = 0
description: for ROIBIN-SZ the size of the peaks
type: data
default: <data> = data{ type=byte dims={} has_data=false}
description: for ROIBIN-SZ the list of columns peaks appear in
type: data
default: <data> = data{ type=byte dims={} has_data=false}
description: for ROIBIN-SZ the list of rows peaks appear in
type: data
default: <data> = data{ type=byte dims={} has_data=false}
description: for ROIBIN-SZ the segments peaks appear in
type: uint32
default: <uint32> = 0
description: for ROIBIN-SZ the SZ dimensionality prefered 1: nEvents * panels * pr->binnedRows * pr->binnedCols 2: nEvents * panels * pr->binnedRows, pr->binnedCols 3: nEvents * panels, pr->binnedRows, pr->binnedCols 4: nEvents , pr->binnedRows * panels, pr->binnedCols
type: double
default: <double> = 0
description: for ROIBIN-SZ the tolerance used after binning
type: int32
default: <int32> = 3
description: Which mode to pass to GZIP when used
type: int32
default: <int32> = 1
description: Which lossless compressor to use for stage 4
type: uint32
default: <uint32> = 65536
description: the maximum number of quantization intervals
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: float
default: <float> = 0.99
description: an internal option used to control compression
type: int32
unset by default
description: an internal option used to control compression
type: int32
default: <int32> = 0
description: should the value range be preserved during compression
type: double
default: <double> = 90
description: the bound on the error in the PSNR
type: double
default: <double> = 0.001
description: the bound on the pointwise relative error
type: uint32
default: <uint32> = 0
description: the number of quantization intervals to use, 0 means automatic
type: double
default: <double> = 0.0001
description: the value range relative error bound mode
type: int32
default: <int32> = 100
description: internal option used to control compression
type: int32
default: <int32> = 36
description: internal option used to control compression. number of points in each segement for pw_relBoundRatio
type: int32
default: <int32> = 5
description: the frequency of preforming single snapshot based compression in time based compression
type: int32
default: <int32> = 101
description: an internal option use d to control compression
type: int32
default: <int32> = 1
description: SZ Mode either SZ_BEST_COMPRESSION or SZ_BEST_SPEED
type: void*
default: <void*> = false
description: arguments passed to the application specific mode of SZ. Use in conjunction with sz:app
type: char*
value: <char*> = "2.1.12.4"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 2
description: the major version number
type: int32
value: <int32> = 1
description: the minor version number
type: int32
value: <int32> = 12
description: the patch version number
type: uint32
value: <uint32> = 1
description: true if PASTRI mode was built
type: uint32
value: <uint32> = 0
description: true if SZ was compiled in random access mode
type: uint32
value: <uint32> = 0
description: true if SZ if SZ is compiled in time based compression mode
type: uint32
value: <uint32> = 1
description: true if SZ is compiled with compression statistics support
version: 3.1.7
stability: experimental
thread_safety: multiple
SZ3 is a modular compressor framework
type: double
default: <double> = 1e-06
description: a pointwise absolute error bound
compressors may provide this value without supporting abs=0. compressors that support abs=0, additionally should also define pressio:lossless
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: uint32
default: <uint32> = 1
description: number of threads to use
type: double
unset by default
description: a pointwise value-range relative error bound
compressors may provide this value without supporting rel=0. compressors that support rel=0, additionally should also define pressio:lossless
type: double
default: <double> = 1e-06
description: absolute error bound
type: uint8
default: <uint8> = 1
description: compression algorithm
type: char*
unset by default
options: ALGO_INTERP, ALGO_INTERP_LORENZO, ALGO_LORENZO_REG
description: compression algorithm
type: uint8
default: <uint8> = 1
description: which encoder to use, 0 skip encoder, 1 huffman, 2 arithmatic
type: uint8
default: <uint8> = 0
description: error bound mode to apply
type: char*
unset by default
options: ABS, ABS_AND_REL, ABS_OR_REL, NORM, PSNR, REL
description: error bound
type: uint8
default: <uint8> = 1
description: which intrepolation algorithm to use
type: int32
default: <int32> = 32
description: what block size to use for interpolation to use
type: uint8
default: <uint8> = 0
description: which interpolation direction to use
type: char*
unset by default
options: INTERP_ALGO_CUBIC, INTERP_ALGO_LINEAR
description: interpolation algorithm mode
type: double
default: <double> = 8.11481e+88
description: l2 norm error bound
type: bool
default: <bool> = true
description: use the lorenzo predictor
type: bool
default: <bool> = false
description: use the 2-level lorenzo predictor
type: uint8
default: <uint8> = 1
description: lossless compression method to apply; 1 bypass lossless, 1 zstd
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: bool
default: <bool> = false
description: use openmp parallelization
type: int32
default: <int32> = 0
description: prediction dimension
type: double
default: <double> = 9.05138e-90
description: psnr error bound
type: int32
default: <int32> = 65536
description: number of quantization bins
type: bool
default: <bool> = true
description: use the regression predictor
type: bool
default: <bool> = false
description: use the 2nd order regression predictor
type: double
default: <double> = 6.20636e+223
description: value range relative error bound
type: int32
default: <int32> = 6
description: stride between items
type: char*
value: <char*> = "3.1.7"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 3
description: the major version number
type: int32
value: <int32> = 1
description: the minor version number
type: int32
value: <int32> = 7
description: the patch version number
version: 0.0.0
stability: experimental
thread_safety: serialized
SZ is an error bounded lossy compressor that uses prediction based methods to compress data. This is SZ's native multi-threaded compression support
type: double
unset by default
description: a pointwise absolute error bound
compressors may provide this value without supporting abs=0. compressors that support abs=0, additionally should also define pressio:lossless
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: uint32
default: <uint32> = 1
description: number of threads to use
type: double
default: <double> = 0.0001
description: the absolute error bound
type: char*
unset by default
description: filepath passed to SZ_Init()
type: void*
unset by default
description: structure passed to SZ_Init_Params()
type: double
unset by default
description: an internal option to control compression
type: int32
default: <int32> = 4
description: integer code used to determine error bound mode
type: char*
unset by default
options: abs
description: human readable string to set the error bound mode
type: int32
default: <int32> = 3
description: Which mode to pass to GZIP when used
type: int32
default: <int32> = 1
description: Which lossless compressor to use for stage 4
type: uint32
default: <uint32> = 65536
description: the maximum number of quantization intervals
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: uint32
default: <uint32> = 1
description: number of threads to use for parallel compression and decompression
type: float
default: <float> = 0.99
description: an internal option used to control compression
type: int32
unset by default
description: an internal option used to control compression
type: int32
default: <int32> = 0
description: should the value range be preserved during compression
type: uint32
default: <uint32> = 0
description: the number of quantization intervals to use, 0 means automatic
type: int32
default: <int32> = 100
description: internal option used to control compression
type: int32
default: <int32> = 36
description: internal option used to control compression. number of points in each segement for pw_relBoundRatio
type: int32
default: <int32> = 5
description: the frequency of preforming single snapshot based compression in time based compression
type: int32
default: <int32> = 101
description: an internal option use d to control compression
type: int32
default: <int32> = 1
description: SZ Mode either SZ_BEST_COMPRESSION or SZ_BEST_SPEED
type: char*
value: <char*> = "0.0.0"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 0
description: the patch version number
type: uint32
value: <uint32> = 1
description: true if PASTRI mode was built
type: uint32
value: <uint32> = 0
description: true if SZ was compiled in random access mode
type: uint32
value: <uint32> = 0
description: true if SZ if SZ is compiled in time based compression mode
type: uint32
value: <uint32> = 1
description: true if SZ is compiled with compression statistics support
version: 2.1.12.4
stability: stable
thread_safety: multiple
SZ threadsafe is a threadsafe version of the error bounded lossy compressor SZ that uses prediction based methods to compress data. SZ threadsafe has fewer features than SZ, including but not limited to: no write stats support, and no PSNR/NORM mode. More information can be found about SZ on its project homepage.
type: double
unset by default
description: a pointwise absolute error bound
compressors may provide this value without supporting abs=0. compressors that support abs=0, additionally should also define pressio:lossless
type: int32
unset by default
description: use lossless compression, the smaller the number the more biased towards speed, the larger the number the more biased towards compression
at this time (may change in the future), individual lossless compressors may internet values less than 1 or greater than 9 differently
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: double
unset by default
description: a pointwise value-range relative error bound
compressors may provide this value without supporting rel=0. compressors that support rel=0, additionally should also define pressio:lossless
type: double
default: <double> = 0.0001
description: the absolute error bound
type: int32
default: <int32> = 1
description: trade compression ratio for a faster pw_rel compression
type: char*
default: <char*> = "SZ"
description: access a application specific mode of SZ
type: void*
unset by default
description: structure passed to SZ_Init_Params()
type: double
unset by default
description: an internal option to control compression
type: int32
default: <int32> = 4
description: integer code used to determine error bound mode
type: char*
unset by default
options: abs, abs_and_pw_rel, abs_and_rel, abs_or_pw_rel, abs_or_rel, pw_rel, rel, rel_and_pw_rel, rel_or_pw_rel, vr_rel
description: human readable string to set the error bound mode
type: uint32
default: <uint32> = 0
description: for ROIBIN-SZ, the size of the binning applied
type: data
default: <data> = data{ type=byte dims={} has_data=false}
description: for ROIBIN-SZ the size of the calibration panel
type: uint32
default: <uint32> = 0
description: for ROIBIN-SZ the number of peaks
type: uint32
default: <uint32> = 0
description: for ROIBIN-SZ the size of the peaks
type: data
default: <data> = data{ type=byte dims={} has_data=false}
description: for ROIBIN-SZ the list of columns peaks appear in
type: data
default: <data> = data{ type=byte dims={} has_data=false}
description: for ROIBIN-SZ the list of rows peaks appear in
type: data
default: <data> = data{ type=byte dims={} has_data=false}
description: for ROIBIN-SZ the segments peaks appear in
type: uint32
default: <uint32> = 0
description: for ROIBIN-SZ the SZ dimensionality prefered
type: double
default: <double> = 0
description: for ROIBIN-SZ the tolerance used after binning
type: int32
default: <int32> = 3
description: Which mode to pass to GZIP when used
type: int32
default: <int32> = 1
description: Which lossless compressor to use for stage 4
type: uint32
default: <uint32> = 65536
description: the maximum number of quantization intervals
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: float
default: <float> = 0.99
description: an internal option used to control compression
type: int32
unset by default
description: an internal option used to control compression
type: int32
default: <int32> = 0
description: should the value range be preserved during compression
type: double
default: <double> = 90
description: the bound on the error in the PSNR
type: double
default: <double> = 0.001
description: the bound on the pointwise relative error
type: uint32
default: <uint32> = 0
description: the number of quantization intervals to use, 0 means automatic
type: double
default: <double> = 0.0001
description: the value range relative error bound mode
type: int32
default: <int32> = 100
description: internal option used to control compression
type: int32
default: <int32> = 36
description: internal option used to control compression. number of points in each segement for pw_relBoundRatio
type: int32
default: <int32> = 5
description: the frequency of preforming single snapshot based compression in time based compression
type: int32
default: <int32> = 101
description: an internal option use d to control compression
type: int32
default: <int32> = 1
description: SZ Mode either SZ_BEST_COMPRESSION or SZ_BEST_SPEED
type: void*
default: <void*> = true
description: arguments passed to the application specific mode of SZ. Use in conjunction with sz:app
type: char*
value: <char*> = "2.1.12.4"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 2
description: the major version number
type: int32
value: <int32> = 1
description: the minor version number
type: int32
value: <int32> = 12
description: the patch version number
type: uint32
value: <uint32> = 1
description: true if PASTRI mode was built
type: uint32
value: <uint32> = 0
description: true if SZ was compiled in random access mode
type: uint32
value: <uint32> = 0
description: true if SZ if SZ is compiled in time based compression mode
version: 0.0.1
stability: unstable
thread_safety: multiple
Meta-compressor that applies a transpose before compression
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: data
default: <data> = data{ type=uint64_t dims={0, } has_data=false}
description: how to reorder the dimensions, contains indicies 0..(N_DIMS-1)
type: char*
default: <char*> = "noop"
options: binning, bit_grooming, blosc, bzip2, chunking, cusz, delta_encoding, digit_rounding, fault_injector, fpzip, frsz, lambda_fn, linear_quantizer, log_transform, magick, manifest, many_dependent, many_independent, many_independent_threaded, mask_binning, mask_interpolation, ndzip, noop, nvcomp, opt, pressio, pw_rel, qoz, random_error_injector, repeat, resize, roibin, sample, sperr, switch, sz, sz3, sz_omp, sz_threadsafe, transpose, tthresh, zfp
description: Compressor to use after transpose is applied
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
value: <char*> = "0.0.1"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 1
description: the patch version number
version: 3c876c06d60570cc915bb61b43d2094ff1847e42
stability: experimental
thread_safety: single
TTHRESH: Tensor Compression for Multidimensional Visual Data
It is intended for Cartesian grid data of 3 or more dimensions, and leverages the higher-order singular value decomposition (HOSVD), a generalization of the SVD to 3 and more dimensions. See also TTHRESH: Tensor Compression for Multidimensional Visual Data (R. Ballester-Ripoll, P. Lindstrom and R. Pajarola)
type: double
default: <double> = 0
description: a pointwise absolute error bound
compressors may provide this value without supporting abs=0. compressors that support abs=0, additionally should also define pressio:lossless
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: int32
default: <int32> = 0
description: numeric code for the target type
type: char*
unset by default
options: eps, psnr, rmse
description: string that represents the target type
type: double
default: <double> = 0
description: the value of the target
type: char*
value: <char*> = "3c876c06d60570cc915bb61b43d2094ff1847e42"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 0
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 2
description: the patch version number
version: 1.0.0
stability: stable
thread_safety: multiple
ZFP is an error bounded lossy compressor that uses a transform which is similar to a discrete cosine transform. More information on ZFP can be found on its project homepage
type: double
unset by default
description: a pointwise absolute error bound
compressors may provide this value without supporting abs=0. compressors that support abs=0, additionally should also define pressio:lossless
type: int32
unset by default
description: use lossless compression, the smaller the number the more biased towards speed, the larger the number the more biased towards compression
at this time (may change in the future), individual lossless compressors may internet values less than 1 or greater than 9 differently
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: uint32
default: <uint32> = 0
description: number of threads to use
type: double
unset by default
description: absolute error tolerance for fixed-accuracy mode
type: uint32
unset by default
description: the dimensionality of the input data, used in fixed-rate mode
type: int32
default: <int32> = 0
description: which execution mode to use
type: char*
unset by default
options: omp, cuda, serial
description: which execution mode to use as a human readable string
type: uint32
default: <uint32> = 16658
description: maximum number of bits to store per block
type: uint32
default: <uint32> = 64
description: maximum number of bit planes to store
type: char*
default: <char*> = "noop"
options: autocorr, clipping, composite, data_gap, diff_pdf, entropy, error_stat, external, historian, input_stats, kl_divergence, ks_test, kth_error, mask, memory, noop, pearson, print_options, printer, rcpp, region_of_interest, size, spatial_error, time, write_debug_inputs
description: metrics to collect when using the compressor
type: uint32
default: <uint32> = 1
description: minimum number of bits to store per block
type: int32
default: <int32> = -10
description: minimum floating point bit plane number to store
type: uint32
unset by default
description: a compact encoding of compressor parameters
type: uint32
default: <uint32> = 0
description: OpenMP chunk size used in OpenMP mode
type: uint32
default: <uint32> = 0
description: number of OpenMP threads to use in OpenMP mode
type: uint32
unset by default
description: The precision specifies how many uncompressed bits per value to store, and indirectly governs the relative error
type: double
unset by default
description: the rate used in fixed rate mode
type: uint32
unset by default
description: use reversible mode
type: uint32
unset by default
description: the type used in fixed rate mode
type: int32
unset by default
description: write random access used in fixed rate mode
type: char*
value: <char*> = "1.0.0"
description: the version string from the compressor
type: uint64
value: <uint64> = 0
description: the epoch version number; this is a libpressio specific value used if the major_version does not accurately reflect backward incompatibility
type: int32
value: <int32> = 1
description: the major version number
type: int32
value: <int32> = 0
description: the minor version number
type: int32
value: <int32> = 0
description: the patch version number
1.9.5