[ Basic Info | References | User Guide ]

Basic Information on xcorr


Task: xcorr
Purpose: Cross correlate columns in ascii files.
Categories: analysis

XCORR is a Miriad task to cross correlate columns in ascii files.
Print average and rms for each column and the correlation matrix.
Write the cross correlation functions to output file.

Key: in
Input filename of ascii data.
Lines begining with "#" are not used.
Default is a pill box 3 rows wide and shifted by 10 rows.

Key: out
Output filename for cross correlation functions.
Default none.

Key: nrow
Number of rows, same as number of points in FFT .
Must be power of 2 only if correlation functions are written.
Maximum 4096. Default 32.

Key: ncol
Number of columns to cross correlate.
Maximum 16. Default 2.

Key: refcol
Refererence column for cross correlation.
Default 1.

Key: device
Standard PGPLOT device, to plot correlation functions. 
Default is no plot.

Key: nxy
Number of plots in the x and y directions.
The default selects something reasonable.

Key: xrange
The min and max range along the x axis of the plots. The default
is to autoscale.

Key: yrange
The min and max range along the y axis of the plots. The default
is to autoscale.

Key: options
This gives extra processing options. Several options can be given,
each separated by commas. They may be abbreivated to the minimum
needed to avoid ambiguity. Possible options are:
   'linfit'   Fit and remove slope and offset from data.

User Guide References to xcorr

[ Basic Info | References | User Guide ]

Generated by smamiriad@cfa.harvard.edu on 09 Jul 2012