ObitUVSel.h File Reference

ObitUVSel Obit uv data selector class definition. More...

#include "Obit.h"
#include "ObitUVDesc.h"
#include "ObitErr.h"
#include "ObitDef.h"
#include "ObitClassDef.h"

Go to the source code of this file.

Classes
struct	ObitUVSel
	ObitUVSel Class structure. More...
struct	ObitUVSelClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitUVSelUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitUVSel returns a ObitUVSel* (NULL).
#define	ObitUVSelRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitUVSel.
#define	ObitUVSelIsA(in)   ObitIsA (in, ObitUVSelGetClass())
	Macro to determine if an object is the member of this or a derived class.
Functions
void	ObitUVSelClassInit (void)
	Public: Class initializer.
ObitUVSel *	newObitUVSel (gchar *name)
	Public: Constructor.
gconstpointer	ObitUVSelGetClass (void)
	Public: Return class pointer.
ObitUVSel *	ObitUVSelCopy (ObitUVSel *in, ObitUVSel *out, ObitErr *err)
	Public: Copy UVSel.
glong	ObitUVSelBufferSize (ObitUVDesc *desc, ObitUVSel *sel)
	Public: How big a buffer is needed for a data transfer?
void	ObitUVSelDefault (ObitUVDesc *in, ObitUVSel *sel)
	Public: Enforces defaults in inaxes, blc, trc.
void	ObitUVSelGetDesc (ObitUVDesc *in, ObitUVSel *sel, ObitUVDesc *out, ObitErr *err)
	Public: Applies selection to a Descriptor for writing.
void	ObitUVSelSetDesc (ObitUVDesc *in, ObitUVSel *sel, ObitUVDesc *out, ObitErr *err)
	Public: Applies selection to a Descriptor for reading.
void	ObitUVSelNextInit (ObitUVSel *in, ObitUVDesc *desc, ObitErr *err)
	See if an NX table exists and if so initialize it to use in deciding which visibilities to read.
gboolean	ObitUVSelNext (ObitUVSel *in, ObitUVDesc *desc, ObitErr *err)
	Uses selector member to decide which visibilities to read next.
void	ObitUVSelShutdown (ObitUVSel *in, ObitErr *err)
	Close NX table if open .
void	ObitUVSelSetSour (ObitUVSel *sel, gpointer inData, gint Qual, gchar *souCode, gchar *Sources, gint lsou, gint nsou, ObitErr *err)
	Set selector for source selection.
void	ObitUVSelSetAnt (ObitUVSel *sel, gint *Antennas, gint nant)
	Set selector for antenna selection.
gboolean	ObitUVSelWantSour (ObitUVSel *sel, gint SourID)
	Determine if a given source is selected.
gboolean	ObitUVSelWantAnt (ObitUVSel *sel, gint ant)
	Determine if a given antenna is selected.
gfloat	ObitUVSelSubScan (ObitUVSel *sel)
	Suggest a length for a sub interval of the current scan such that the scan is evenly divided.

---

Detailed Description

ObitUVSel Obit uv data selector class definition.

This class is derived from the Obit class.

This contains the descriptions of data selection and calibration.

Usage

Instances can be obtained using the newObitUVSel constructor the ObitUVSelCopy copy constructor or a pointer duplicated using the ObitUVSelRef function. When an instance is no longer needed, use the ObitUVSelUnref macro to release it.

Data selection and Calibration

The ObitUVSel member of a ObitUV is used to pass information the the data selection and calibration routines. This information is stored on the ObitInfoList of the ObitUV data before it is opened with access OBIT_IO_ReadCal. Subsequent calls to ObitUVReadSelect will apply the data selection and calibration requested. The calibration/selection paramters are described in the following list.

• "doCalSelect" OBIT_bool (1,1,1) Select/calibrate/edit data?
• "Stokes" OBIT_string (4,1,1) Selected output Stokes parameters: " "=> no translation,"I ","V ","Q ", "U ", "IQU ", "IQUV", "IV ", "RR ", "LL ", "RL ", "LR ", "HALF" = RR,LL, "FULL"=RR,LL,RL,LR. [default " "] In the above 'F' can substitute for "formal" 'I' (both RR+LL).
• "BChan" OBIT_int (1,1,1) First spectral channel selected. [def all]
• "EChan" OBIT_int (1,1,1) Highest spectral channel selected. [def all]
• "BIF" OBIT_int (1,1,1) First "IF" selected. [def all]
• "EIF" OBIT_int (1,1,1) Highest "IF" selected. [def all]
• "doPol" OBIT_int (1,1,1) >0 -> calibrate polarization.
• "doCalib" OBIT_int (1,1,1) >0 -> calibrate, 2=> also calibrate Weights
• "gainUse" OBIT_int (1,1,1) SN/CL table version number, 0-> use highest
• "flagVer" OBIT_int (1,1,1) Flag table version, 0-> use highest, <0-> none
• "BLVer" OBIT_int (1,1,1) BL table version, 0> use highest, <0-> none
• "BPVer" OBIT_int (1,1,1) Band pass (BP) table version, 0-> use highest
• "Subarray" OBIT_int (1,1,1) Selected subarray, <=0->all [default all]
• "dropSubA" OBIT_bool (1,1,1) Drop subarray info?
• "FreqID" OBIT_int (1,1,1) Selected Frequency ID, <=0->all [default all]
• "timeRange" OBIT_float (2,1,1) Selected timerange in days.
• "timeRange" OBIT_float (2,1,1) Selected timerange in days.
• "UVRange" OBIT_float (2,1,1) Selected UV range in kilowavelengths.
• "InputAvgTime" OBIT_float (1,1,1) Input data averaging time (sec). used for fringe rate decorrelation correction.
• "Sources" OBIT_string (?,?,1) Source names selected unless any starts with a '-' in which case all are deselected (with '-' stripped).
• "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)
• "Qual" Obit_int (1,1,1) Source qualifier, -1 [default] = any
• "Antennas" OBIT_int (?,1,1) a list of selected antenna numbers, if any is negative then the absolute values are used and the specified antennas are deselected.
• "corrtype" OBIT_int (1,1,1) Correlation type, 0=cross corr only, 1=both, 2=auto only.
• "passAll" OBIT_bool (1,1,1) If True, pass along all data when selecting/calibration even if it's all flagged, data deselected by time, source, antenna etc. is not passed.
• "doBand" OBIT_int (1,1,1) Band pass application type <0-> none (1) if = 1 then all the bandpass data for each antenna will be averaged to form a composite bandpass spectrum, this will then be used to correct the data. (2) if = 2 the bandpass spectra nearest in time (in a weighted sense) to the uv data point will be used to correct the data. (3) if = 3 the bandpass data will be interpolated in time using the solution weights to form a composite bandpass spectrum, this interpolated spectrum will then be used to correct the data. (4) if = 4 the bandpass spectra nearest in time (neglecting weights) to the uv data point will be used to correct the data. (5) if = 5 the bandpass data will be interpolated in time ignoring weights to form a composite bandpass spectrum, this interpolated spectrum will then be used to correct the data.
• "Smooth" OBIT_float (3,1,1) specifies the type of spectral smoothing Smooth(1) = type of smoothing to apply: 0 => no smoothing 1 => Hanning 2 => Gaussian 3 => Boxcar 4 => Sinc (i.e. sin(x)/x) Smooth(2) = the "diameter" of the function, i.e. width between first nulls of Hanning triangle and sinc function, FWHM of Gaussian, width of Boxcar. Defaults (if < 0.1) are 4, 2, 2 and 3 channels for Smooth(1) = 1 - 4. Smooth(3) = the diameter over which the convolving function has value - in channels. Defaults: 1, 3, 1, 4 times Smooth(2) used when
• "SubScanTime" Obit_float scalar [Optional] if given, this is the desired time (days) of a sub scan. This is used by the selector to suggest a value close to this which will evenly divide the current scan. See ObitUVSelSubScan 0 => Use scan average. This is only useful for ReadSelect operations on indexed ObitUVs.

---

Define Documentation

#define ObitUVSelIsA (  in   )     ObitIsA (in, ObitUVSelGetClass())

Macro to determine if an object is the member of this or a derived class. Returns TRUE if a member, else FALSE in = object to reference

#define ObitUVSelRef (  in   )     ObitRef (in)

Macro to reference (update reference count) an ObitUVSel. returns a ObitUVSel*. in = object to reference

#define ObitUVSelUnref (  in   )     ObitUnref (in)

Macro to unreference (and possibly destroy) an ObitUVSel returns a ObitUVSel* (NULL). in = object to unreference.

---

Function Documentation

ObitUVSel* newObitUVSel (  gchar *  name  )

Public: Constructor. Returns: pointer to object created.

glong ObitUVSelBufferSize (  ObitUVDesc *  desc, ObitUVSel *  sel )

Public: How big a buffer is needed for a data transfer? The buffer is intended for the uncompressed versions of uv data records. Parameters: desc  Pointer input descriptor. sel  UV selector. Returns: size in floats needed for I/O.

void ObitUVSelClassInit (  void   )

Public: Class initializer.

ObitUVSel* ObitUVSelCopy (  ObitUVSel *  in, ObitUVSel *  out, ObitErr *  err )

Public: Copy UVSel. Parameters: in  Pointer to object to be copied. out  Pointer to object to be written. If NULL then a new structure is created. err  ObitErr error stack Returns: Pointer to new object.

void ObitUVSelDefault (  ObitUVDesc *  in, ObitUVSel *  sel )

Public: Enforces defaults in inaxes, blc, trc. Parameters: in  Pointer to descriptor. sel  UV selector, output vis descriptor changed if needed.

gconstpointer ObitUVSelGetClass (  void   )

Public: Return class pointer. Initializes class if needed on first call. Returns: pointer to the class structure.

void ObitUVSelGetDesc (  ObitUVDesc *  in, ObitUVSel *  sel, ObitUVDesc *  out, ObitErr *  err )

Public: Applies selection to a Descriptor for writing. Parameters: in  Pointer to input descriptor, this describes the data as they appear in memory. sel  UV selector, blc, trc members changed if needed. out  Pointer to output descriptor, describing form on disk. err  Obit error stack

gboolean ObitUVSelNext (  ObitUVSel *  in, ObitUVDesc *  desc, ObitErr *  err )

Uses selector member to decide which visibilities to read next. If doIndex is TRUE, then visibilities are selected from the NX table. Parameters: in  Pointer to the object. desc  UV descriptor from IO where the next visibility to read and the number will be stored. 0 causes an initialization.&nleft) err  Error stack Returns: TRUE is finished, else FALSE

void ObitUVSelNextInit (  ObitUVSel *  in, ObitUVDesc *  desc, ObitErr *  err )

See if an NX table exists and if so initialize it to use in deciding which visibilities to read. Parameters: in  Pointer to the object. desc  UV descriptor from IO where the next visibility to read and the number will be stored. err  Error stack Returns: TRUE is finished, else FALSE

void ObitUVSelSetAnt (  ObitUVSel *  sel, gint *  Antennas, gint  nant )

Set selector for antenna selection. Parameters: sel  UV selector. Antennas  List of selected Antennas, NULL or all 0 => all, zero entries after first non zero are ignored. Any negative values means all named are deselected nant  Number of entries in Antennas

void ObitUVSelSetDesc (  ObitUVDesc *  in, ObitUVSel *  sel, ObitUVDesc *  out, ObitErr *  err )

Public: Applies selection to a Descriptor for reading. Note: many operations associated with data selection are done in ObitUVCalSelectInit. Also sets previously undefined values on sel. Parameters: in  Pointer to input descriptor, this describes the data as they appear on disk (possibly compressed). sel  UV selector, members changed if needed. out  Pointer to output descriptor, this describes the data after any processing when read, or before any compression on output. err  Obit error stack

void ObitUVSelSetSour (  ObitUVSel *  sel, gpointer  inData, gint  Qual, gchar *  souCode, gchar *  Sources, gint  lsou, gint  nsou, ObitErr *  err )

Set selector for source selection. Parameters: sel  UV selector. inData  Associated UV data (as gpointer to avoid recursive definition) Qual  Source qualifier, -1 => any souCode  selection of Source by Calcode,if not specified in Source ' ' => any calibrator code selected '* ' => any non blank code (cal. only) '-CAL' => blank codes only (no calibrators) anything else = calibrator code to select. NB: The souCode test is applied in addition to the other tests, i.e. Sources and Qual, in the selection of sources to process Sources  Selected source names, [0] blank=> any this is passed as a lsou x nsou array of characters lsou  length of source name in Sources nsou  maximum number of entries in Sources err  Obit error/message stack

void ObitUVSelShutdown (  ObitUVSel *  in, ObitErr *  err )

Close NX table if open . If doIndex is TRUE, then visibilities are selected from the NX table. Parameters: in  Pointer to the Selector. err  Error stack Returns: TRUE is finished, else FALSE

gfloat ObitUVSelSubScan (  ObitUVSel *  sel  )

Suggest a length for a sub interval of the current scan such that the scan is evenly divided. This is based on the target value SubScanTime. This is only useful for ReadSelect operations on an indexed ObitUV. Parameters: sel  UV selector. Returns: suggested subscan length in days;

gboolean ObitUVSelWantAnt (  ObitUVSel *  sel, gint  ant )

Determine if a given antenna is selected. Parameters: sel  UV selector. ant  antenna id to test Returns: TRUE if antenna selected.

gboolean ObitUVSelWantSour (  ObitUVSel *  sel, gint  SourID )

Determine if a given source is selected. Parameters: sel  UV selector. SourID  Source ID to be tested Returns: TRUE if source selected.

---