sonicawe.1

.\" Process this file with
.\" groff -man -Tascii sonicawe.1
.\"
.TH sonicawe 1
.SH NAME
sonicawe \- Visualization based signal analysis
.SH SYNOPSIS
.B sonicawe
\--help
.br
.B sonicawe
\--version
.br

.B sonicawe
\--parameter
.br
.B sonicawe
[\--parameter=value]* [
.I AUDIO-FILE
]
.B 
.SH DESCRIPTION
.B Sonic AWE
is a cross-platform signal analysis tool based on visualization that runs on GNU/Linux, Windows and Mac OS X.  This man page describes the command line options.  For a description of all of the features of Sonic AWE or how to use
Sonic AWE visit www.sonicawe.com.  A lot of information about what Sonic AWE does is written to the Sonic AWE log file named sonicawe.log. It is located in the working directory from which Sonic AWE was started.

.SH OPTIONS
Each parameter takes a value, if no value is given the default value is written to standard output and the program exits immediately after.
.TP 10
\fB\--help\fR
display a list of command line options
.TP 10
\fB\--version\fR
display the Sonic AWE version number
.TP 10
\fBWays of extracting data from a Continious Gabor Wavelet Transform (CWT)\fR
.TP 10
\fB\--get_csv=number\fR
saves the given chunk number into sawe.csv which then can be read by matlab or octave
.TP 10
\fB\--get_hdf=number\fR
saves the given chunk number into sawe.h5 which then can be read by matlab or octave
.TP 10
\fB\--get_chunk_count=1\fR
outpus the number of chunks that can be fetched by the --get_* options
.TP 10
\fBSettings for computing CWT\fR
.TP 10
\fB\--samples_per_chunk_hint[=value]\fR
only used by the get_* options. The transform is computed in chunks from the input. This determines the number of input samples that should correspond to one chunk of the transform by 2^samples_per_chunk. The actual number of samples computed and written to file per chunk might be different
.TP 10
\fB\--scales_per_octave[=value]\fR
accuracy of transform, higher accuracy takes more time to compute
.TP 10
\fB\--wavelet_time_support[=decimal_value]\fR
transform CWT chunks with this many sigmas overlap in time domain
.TP 10
\fB\--wavelet_scale_support[=decimal_value]\fR
transform CWT chunks with this many sigmas overlap in scale domain
.TP 10
\fB\--min_hz[=decimal_value]\fR
Transform CWT with scales logarithmically distributed on (min_hz, fs/2]
.TP 10
\fBAudio devices (see log file from previous start for list of available devices)\fR
.TP 10
\fB\--record=1\fR
starts Sonic AWE starts in record mode. [default]
.TP 10
\fB\--record_device[=value]\fR
selects a specific device for recording. -1 specifices the default input device/microphone. All available audio devices that Sonic AWE can use are listen in the beginning of the log file sonicawe.log
.TP 10
\fB\--playback_device[=value]\fR
selects a specific device for playback. -1 specifices the default output device. All available audio devices that Sonic AWE can use are listen in the beginning of the log file sonicawe.log
.TP 10
\fBRendering settings\fR
.TP 10
\fB\--samples_per_block[=value]\fR
the transform chunks are downsampled to blocks for rendering, this gives the number of samples per block
.TP 10
\fB\--scales_per_block[=value]\fR
number of scales per block, se samples_per_block


.SH LICENSE

Sonic AWE is distributed as commercial software. Please contact info@sonicawe.com for questions.
However some of the libraries it uses are distributed under other free licenses, including the
LGPL and MIT licenses. For a complete list see /usr/share/sonicawe/license/.  There is NO WARRANTY, to the extent permitted by law. 

.SH REPORTING BUGS

To report a bug, contact us at http://sonicawe.com

.SH AUTHORS
Sonic AWE is a product from MuchDifferent. Sonic AWE would not be possible without the libraries it is built upon, including cuda, freeglut, boost, glew, hdf5, oourafft, portaudio, qt4, sndfile and zlib. For a complete list see /usr/share/sonicawe/license/license.txt


.\" arch-tag: e07678ca-81e0-4147-997c-18a80f6fb8d1