fx_cor_all

DESCRIPTION

"fx_cor_all" is "fx cor" for two or more scan data using a list file that contains a number of a-priori file names.

SYNOPSIS

fx_cor_all pfile [options]

pfile list file name that contains a number of a-priori file names created by "apri_calc"
OPTIONS
--version show program version
--help show how to execute
-integ integration_time set integration period (sec). Default is a scheduled scan period.
-coffset clock_offset set clock offset (sec) applied for fringe search purpose. Positive value menas Y clock tic earlier than X clock tic. Default is 0.0
-crate clock_rate set clock rate (s/s) difference between X and Y station clock applied for fringe search purpose. Default is 0.0
-soffset start_offset set start time offset (integer sec). Default is 0.
-t1pp t1pp set unit integration period (parameter period) (sec) for correlation processing. Default is BT1PP in "cor_head.h" (usually 1)
-pp_nosync turns off the synchronization mode of PP (parameter period) (default is that PP synchronize to second tic)
-lag lagsize set the size of delay lag window. lagsize can be 16, 32, 64, 128, 256, 512, .. Default is DELAYSIZE in cor_head.h
-pmode pmode set plot device mode.
0 : XWINDOW (env PGDISP can change PGPLOT display device) and PostScript file (pgplot.ps or gnuplot.ps) out (dfault)
1 : PostScript file (pgplot.ps or gnuplot.ps) out only
2 : XWINDOW only
-1 : no graphic output
-comment "any_comment"
set comment appeared in a correlation function plot when pmode=0,1,2
-nopcal suppress PCAL (phase calibration) signal detection
-ch1 ch1Y define Y channel for X CH# 1 (default 1).
-ch2 ch2Y define Y channel for X CH# 2 (default 2).
-ch3 ch3Y define Y channel for X CH# 3 (default 3).
-ch4 ch4Y define Y channel for X CH# 4 (default 4).
Note: in case of "cor new" and "fx_cor new", options upto "-ch16 ch16Y" are possible
-orule naming_rule set naming rule of output file name
0 : use program default (cout.txt)
1 : coutNNNNtxt (deflt) where NNNN is 4 digit serial number
2 : coutEXP_CODE/coutYYDDDNNNNXYG.txt
      where   EXP_CODE -- experiment code

                  YY   -- 2 digit year

                  DDD  -- 3 digit day of year

                  NNNN -- 4 digit scan number

                  XY   -- baseline id (2 char or 4 char)

                  G    -- Frequency group (a|b|c|d)
3 : coutYYDDDNNNNXYG.txt
      where   YY   -- 2 digit year

              DDD  -- 3 digit day of year

              NNNN -- 4 digit scan number

              XY   -- baseline id (2 char or 4 char)

              G    -- Frequency group (a|b|c|d)
(default is COUT_NAMING_RULE in cor_head.h)
-odir outdir set output file directory. System default is environmental variable K5COUT. If K5COUT is not defined, program default defined by COUTDFLT in "cor_head.h" is used (usually "../cout").
-rfoffset rf_offset set RF frequency difference between Y and X (RFy-RFx)(Hz)
-frstep frstep set fringe phase calculation step in samples
0: automatic calculation
1: every 1 sample
8: every 8 samples
N: every N samples. (Note: N can be any number, but 1000/N must be integer)
default is FRSTEP_FX_COR (in cor_head.h)
-frauto set frstep=0 (automatic calculation mode)
-modefr modefr set fringe stopping approximation mode
0: no approximation (exact calculation)
9: 9 level approximation (default)
2: 2 level approximation
3: 3 level approximation
-hanning use Hanning lag window
-hamming use Hamming lag window

===== t1pp allowed for less than 1 sec is as follows ====
(this is due to the algorythm)

t1pp
fsampl 0.010.020.040.05 0.1 0.2 0.5
40kHz X OK OK X OK OK OK
100kHz X X OK X X OK X
200kHz X OK OK X OK OK OK
500kHz X X OK X X OK X
1MHz X OK OK X OK OK OK
2MHz OK OK OK OK OK OK OK
4MHz OK OK OK OK OK OK OK
8MHz OK OK OK OK OK OK OK
16MHz OK OK OK OK OK OK OK
32MHz OK OK OK OK OK OK OK

[Monitoring Environmental Variables]

fx_cor_all env

check environmental variables used in "fx_cor_all"

K5APRIDIR -- default directory for apriori file
K5APELIST -- default directory for list file
K5COUT -- default directory for correlation data out
PGDISP -- PGPLOT display device name when plot

Updated on March 9, 2017