Docs/User API

User API

Bindings share the same session, filter, and model calls. Signatures live in Reference; this page is the map of what each language exposes.

Python API Reference

Python is the fastest way to try Ability. Session, filters, and the small ML helper share one package.

ability.session

Session owns device lifetime: prepare, start, read, insert markers, stop. Device id and preset are set at construction.

import ability as ab

session = ab.Session(device_id=0)
session.prepare()
session.start()
data = session.read()
session.stop()

ability.exit_codes

ability.exit_codes uses the same Ability session flow: construct with a device id, prepare, start, read a block, then stop. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

ability.data_filter

Filters take a numeric table plus sampling rate. Bandpass, notch, denoise, and downsample live here.

filtered = ab.bandpass(data, sampling_rate=250, low=1.0, high=50.0)

ability.ml_model

ability.ml_model uses the same Ability session flow: construct with a device id, prepare, start, read a block, then stop. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

score = ab.predict(data, model="focus")

C++ API Reference

C++ API Reference uses the same Ability session flow: construct with a device id, prepare, start, read a block, then stop. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Session class

Session class uses the same Ability session flow: construct with a device id, prepare, start, read a block, then stop. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

ability::Session session(0);
session.prepare();
session.start();

DataFilter class

DataFilter class uses the same Ability session flow: construct with a device id, prepare, start, read a block, then stop. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

auto filtered = ability::bandpass(data, 250.0, 1.0, 50.0);

MLModel class

MLModel class uses the same Ability session flow: construct with a device id, prepare, start, read a block, then stop. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Ability constants

Ability constants uses the same Ability session flow: construct with a device id, prepare, start, read a block, then stop. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Java API Reference

Java API Reference uses the same Ability session flow: construct with a device id, prepare, start, read a block, then stop. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Session session = new Session(0);
session.prepare();
session.start();

C# API Reference

C# API Reference uses the same Ability session flow: construct with a device id, prepare, start, read a block, then stop. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

var session = new Session(0);
session.Prepare();
session.Start();

R API Reference

R API Reference uses the same Ability session flow: construct with a device id, prepare, start, read a block, then stop. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Matlab API Reference

Matlab API Reference uses the same Ability session flow: construct with a device id, prepare, start, read a block, then stop. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Julia API Reference

Julia API Reference uses the same Ability session flow: construct with a device id, prepare, start, read a block, then stop. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Rust API Reference

Rust API Reference uses the same Ability session flow: construct with a device id, prepare, start, read a block, then stop. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Typescript API Reference

Typescript API Reference uses the same Ability session flow: construct with a device id, prepare, start, read a block, then stop. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Swift

Swift uses the same Ability session flow: construct with a device id, prepare, start, read a block, then stop. Lorem ipsum dolor sit amet, consectetur adipiscing elit.