rec
Given a pre-defined feature size, records incoming data via OSC to create datasets in real-time.
OUTPUT file can be .csv, .txt, or .json.
Input routes
-
/input <list>: Event to record. The number of event elements must match the pre-defined feature size. -
/stop: Writes recorded data to disk, and stops the recording session. -
/reset: Clears recorded events.
Usage
hxmx rec <SIZE> [OUTPUT] [-t] [--in-port <INTEGER>] [--address <TEXT>] [-m <INTEGER>] [-c <INTEGER>] [-d <CHOICE>] [--debug] [--help]
Arguments
| Name | Type | Required | Default |
|---|---|---|---|
SIZE | integer | ✓ | — |
OUTPUT | path — file | recording.csv |
Options
| Name | Type | Default | Description |
|---|---|---|---|
--temporal, -t | boolean | False | If true, output dataset has temporal information |
--in-port | integer | 8000 | Input OSC port. |
--address | string | 127.0.0.1 | OSC IP address |
--masked, -m | integer (multiple) | [] | Dimensions of masked features. |
--categorical, -c | integer (multiple) | [] | Dimensions of categorical features. |
--device, -d | choice (auto|cpu| ...) | cpu | Computing device. To list all available devices, run hxmx devices. |
--debug | boolean | False | Debug mode. Includes traceback when an error is raised. |
-h, --help | boolean | False | Open documentation in browser. |