Read Me

The Cell BE time domain correlator - Copyright 2008 Martin Wåger.

This project currently contains five programs:

The main program (tdc) - Correlates data from two antennas up to a specified maxlag.
The radio data reader (radioreader) - Reads data from one antenna
datamaker - Mex program that create data from Matlab
datareader - Mex program that reads data from the radioreader into Matlab
resultreader - Mex program that reads the result from tdc into matlab.

Compile the tdc and radioreader by typing make in the top directory. Compile the three
mex files from within Matlab by typing mex [filename].

Usage:
tdc
	tdc [-ev] -o [ant one] -t [ant two] -r [result path] -m [maximum lag]

	Mandatory arguments:
	  -o [ant one]  Antenna one data file
	  -t [ant two]  Antenna two data file
	  -r [result]   Result save path
	  -l [lag]      The lag in samples
	Optional arguments
	  -e            Save the result in reverse endian order (for use on x86 architecture)
	  -v            Shows memory usage and working status

radioreader
	radioreader -i [IP] -p [port] -f [freq] -r [red] -g [gain] -n [numpack] -o [ofile]

	Mandatory arguments:
	  -i [IP]       source antenna IP address [xxx.xxx.xxx.xxx]
	  -p [port]     source antenna port number [1 - 65535]
	  -f [freq]     the sampling frequency in Hz [0.0 - 12499.0]
	  -r [red]      Defines the BandWidth in as BW = FS/4*2^RED (FS = Sampling frequency) [6.25 - 12.0]
	  -g [gain]     the antenna gain [0 - 4]
	  -n [numpack]  the number of packages to save (one package is 122 samples) [2 - 1000]
	  -o [ofile]    path and name of output file

datamaker
	Run with datamaker(xI,xQ,yI,yQ,zI,zQ,'filename',reverseEndian)
	Where [xI]-[zQ] are the data to be saved, [filename] the file to be created
	reverseEndian is optional and if != 0 will save data in reversed endian.

datareader
	Run with [x,y,z] = datareader('filename')
	Where [x]-[z] are the data variables and [filename] the file to be loaded

resultreader
	Run with [r1,r2,r3] = resultreader('filename')
	Where [r1]-[r3] are the result variables and [filename] the file to be loaded