vpal.phasecal Namespace Reference

Functions
def	mult_corr (Rxx_full, bp_good=None, bad_nans=False)
def	write_numbers (fout, prefix, numbers, bp_good)
def	write_title (fout, title, station, experiment_number, experiment_code, bp_sym, threshold_median)
def	write_xcorrmx (fout, title, Rxx_full, bp_good, station, experiment_number, experiment_code, bp_sym)

Detailed Description

phasecal.py

Module providing some useful functions for the phase calibration software.

Function Documentation

mult_corr()

def vpal.phasecal.mult_corr	(		Rxx_full,
			bp_good = None,
			bad_nans = False
	)

Compute multiple correlation coefficients for selected
bandpols, whose indices are in the sequence bp_good.

  C.T is C transposed,
  Rxx is the matrix of cross-correlations between the band-pol series
         with the i-th bandpol excluded.

Input parameters:
  Rxx_full[nbandpol,nbandpol] correlation matrix of the cable delay
             time sequences in the rows of delps[nbandpol,:]
  bp_good: list of indices of good band-pols
  bad_nans:
      False: return in R_mult only the multiple correlations for the
             bandpols listed in bp_good. len(R_mult) == len(bp_good).
      True:  return in R_mult the multiple correlations at the locations
             listed in bp_good, and fill the rest with NaNs.
             len(R_mult) == np.size(Rxx_full,0).

Returns:
  R_mult, array of multiple correlation coefficients, one for each
          bandpol indicated in bp_good. The size of R_mult depends on
          the boolean value in bad_nans parameter.

write_numbers()

def vpal.phasecal.write_numbers	(		fout,
			prefix,
			numbers,
			bp_good
	)

Write a line of numbers at the positions at bp_good, and blanks at others.
The numbers can be multiple correlations or correlation medians and
they are supposed to be printed just at the locations of the
cross-correlation matrix columns.

write_title()

def vpal.phasecal.write_title	(		fout,
			title,
			station,
			experiment_number,
			experiment_code,
			bp_sym,
			threshold_median
	)

Write title in file fout.

write_xcorrmx()

def vpal.phasecal.write_xcorrmx	(		fout,
			title,
			Rxx_full,
			bp_good,
			station,
			experiment_number,
			experiment_code,
			bp_sym
	)

Save the cross-correlation matrix in file fout.