Skip to content

Latest commit

 

History

History
154 lines (114 loc) · 4.71 KB

README.md

File metadata and controls

154 lines (114 loc) · 4.71 KB
Raw

banner

Command-line tools bundles command-line applications to manipulate event files.

install

clone

To download Utilities, run the command:

git clone --recursive https://github.com/neuromorphic-paris/command_line_tools.git

dependencies

Debian / Ubuntu

Open a terminal and run:

sudo apt install premake4 # cross-platform build configuration

macOS

Open a terminal and run:

brew install premake # cross-platform build configuration

If the command is not found, you need to install Homebrew first with the command:

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Windows

Download and install:

  • Visual Studio Community. Select at least Desktop development with C++ when asked.
  • git
  • premake 4.x. In order to use it from the command line, the premake4.exe executable must be copied to a directory in your path. After downloading and decompressing premake-4.4-beta5-windows.zip, run from the command line:
copy "%userprofile%\Downloads\premake-4.4-beta5-windows\premake4.exe" "%userprofile%\AppData\Local\Microsoft\WindowsApps"

compilation

Run the following commands from the command_line_tools directory to compile the applications:

premake4 gmake
cd build
make
cd release

Windows users must run premake4 vs2010 instead, and open the generated solution with Visual Studio.

The command-line applications are located in the release directory.

documentation

cut

cut generates a new Event Stream file with only events from the given time range.

./cut [options] /path/to/input.es /path/to/output.es begin duration

Available options:

  • -h, --help shows the help message

dat_to_es

dat_to_es converts a TD file (and an optional APS file) to an Event Stream file:

./dat_to_es [options] /path/to/input_td.dat /path/to/input_aps.dat /path/to/output.es

If the string none is used for the td (respectively, aps) file, the Event Stream file is build from the aps (respectively, td) file only. Available options:

  • -h, --help shows the help message

es_to_csv

es_to_csv converts an Event Stream file to a CSV file (compatible with Excel and Matlab):

./es_to_csv [options] /path/to/input.es /path/to/output.csv

Available options:

  • -h, --help shows the help message

rainmaker

rainmaker generates a standalone HTML file containing a 3D representation of events from an Event Stream file:

./rainmaker [options] /path/to/input.es /path/to/output.html

Available options:

  • -t [timestamp], --timestamp [timestamp] sets the initial timestamp for the point cloud (defaults to 0)
  • -d [duration], --duration [duration] sets the duration (in microseconds) for the point cloud (defaults to 1000000)
  • -r [ratio], --ratio [ratio] sets the discard ratio for logarithmic tone mapping (default to 0.05, ignored if the file does not contain ATIS events)
  • -f [duration], --frametime [duration] sets the time between two frames (defaults to auto), auto calculates the time between two frames so that there is the same amount of raw data in events and frames, a duration in microseconds can be provided instead, none disables the frames, ignored if the file contains DVS events
  • -h, --help shows the help message

statistics

statistics retrieves the event stream's properties and outputs them in JSON format:

./statistics [options] /path/to/input.es

Available options:

  • -h, --help shows the help message

contribute

development dependencies

Debian / Ubuntu

Open a terminal and run:

sudo apt install clang-format # formatting tool

macOS

Open a terminal and run:

brew install clang-format # formatting tool

test

To test the library, run from the command_line_tools directory:

premake4 gmake
cd build
make
cd release

Windows users must run premake4 vs2010 instead, and open the generated solution with Visual Studio.

You can then run sequentially the executables located in the release directory.

After changing the code, format the source files by running from the command_line_tools directory:

for file in source/*.hpp; do clang-format -i $file; done;
for file in source/*.cpp; do clang-format -i $file; done;
for file in bindings/matlab/*.cpp; do clang-format -i $file; done;
for file in bindings/python/*.cpp; do clang-format -i $file; done;

Windows users must run Edit > Advanced > Format Document from the Visual Studio menu instead.

license

See the LICENSE file for license rights and limitations (GNU GPLv3).