foutra_options_help.cc

Go to the documentation of this file.

// DO NOT EDIT: this file is automatically derived from foutra_options_help.txt
#include "foutra_options_help.h"
char foutra_options_help[]=
{
  "outfile         output filename\n"
  "infile          input filename\n"
  "                t:T select traces T, where T may be any range\n"
  "                    specification like '3-4' or '5,6,7-12,20'\n"
  "\n"
  "-help           prints this help text\n"
  "-xhelp          print information concerning supported data formats\n"
  "\n"
  "-v              be verbose\n"
  "-D              debug mode\n"
  "-o              overwrite output\n"
  "\n"
  "-type type      select input file type\n"
  "-Type type      select output file type\n"
  "\n"
  "-amplitude      compute Fourier amplitude spectrum\n"
  "-power          compute power spectral density (or power spectrum)\n"
  "-harmonic       scale output appropriate fro harmonic signals\n"
  "                useful for two-tone-tests of linearity (see below)\n"
  "\n"
  "-rms            report rms values of input data\n"
  "\n"
  "-boxcar         apply boxcar taper (i.e. no taper; default is Hanning)\n"
  "-demean[=n]     remove average from input time series\n"
  "                (determined from n samples)\n"
  "-detrend[=n]    remove trend from input time series\n"
  "                (determined from n samples)\n"
  "-divisor[=n]    FFT becomes very inefficient if the factorization\n"
  "                of the number of samples includes large prime numbers.\n"
  "                This option removes the least number of samples to\n"
  "                the total number of samples a multiple of \"n\"\n"
  "-pad n          pad time series with zeroes; n gives the integer factor\n"
  "                for the number of samples; the raw amplitude spectrum\n"
  "                has to be understood as the spectrum of the whole\n"
  "                series including the padded zeroes; PSD and harmonic\n"
  "                signals are scaled to represent the taper time window\n"
  "                only, such that padding is a means of smoothing only\n"
  "-nsegments n    subdivide input time series in \"n\" overlapping\n"
  "                sequences (overlap is 50%); spectral analysis is\n"
  "                done for each sequence individually; the result\n"
  "                is the mean of all sequences; this applies to PSD\n"
  "                and harmonic signal analysis only; it is particularly\n"
  "                useful for two-tone-test where spectral smoothing\n"
  "                of background noise is anticpated, while maintaining\n"
  "                the full resolution for harmonic peaks\n"
  "-avg[=n]        smooth power spectrum by averaging over n samples\n"
  "                values still specify power spectral density\n"
  "-rbw[=n]        smooth power spectrum by averaging over n decades\n"
  "                values still specify power spectral density\n"
  "-derivative[=n] effectively take n-th derivative of time series\n"
  "                computation is done in the Fourier domain and has no effect on\n"
  "                time series\n"
  "-scalerbw[=n]   scale to mean value in n decades\n"
  "                output value then are not power spectral density but average\n"
  "                signal power in the specified bandwidth\n"
  "-ASCII[=base]   write result to two-column ASCII files with basename 'base'\n"
  "-logascii[=n]   write ASCII data on logarithmic frequency axis with\n"
  "                one value per 'n' decades\n"
  "-avgascii       only average values for output to ASCII file\n"
  "                this option speeds up calculation together with\n"
  "                -scalerbw which increases computation time\n"
  "                with the square of frequency\n"
};