ObitUVUtil.h File Reference

ObitUVUtil module definition. More...

#include "ObitErr.h"
#include "ObitUV.h"
#include "ObitSourceList.h"

Go to the source code of this file.

Functions
void	ObitUVUtilUVWExtrema (ObitUV *inUV, gfloat *MaxBL, gfloat *MaxW, ObitErr *err)
	Public: Get UVW Extrema.
ObitUV *	ObitUVUtilCopyZero (ObitUV *inUV, gboolean scratch, ObitUV *outUV, ObitErr *err)
	Public: Make zeroed copy of an ObitUV.
void	ObitUVUtilVisDivide (ObitUV *inUV1, ObitUV *inUV2, ObitUV *outUV, ObitErr *err)
	Public: Divide the visibilities in one ObitUVData by another.
gfloat	ObitUVUtilVisCompare (ObitUV *inUV1, ObitUV *inUV2, ObitErr *err)
	Public: Compare the visibilities in one ObitUVData with another.
void	ObitUVUtilIndex (ObitUV *inUV, ObitErr *err)
	Public: Index a uv data.
ObitSourceList *	ObitUVUtilWhichSources (ObitUV *inUV, ObitErr *err)
	Public: Get list of selected sources.
ObitUV *	ObitUVUtilAvgF (ObitUV *inUV, gboolean scratch, ObitUV *outUV, ObitErr *err)
	Public: Average a data set in frequency.
ObitUV *	ObitUVUtilAvgT (ObitUV *inUV, gboolean scratch, ObitUV *outUV, ObitErr *err)
	Public: Average a data set in time.
ObitInfoList *	ObitUVUtilCount (ObitUV *inUV, gfloat timeInt, ObitErr *err)
	Public: Count good data by time segment.

---

Detailed Description

ObitUVUtil module definition.

This utility module contains functions which operate on ObitUV data sets.

---

Function Documentation

ObitUV* ObitUVUtilAvgF (  ObitUV *  inUV, gboolean  scratch, ObitUV *  outUV, ObitErr *  err )

Public: Average a data set in frequency. Parameters: inUV  Input uv data to average, Any request for calibration, editing and selection honored Control parameters on info element of inUV: "NumChAvg" OBIT_int scalar Number of channels to average, [def. = all] "doAvgAll" OBIT_bool Scalar, if TRUE then average all channels and IF. default = FALSE "ChanSel" OBIT_int (4,*) Groups of channels to consider (relative to channels & IFs selected by BChan, EChan, BIF, EIF) (start, end, increment, IF) where start and end at the beginning and ending channel numbers (1-rel) of the group to be included, increment is the increment between selected channels and IF is the IF number (1-rel) default increment is 1, IF=0 means all IF. The list of groups is terminated by a start <=0 Default is all channels in each IF. scratch  True if scratch file desired, will be same type as inUV. outUV  If not scratch, then the previously defined output file May be NULL for scratch only If it exists and scratch, it will be Unrefed err  Error stack, returns if not empty. Returns: the frequency averaged ObitUV.

ObitUV* ObitUVUtilAvgT (  ObitUV *  inUV, gboolean  scratch, ObitUV *  outUV, ObitErr *  err )

Public: Average a data set in time. Parameters: inUV  Input uv data to average, Any request for calibration, editing and selection honored Control parameter on info element of inUV: "timeAvg" OBIT_float (1,1,1) Time interval over which to average (min) [def = 1 min.] NB: this should be at least 2 integrations. scratch  True if scratch file desired, will be same type as inUV. outUV  If not scratch, then the previously defined output file May be NULL for scratch only If it exists and scratch, it will be Unrefed err  Error stack, returns if not empty. Returns: the frequency averaged ObitUV.

ObitUV* ObitUVUtilCopyZero (  ObitUV *  inUV, gboolean  scratch, ObitUV *  outUV, ObitErr *  err )

Public: Make zeroed copy of an ObitUV. Parameters: inUV  Input uv data to copy. scratch  True if scratch file desired, will be same type as inUV. outUV  If not scratch, then the previously defined output file May be NULL for scratch only If it exists and scratch, it will be Unrefed err  Error stack, returns if not empty. Returns: the zeroed ObitUV.

ObitInfoList* ObitUVUtilCount (  ObitUV *  inUV, gfloat  timeInt, ObitErr *  err )

Public: Count good data by time segment. Parameters: inData  Input UV data, data selections, if any, applied timeInt  Size of time interval in days, max. 500 intervals If data from a new source is found a new interval is started. err  Error stack, returns if not empty. Returns: ObitInfoList with entries: "numTime" OBIT_int [1] Number of time intervals "numCorr" OBIT_int [1] Number of Correlations per vis "Count" OBIT_int [?] Count of good correlations per interval "Bad" OBIT_int [?] Count of bad correlations per interval "Source" OBIT_int [?] Source ID per interval "LST" OBIT_float [?] Average LST (days) per interval -1000.0 => no data.

void ObitUVUtilIndex (  ObitUV *  inUV, ObitErr *  err )

Public: Index a uv data. Parameters: inUV  Input UV data. Control parameters are on the info member. "maxScan" OBIT_float (1,1,1) max. scan time, min. [def LARGE] "maxGap" OBIT_float (1,1,1) max. time gap in scan, min. [def LARGE] err  Error stack, returns if not empty.

void ObitUVUtilUVWExtrema (  ObitUV *  inUV, gfloat *  MaxBL, gfloat *  MaxW, ObitErr *  err )

Public: Get UVW Extrema. Imaging parameters are on the inUV info member as arrays for a number of fields. Parameters: inUV  Input uv data. MaxBL  Output maximum baseline length (sqrt(u*u+v*v)) MaxW  Output Max abs(w) in data. err  Error stack, returns if not empty.

gfloat ObitUVUtilVisCompare (  ObitUV *  inUV1, ObitUV *  inUV2, ObitErr *  err )

Public: Compare the visibilities in one ObitUVData with another. Return the RMS of the real and imaginary differences divided by the amplitude of inUV2. Only valid visibilities compared, zero amplitudes ignored. Parameters: inUV1  Input uv data numerator, no calibration/selection inUV2  Input uv data denominator, no calibration/selection inUV2 should have the same structure, no. vis etc as inUV1. err  Error stack, returns if not empty. Returns: RMS of the real and imaginary differences /amplitude, -1 => no data compared or other error.

void ObitUVUtilVisDivide (  ObitUV *  inUV1, ObitUV *  inUV2, ObitUV *  outUV, ObitErr *  err )

Public: Divide the visibilities in one ObitUVData by another. Parameters: inUV1  Input uv data numerator, no calibration/selection inUV2  Input uv data denominator, no calibration/selection inUV2 should have the same structure, no. vis etc as inUV1. outUV  Previously defined output, may be the same as inUV1 err  Error stack, returns if not empty.

ObitSourceList* ObitUVUtilWhichSources (  ObitUV *  inUV, ObitErr *  err )

Public: Get list of selected sources. Any explicit selection in Sources parameter in UV data selector selection by CalCode selection to exclude any entries marked done in the PS table if Infolist item 'doPS' is True. if time range given and an NX table exists, only select sources with data in this timerange. Parameters: inUV  UV data with all selection criteria, other controls: "doPS" OBIT_bool (1,1,1) If true and PS 1 exists, exclude [def False] "souCode" OBIT_string (4,1,1) Source Cal code desired, ' ' => any code selected '* ' => any non blank code (calibrators only) '-CAL' => blank codes only (no calibrators) def = ' ' any sources marked done in PS table 1. Parameters: *err  ObitErr error stack. Returns: requested ObitSourceList

---