Proto Quick Start Guide

Jan 2018: this page is deprecated in favor of the online documentation built through the code. It's hosted at: http://katydid.readthedocs.io

Very Basic Getting-Started Notes

These instructions assume that you've compiled and installed Katydid. The installation prefix will be referred to as ${PREFIX}.

• Several example configuration files are included with Katydid; they are installed in the ${PREFIX}/config directory.
• Start with the configuration file KatydidPSConfig.json. It will extract a single time slice from an egg file, perform a Fourier Transform, and save a plot of the power spectrum to a ROOT file.
• Make a copy of the configuration file in the directory from which you'll run Katydid.
• Customize the input egg file and the output ROOT file. You can use absolute or relative paths (relative paths are relative to the directory in which Katydid is run).
• Run Katydid with the following command:

> ${PREFIX}/bin/Katydid -c KatydidPSConfig.json

• Open the output ROOT file (e.g. > root MyPowerSpectrum.root). The histogram of the frequency spectrum will be called histFSpolar_0_0.

Notes about getting started with Katydid

How did it go for you? Suggestions? Problems? Additions?

• The out-of-the-box KatydidPSConfig.json file will read an egg3 file. If you want to read an RSA mat file, do the following:
  • At line 43 change "egg3" to "rsamat" to tell the egg processor to use the proper file reader.
  • Since RSA files contain complex time-domain data, you'll need to change the slot used in the FFT processor from "fft:ts-real" to "fft:ts-fftw" at line 21.
  • For the same reason, you'll need to change the slot used in the to-power processor from "to-ps:fs-polar-to-psd" to "to-ps:fs-fftw-to-psd" at line 25.

• . . .