plume-python 0.1.9

Set of utilities to work with PLM record files.

PLUME: Record, Replay, Analyze and Share User Behavior in 6DoF XR Experiences
Charles Javerliat, Sophie Villenave, Pierre Raimbaud, Guillaume Lavoué
(Journal Track) IEEE Conference on Virtual Reality and 3D User Interfaces
Video » Paper » Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About PLUME Python
2. Getting Started
   • Prerequisites
   • Installation
   • Usage
3. Customization
4. Roadmap
5. Contributing
6. License
7. Contact
8. Citation

About PLUME Python

The interoperability of PLUME record files allows for other language to load those files for external analysis. PLUME Python is a module that can load record files using the Protobuf package to filter and convert the data into more commonly used formats in data analysis like pandas dataframe or CSV files. Embedded data such as LabStreamingLayer's samples can be exported to XDF files for external use in tools such as SigViewer, EEGLAB or MoBILAB.

Getting Started

Prerequisites

• Python 3.10 or later
• protobuf
• pandas

Installation

Download the latest release or clone the repository.

Usage

Use the CLI to load and convert your records

python cli.py input_file output_dir --csv --xdf --descriptors [DESCRIPTORS ...]

• input_file: Input PLUME record file (.plm) to be converted.
• output_dir: Output directory where all generated files will be saved. Directory will be created if it does not exist.
• --csv: Convert to CSV with optional filters.
• --xdf: Convert markers and physiological signals to XDF .
• -descriptors: Descriptor name used for filtering which samples to output as CSV files. Short name will automatically be preprended (eg. TransformUpdate -> plume.sample.unity.TransformUpdate).

Customization

If you have customized your PLUME Record as instructed here, import your generated protos for Python in the samples folder: PLUME-Python/plume/samples.

Roadmap

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. Don't forget to give the project a star! Thanks again!

License

Distributed under the GPLv3 License.

Contact

Charles JAVERLIAT - [e-mail]

Sophie VILLENAVE - [e-mail]

Citation

@article{javerliat_plume_2024,
	title = {{PLUME}: {Record}, {Replay}, {Analyze} and {Share} {User} {Behavior} in {6DoF} {XR} {Experiences}},
	url = {https://ieeexplore.ieee.org/document/10458415},
	doi = {10.1109/TVCG.2024.3372107},
	journal = {IEEE Transactions on Visualization and Computer Graphics},
	author = {Javerliat, Charles and Villenave, Sophie and Raimbaud, Pierre and Lavoué, Guillaume},
	year = {2024},
	note = {Conference Name: IEEE Transactions on Visualization and Computer Graphics},
	pages = {1--11}
}