https://github.com/neelays/event_aug

A Python package for augmenting event-camera datasets
https://github.com/neelays/event_aug

event-vision python

Last synced: about 1 month ago
JSON representation

A Python package for augmenting event-camera datasets

• Host: GitHub
• URL: https://github.com/neelays/event_aug
• Owner: NeelayS
• License: mit
• Created: 2022-05-24T15:20:42.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-09-27T12:02:31.000Z (about 2 years ago)
• Last Synced: 2023-05-10T12:33:44.011Z (over 1 year ago)
• Topics: event-vision, python
• Language: Jupyter Notebook
• Homepage: https://event-aug.readthedocs.io/
• Size: 11.7 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
EventAug

A Python package for augmenting event-camera datasets




[![Tests](https://github.com/NeelayS/event_aug/actions/workflows/package-test.yml/badge.svg)](https://github.com/NeelayS/event_aug/actions/workflows/package-test.yml)

[![Docs](https://readthedocs.org/projects/event-aug/badge/?version=latest)](https://event-aug.readthedocs.io/en/latest/?badge=latest)

**[Documentation](https://event_aug.readthedocs.io/en/latest/)** | **[Tutorials](https://github.com/NeelayS/event_aug/tree/main/tutorial_ntbks)**



# About

`EventAug` is an open-source Python package that provides methods for augmentation of visual event data. This package was developed as part of the [Google Summer of Code 2022](https://summerofcode.withgoogle.com/) program. A summary of information about the project can be found at [this webpage](https://neelays.github.io/gsoc-2022/).

# Installation

## From source (recommended)

### Using Poetry (recommended)

If you don't have `Poetry` installed, you can install it with the following command:

```bash

pip install poetry

```

Clone the public repository and enter the working directory:

```bash

git clone https://github.com/NeelayS/event_aug

cd event_aug/

```

To install the basic version of the package:

```bash

poetry install --without dev

```

If you wish to install the development version of the package:

```bash

poetry install

```

If you wish to use the Youtube video downloading functionality of the package, you can additionally run:

```bash

poetry install -E youtube

```

### Using Pip

To install the basic version of the package:

```bash

pip install git+https://github.com/NeelayS/event_aug.git

```

To use the YouTube video downloading functionality of the package:

```bash

pip install git+https://github.com/NeelayS/event_aug.git#[youtube]

```

# Usage

Please refer to the `tutorial_ntbks/` directory for usage examples. It contains two IPython notebooks which demonstrate how the package can be used to augment event-camera datasets end-to-end using spike-encoded (custom) videos and Perlin noise.