autocorr

stability: stable

thread_safety: multiple

computes the 1d autocorrelation

Metrics Results

autocorr:autocorr

type: data

unset by default

description: the 1d autocorrelation

Options

autocorr:autocorr_lags

type: uint64

default: <uint64> = 100

description: how many autocorrelation lags to compute

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe

clipping

stability: stable

thread_safety: multiple

measures the number of values that exceed an absolute threshold

Metrics Results

clipping:clips

type: uint64

default: <uint64> = 0

description: the number of clips that occur

Options

clipping:abs

type: double

default: <double> = 0.0001

description: threshold for error

pressio:abs

type: double

default: <double> = 0.0001

description: threshold for error

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe

composite

stability: stable

thread_safety: multiple

meta-metric that runs a set of metrics in sequence

Metrics Results

composite:compression_rate

type: double

unset by default

description: compression rate for the compress method, activated by size and time (kB/s)

composite:compression_rate_many

type: double

unset by default

description: compression rate for the compress_many method, activated by size and time (kB/s)

composite:decompression_rate

type: double

unset by default

description: decompression rate for the compress method, activated by size and time (kB/s)

composite:decompression_rate_many

type: double

unset by default

description: decompression rate for the compress_many method, activated by size and time (kB/s)

Options

composite:names

type: char*[]

default: <char*[]> = {}

description: the names to use for the constructed metrics plugins

composite:plugins

type: char*[]

default: <char*[]> = {}

description: plugins used for gathering metrics

composite:scripts

type: char*[]

default: <char*[]> = {}

description: a lua script used to compute metrics from other metrics that have been previously computed

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe

data_gap

stability: stable

thread_safety: multiple

computes statistics about the gaps between adjacent values

Metrics Results

data_gap:max_gap

type: double

unset by default

description: the maximum gap

data_gap:mean_gap

type: double

unset by default

description: the mean gap

data_gap:min_gap

type: double

unset by default

description: the minimum gap

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe

diff_pdf

stability: stable

thread_safety: multiple

computes a histogram of the error distribution

Metrics Results

diff_pdf:histogram

type: data

unset by default

description: the counts for the histogram bins

diff_pdf:interval

type: double

unset by default

description: the width of an interval in the histogram

diff_pdf:max_diff

type: double

unset by default

description: the largest difference observed

diff_pdf:min_diff

type: double

unset by default

description: the smallest difference observed

Options

diff_pdf:intervals

type: uint64

default: <uint64> = 2000

description: the number of intervals to use in the histogram

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe

entropy

stability: stable

thread_safety: multiple

computes the entropy of the input data and output data

Metrics Results

entropy:decompressed

type: double

unset by default

description: the entropy of the decompressed data (shannon)

entropy:input

type: double

unset by default

description: the entropy of the input data (shannon)

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe

error_stat

stability: stable

thread_safety: multiple

Basic error statistics that can be computed in in one pass

Metrics Results

error_stat:average_difference

type: double

unset by default

description: the average difference

error_stat:average_error

type: double

unset by default

description: the average absolute difference

error_stat:difference_range

type: double

unset by default

description: the range of the differences

error_stat:error_range

type: double

unset by default

description: the range of the absolute differences

error_stat:max_error

type: double

unset by default

description: the maximum absolute difference

error_stat:max_pw_rel_error

type: double

unset by default

description: the maximum absolute difference relative to each data point

error_stat:max_rel_error

type: double

unset by default

description: the maximum absolute difference relative to the input value range

error_stat:min_error

type: double

unset by default

description: the minimum absolute difference

error_stat:min_pw_rel_error

type: double

unset by default

description: the minimum absolute difference relative to each data point

error_stat:min_rel_error

type: double

unset by default

description: the minimum absolute difference relative to the input value range

error_stat:mse

type: double

unset by default

description: mean squared error

error_stat:n

type: uint64

unset by default

description: the number of input values

error_stat:psnr

type: double

unset by default

description: peak signal to noise ratio

error_stat:rmse

type: double

unset by default

description: root mean squared error

error_stat:value_max

type: double

unset by default

description: maximum of the input values

error_stat:value_mean

type: double

unset by default

description: the mean of the input values

error_stat:value_min

type: double

unset by default

description: minimum of the input values

error_stat:value_range

type: double

unset by default

description: the range of the input values

error_stat:value_std

type: double

unset by default

description: standard deviation of the input values

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe

external

stability: unstable

thread_safety: multiple

metrics module that launches an external task

Options

external:command

type: char*

unset by default

description: the command to use passed as a single string

external:config_name

type: char*

default: <char*> = "external"

description: string passed to the config_name option

external:fieldnames

type: char*[]

default: <char*[]> = {, }

description: names of the fields used when generating arguments

external:io_format

type: char*[]

default: <char*[]> = {posix, }

options: by_extension, csv, cufile, empty, hdf5, iota, mmap, noop, numpy, petsc, posix, select

description: io formats used to write out data buffers

external:launch_method

type: char*

default: <char*> = "forkexec"

options: forkexec, mpispawn, remote

description: launch methods to use with the external metric

external:prefix

type: char*[]

default: <char*[]> = {, }

description: prefix to use in generated temporary file names

external:suffix

type: char*[]

default: <char*[]> = {, }

description: suffix to use in generated temporary file names

external:use_many

type: int32

default: <int32> = 0

description: use the begin_many/end_many versions for launching the job when there is only one buffer

external:workdir

type: char*

default: <char*> = "."

description: directory to launch the external process in

external:write_inputs

type: int32

default: <int32> = 1

description: disables the writing of all inputs

external:write_outputs

type: int32

default: <int32> = 1

description: disables the writing of all ouputs

Configuration

other configuration entries:

• external:io_format
• external:launch_method
• pressio:stability
• pressio:thread_safe

historian

stability: unstable

thread_safety: single

records metrics results after designated events

Options

historian:events

type: char*[]

default: <char*[]> = {}

options: check_options, compress, compress_many, decompress, decompress_many, get_configuration, get_documentation, get_options, set_options, clone

description: what events should trigger a record event

historian:idx

type: uint64

default: <uint64> = 0

description: the current index for this repetition

historian:metrics

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: what metrics should be recorded by the metric

Configuration

other configuration entries:

• historian:events
• historian:metrics
• pressio:stability
• pressio:thread_safe

input_stats

stability: stable

thread_safety: multiple

records the sizes and types of inputs

Metrics Results

input_stat:compress_input_dims

type: data

default: <data> = data{ type=byte dims={} has_data=false}

description: sizes of compress inputs

input_stat:compress_input_types

type: data

default: <data> = data{ type=byte dims={} has_data=false}

description: types of compression inputs

input_stat:compress_output_dims

type: data

default: <data> = data{ type=byte dims={} has_data=false}

description: sizes of compress outputs

input_stat:compress_output_types

type: data

default: <data> = data{ type=byte dims={} has_data=false}

description: types of compression outputs

input_stat:decompress_input_dims

type: data

default: <data> = data{ type=byte dims={} has_data=false}

description: sizes of decompress inputs

input_stat:decompress_input_types

type: data

default: <data> = data{ type=byte dims={} has_data=false}

description: types of decompression inputs

input_stat:decompress_output_dims

type: data

default: <data> = data{ type=byte dims={} has_data=false}

description: sizes of decompress outputs

input_stat:decompress_output_types

type: data

default: <data> = data{ type=byte dims={} has_data=false}

description: types of decompression outputs

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe

kl_divergence

stability: stable

thread_safety: multiple

Kullback–Leibler divergence

Metrics Results

kl_divergence:p_q

type: double

unset by default

description: relative entropy of p given q

kl_divergence:q_p

type: double

unset by default

description: relative entropy of q given p

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe

ks_test

stability: stable

thread_safety: multiple

Kolmogorov–Smirnov test for difference in distributions

Metrics Results

ks_test:d

type: double

unset by default

description: the test statistic

ks_test:pvalue

type: double

unset by default

description: the p-value of the test statistic

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe

kth_error

stability: stable

thread_safety: multiple

computes the kth order statistic

Metrics Results

kth_error:kth_error

type: double

unset by default

description: the kth order error

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe

mask

stability: stable

thread_safety: multiple

applies to mask to keep only interesting values

Options

mask:mask

type: data

default: <data> = data{ type=byte dims={} has_data=false}

description: the mask to apply; the mask has 1 on values to include

mask:metrics

type: char*

default: <char*> = "noop"

description: the metrics to compute after applying the mask

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe

memory

stability: stable

thread_safety: multiple

uses getrusage to record memory usage

Metrics Results

memory:check_options

type: uint64

unset by default

description: memory used in bytes by check options

memory:compress

type: uint64

unset by default

description: memory used in bytes by compress

memory:compress_many

type: uint64

unset by default

description: memory used in bytes by compress_many

memory:decompress

type: uint64

unset by default

description: memory used in bytes by decompress

memory:decompress_many

type: uint64

unset by default

description: memory used in bytes by decompress_many

memory:get_options

type: uint64

unset by default

description: memory used in bytes by get options

memory:set_options

type: uint64

unset by default

description: memory used in bytes by set options

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe

noop

stability: stable

thread_safety: multiple

a metric that does nothing

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe

pearson

stability: stable

thread_safety: multiple

computes the Pearson's coefficient of correlation and determination

Metrics Results

pearson:r

type: double

unset by default

description: the Pearson's coefficient of correlation

pearson:r2

type: double

unset by default

description: the Pearson's coefficient of determination

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe

print_options

stability: stable

thread_safety: multiple

prints options passed to set_options in a human readable form

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe

printer

stability: stable

thread_safety: multiple

metric that records the operations preformed

Metrics Results

printer:log

type: char*[]

default: <char*[]> = {}

description: log of operations preformed on this metrics object

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe

rcpp

stability: external

thread_safety: single

Runs a R program to compute a metric

Options

rcpp:outputs

type: char*[]

default: <char*[]> = {}

description: names of variables to pull from the R environment

rcpp:script

type: char*

default: <char*> = ""

description: script to evaluate with R

rcpp:use_many

type: int32

default: <int32> = 0

description: run the metrics with the _many versions of compress and decompress

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe

region_of_interest

stability: unstable

thread_safety: multiple

computes the sum and average of a region of interest

Metrics Results

region_of_interest:decomp_average

type: double

unset by default

description: arithmetic mean of the region of interest for the decompressed buffer

region_of_interest:decomp_sum

type: double

unset by default

description: sum of the region of interest for the decompressed buffer

region_of_interest:input_average

type: double

unset by default

description: arithmetic mean of the region of interest for the input

region_of_interest:input_sum

type: double

unset by default

description: sum of the region of interest for the input

Options

region_of_interest:end

type: data

default: <data> = data{ type=uint64_t dims={} has_data=false}

description: index of the ending location for the region of interest

region_of_interest:start

type: data

default: <data> = data{ type=uint64_t dims={} has_data=false}

description: index of the starting location for the region of interest

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe

size

stability: stable

thread_safety: multiple

captures the size of compressed buffers

Metrics Results

size:bit_rate

type: double

unset by default

description:

size:compressed_size

type: uint64

unset by default

description: compressed size in bytes

size:compression_ratio

type: double

unset by default

description: uncompressed_size/compressed_size

size:decompressed_size

type: uint64

unset by default

description: decompressed_size in bytes

size:uncompressed_size

type: uint64

unset by default

description: uncompressed size in bytes

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe

spatial_error

stability: stable

thread_safety: multiple

Computes the Spatial Error Percentage – the percentage of elements that exceed some threshold

Metrics Results

spatial_error:percent

type: double

unset by default

description: percentage of elements that exceed the threshold

Options

spatial_error:threshold

type: double

default: <double> = 0.01

description: threshold for triggering spatial_error

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe

time

stability: stable

thread_safety: multiple

records time used in each operation in ms

Metrics Results

time:begin_check_options

type: uint32

unset by default

description: time for child's begin_check_options (ms)

time:begin_compress

type: uint32

unset by default

description: time for child's begin_compress (ms)

time:begin_compress_many

type: uint32

unset by default

description: time for child's begin_compress_many (ms)

time:begin_decompress

type: uint32

unset by default

description: time for child's begin_decompress (ms)

time:begin_decompress_many

type: uint32

unset by default

description: time for child's begin_decompress_many (ms)

time:begin_get_configuration

type: uint32

unset by default

description: time for child's begin_get_configuration (ms)

time:begin_get_options

type: uint32

unset by default

description: time for child's begin_get_options (ms)

time:begin_set_options

type: uint32

unset by default

description: time for child's begin_set_options (ms)

time:check_options

type: uint32

unset by default

description: time in check_options (ms)

time:compress

type: uint32

unset by default

description: time in compress (ms)

time:compress_many

type: uint32

unset by default

description: time in compress_many (ms)

time:decompress

type: uint32

unset by default

description: time in decompress (ms)

time:decompress_many

type: uint32

unset by default

description: time in decompress_many (ms)

time:end_check_options

type: uint32

unset by default

description: time for child's end_check_options (ms)

time:end_compress

type: uint32

unset by default

description: time for child's end_compress (ms)

time:end_compress_many

type: uint32

unset by default

description: time for child's end_compress_many (ms)

time:end_decompress

type: uint32

unset by default

description: time for child's end_decompress (ms)

time:end_decompress_many

type: uint32

unset by default

description: time for child's end_decompress_many (ms)

time:end_get_configuration

type: uint32

unset by default

description: time for child's end_get_configuration (ms)

time:end_get_options

type: uint32

unset by default

description: time for child's end_get_options (ms)

time:end_set_options

type: uint32

unset by default

description: time for child's end_set_options (ms)

time:get_configuration

type: uint32

unset by default

description: time in get configuration (ms)

time:get_options

type: uint32

unset by default

description: time in get options (ms)

time:set_options

type: uint32

unset by default

description: time in set options (ms)

Options

time:metric

type: char*

default: <char*> = "noop"

description: time a child metrics plugin (ms)

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe

write_debug_inputs

stability: stable

thread_safety: multiple

write inputs to compress and decompress to disk for examination

Options

write_debug_inputs:base_path

type: char*

default: <char*> = "/tmp/"

description: base path where outputs will be written

write_debug_inputs:display_paths

type: bool

default: <bool> = false

description: display paths where outputs will be written

write_debug_inputs:io

type: char*

default: <char*> = "noop"

description: format used for all data to be written

write_debug_inputs:write_all

type: bool

unset by default

description: shortcut for write_input, write_output, and write_compressed

write_debug_inputs:write_compressed

type: bool

default: <bool> = false

description: write_compressed data

write_debug_inputs:write_input

type: bool

default: <bool> = false

description: write_input data

write_debug_inputs:write_output

type: bool

default: <bool> = false

description: write_output data

Configuration

other configuration entries:

• pressio:stability
• pressio:thread_safe