Block

To simplify the interface, the package has beem made callable.

output_x, output_y = ls(input_x, input_y, tol = 1e-3)

You can also use

output_x, output_y = ls.compress(input_x, input_y, tol = 1e-3)

if that is more comfortable for you.

Stream

example_x0, example_y0 = input_x[0], input_y[0]
generator = zip(input_x[1:], input_y[1:])

The context manager for stream data is called ‘Stream’.

with ls.Stream(example_x0, example_y0, tol = 1e-3) as record:
    for example_x_value, example_y_value in generator:
        record(example_x_value, example_y_value)

Using record.x or record.y in the with statement block results in attribute error, as those attributes are generated only when the record is closed.

If you want to access the data fed to the record, you can use

x_compressed, y_compressed = record.xc, record.yc

to access the already compressed data and

x_buffered, y_buffered = record.xb, record.yb

to access the buffered data that is waiting more values or closing of the record to be compressed.

A side mote: In English language the word ‘record’ can be either verb or noun and since it performs this double role of both taking in data and being storage of the data, it is a fitting name for the object

output_x, output_y = record.x, record.y
print(record.state)
print(record.__str__)

1.0.10 (2021-11-30)

• Cleaned documentation

1.0.9 (2022-04-03)

• Block and stream compression are much more uniform

• Restructuring

• Tests

• Profiling

1.0.8 (2022-03-20)

• Step-by-step style ploting of the compression.

1.0.3 (2021-11-30)

• First release on PyPI.