Metadata-Version: 2.1
Name: aertb
Version: 0.1.1
Summary: UNKNOWN
Home-page: https://github.com/rfma23
Author: Rafael Mosca
Author-email: rafael.mosca@mail.polimi.it
License: UNKNOWN
Description: # AER-toolbox
        This library intends to be a minimal tool for loading events from files with common event-camera file extensions into
        Python.
        
        ```py
        from aertb import FileLoader
        
        datLoader = FileLoader('dat')
        datLoader.load_events('../example_data/dat/cars/obj_004414_td.dat')
        ```
        
        The library also includes a command line interface for converting files from a given extension to hdf5, as well as gif
        making capabilities for easy visualisation of the files.
        
        Opening the CLI
          1. In order to open it, navigate to path where the library is installed, in case of problems download you should download the project from github and follow the following instructions:
            - a  `git clone ...`
            - b  Create a virual environment, if not installed run `pip install virtualenv`,
                      then `python3 -m venv aertb_env`
            - c  On Linux/MacOS run `source aertb_env/bin/activate`
            - d  Run the following command: 'pip install -r requirements.txt'
        
          3. Run `python3 .` or execute the `__main__.py` file
        
        Using the CLI
          1. Once the CLI is open you get a a similar output on your terminal:
        
          2. type `help` to see supported commands and `help <topic>` to get more info of the command
        
        ## Examples:
        
        ### Creating an HDF5 out of a directory
        ```
        tohdf5 -f 'example_data/dat' -e 'dat' -o 'mytest.h5'
        ```
        Directory should be structured:
        
           |--Parent (given as parameter)
                |-- A
                    |-- File1
                    |-- File2
                    |-- ....
                |-- B
                    |-- File1
                    |-- File2
                    |-- ....
                |-- ...
        
        ### Creating an HDF5 out of a single file
        ```
        tohdf5 -f 'example_data/bin/one/03263.bin' -o 'mytest2.h5'
        ```
        
        
        ### Creating a gif out of a given file
        ```
        makegif -f 'example_data/dat/cars/obj_004416_td.dat' -o 'decay.gif' -nfr 12 -g 'decay'
        ```
        
        ## Exiting the CLI:
        
        1. type `quit`
        2. Exit virtual environment: `$ deactivate`
Keywords: aedat,aer,dat,event,camera
Platform: UNKNOWN
Classifier:     Development Status :: 4 - Beta
Classifier:     Intended Audience :: Science/Research
Classifier:     Natural Language :: English
Classifier:     Programming Language :: Python :: 3
Classifier:     Programming Language :: Python :: 3.7
Classifier:     Topic :: Utilities
Classifier:     Topic :: Scientific/Engineering
Classifier:     Topic :: Software Development :: Libraries :: Python Modules
Classifier:     License :: OSI Approved :: MIT License
Classifier:     Operating System :: OS Independent
Description-Content-Type: text/markdown
