ObitOTFSel.h File Reference

ObitOTFSel Obit "On the Fly" data selector class definition. More...

#include <glib.h>
#include "Obit.h"
#include "ObitOTFDesc.h"
#include "ObitErr.h"

Go to the source code of this file.

Classes
struct	ObitOTFSel
	ObitOTFSel Class structure. More...
struct	ObitOTFSelClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitOTFSelUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitOTFSel returns a ObitOTFSel* (NULL).
#define	ObitOTFSelRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitOTFSel.
#define	ObitOTFSelIsA(in)   ObitIsA (in, ObitOTFSelGetClass())
	Macro to determine if an object is the member of this or a derived class.
Functions
void	ObitOTFSelClassInit (void)
	Public: Class initializer.
ObitOTFSel *	newObitOTFSel (gchar *name)
	Public: Constructor.
gconstpointer	ObitOTFSelGetClass (void)
	Public: Return class pointer.
ObitOTFSel *	ObitOTFSelCopy (ObitOTFSel *in, ObitOTFSel *out, ObitErr *err)
	Public: Copy OTFSel.
glong	ObitOTFSelBufferSize (ObitOTFDesc *desc, ObitOTFSel *sel)
	Public: How big a buffer is needed for a data transfer?
void	ObitOTFSelDefault (ObitOTFDesc *in, ObitOTFSel *sel)
	Public: Enforces defaults in inaxes ...
void	ObitOTFSelGetDesc (ObitOTFDesc *in, ObitOTFSel *sel, ObitOTFDesc *out, ObitErr *err)
	Public: Applies selection to a Descriptor for writing.
void	ObitOTFSelSetDesc (ObitOTFDesc *in, ObitOTFSel *sel, ObitOTFDesc *out, ObitErr *err)
	Public: Applies selection to a Descriptor for reading.
void	ObitOTFSelNextInit (ObitOTFSel *in, ObitOTFDesc *desc, ObitErr *err)
	See if an OTFIndex table exists and if so initialize it to use in deciding which visibilities to read.
gboolean	ObitOTFSelNext (ObitOTFSel *in, ObitOTFDesc *desc, ObitErr *err)
	Uses selector member to decide which records to read next.
void	ObitOTFSelShutdown (ObitOTFSel *in, ObitErr *err)
	Close Index table if open.
gboolean	ObitOTFSelWantTarget (ObitOTFSel *sel, gint TargetID)
	Determine if a given target is selected.
gboolean	ObitOTFSelWantFeed (ObitOTFSel *sel, gint feed)
	Determine if a given Feed is selected.

---

Detailed Description

ObitOTFSel Obit "On the Fly" 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 newObitOTFSel constructor the ObitOTFSelCopy copy constructor or a pointer duplicated using the ObitOTFSelRef function. When an instance is no longer needed, use the ObitOTFSelUnref macro to release it.

Data selection and Calibration

The ObitOTFSel member of a ObitOTF is used to pass information the the data selection and calibration routines. This information is stored on the ObitInfoList of the ObitOTF data before it is opened with access OBIT_IO_ReadCal. Subsequent calls to ObitOTFReadSelect 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?
• "DOCALIB" OBIT_int (1,1,1) >0 -> calibrate,
• "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
• "BCHAN" OBIT_int (1,1,1) First spectral channel selected. [def all]
• "ECHAN" OBIT_int (1,1,1) Highest spectral channel selected. [def all]
• "TARGETS" OBIT_string (?,?,1) Target names selected. [def all]
• "TIMERANGE" OBIT_float (2,1,1) Selected timerange in days. [def all]
• "SCANS" OBIT_int (2,1,1) Lowest and highest selected scan numbers. [def all]
• "FEEDS" OBIT_int (?,1,1) a list of selected feed numbers, [def all.]
• "keepCal" OBIT_bool (1,1,1) If true keep cal-on data, otherwise drop [def True.]

---

Define Documentation

#define ObitOTFSelIsA (  in   )     ObitIsA (in, ObitOTFSelGetClass())

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 ObitOTFSelRef (  in   )     ObitRef (in)

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

#define ObitOTFSelUnref (  in   )     ObitUnref (in)

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

---

Function Documentation

ObitOTFSel* newObitOTFSel (  gchar *  name  )

Public: Constructor. Returns: pointer to object created.

glong ObitOTFSelBufferSize (  ObitOTFDesc *  desc, ObitOTFSel *  sel )

Public: How big a buffer is needed for a data transfer? Parameters: desc  Pointer input descriptor. sel  OTF selector. Returns: size in floats needed for I/O.

void ObitOTFSelClassInit (  void   )

Public: Class initializer.

ObitOTFSel* ObitOTFSelCopy (  ObitOTFSel *  in, ObitOTFSel *  out, ObitErr *  err )

Public: Copy OTFSel. 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 ObitOTFSelDefault (  ObitOTFDesc *  in, ObitOTFSel *  sel )

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

gconstpointer ObitOTFSelGetClass (  void   )

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

void ObitOTFSelGetDesc (  ObitOTFDesc *  in, ObitOTFSel *  sel, ObitOTFDesc *  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  OTF selector out  Pointer to output descriptor, describing form on disk. err  Obit error stack

gboolean ObitOTFSelNext (  ObitOTFSel *  in, ObitOTFDesc *  desc, ObitErr *  err )

Uses selector member to decide which records to read next. If doIndex is TRUE, then use index table. Parameters: in  Pointer to the object. desc  OTF descriptor from IO where the next visibility to read and the number will be stored. err  Error stack Returns: TRUE if finished, else FALSE

void ObitOTFSelNextInit (  ObitOTFSel *  in, ObitOTFDesc *  desc, ObitErr *  err )

See if an OTFIndex table exists and if so initialize it to use in deciding which visibilities to read. Parameters: in  Pointer to the object. desc  OTF 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 ObitOTFSelSetDesc (  ObitOTFDesc *  in, ObitOTFSel *  sel, ObitOTFDesc *  out, ObitErr *  err )

Public: Applies selection to a Descriptor for reading. Note: descriptor modification due to data selection is mostly done in ObitOTFCalApply. Also sets any previously undefined values on sel. Parameters: in  Pointer to input descriptor, this describes the data as they appear on disk (possibly compressed). sel  OTF selector, blc, trc members changed if needed. out  Pointer to output descriptor, this describes the data after any processing when read. err  Obit error stack

void ObitOTFSelShutdown (  ObitOTFSel *  in, ObitErr *  err )

Close Index table if open. Parameters: in  Pointer to the Selector. err  Error stack Returns: TRUE is finished, else FALSE

gboolean ObitOTFSelWantFeed (  ObitOTFSel *  sel, gint  feed )

Determine if a given Feed is selected. Parameters: sel  OTF selector. feed  feed id to test Returns: TRUE if feed selected.

gboolean ObitOTFSelWantTarget (  ObitOTFSel *  sel, gint  TargetID )

Determine if a given target is selected. Parameters: sel  OTF selector. TargetID  Target ID to be tested, <=0 => any Returns: TRUE if target selected.

---