README.md

Delta2D - numcodecs implementation

Numcodecs implementation of the [Delta] filter applied to 2D input data.

This implementation enables one to apply delta filters on specific dimentions as a filter in Zarr.

Installation

Install via pip:

pip install delta2D-numcodecs

Or from sources:

git clone https://github.com/AllenNeuralDynamics/delta2D-numcodecs.git
cd flac-numcodecs
pip install .

Usage

This is a simple example on how to use the Delta2D codec with zarr:

from delta2D_numcodecs import Delta2D

data = ... # any 2D dumpy array
# here we assume that the data has a shape of (num_samples, num_channels)
num_channels = data.shape[1]

# instantiate Delta2D in time dimension
delta_time = Delta2D(dtype=data.dtype, num_channels=num_channels, axis=0)

# instantiate Delta2D in space dimension
delta_space = Delta2D(dtype=data.dtype, num_channels=num_channels, axis=1)

# using default Zarr compressor
z_time = zarr.array(data, filters=[delta_time])
z_space = zarr.array(data, filters=[delta_space])
# apply in both time and space, sequentally
z_time_space = zarr.array(data, filters=[delta_time, delta_space])

data_read = z[:]

Available **kwargs can be browsed with: Delta2D?

NOTE: In order to reload in zarr an array saved with the Delta2D, you just need to have the delta2D_numcodecs package installed.