ObitOTFCal.h File Reference

ObitOTFCal "On the Fly" calibration class definition. More...

#include <math.h>
#include <glib.h>
#include <glibconfig.h>
#include "Obit.h"
#include "ObitErr.h"
#include "ObitThread.h"
#include "ObitInfoList.h"
#include "ObitOTFDesc.h"
#include "ObitOTFSel.h"
#include "ObitOTFArrayGeom.h"
#include "ObitTableOTFCal.h"
#include "ObitTableOTFSoln.h"

Go to the source code of this file.

Classes
struct	ObitOTFCalFlagS
	calibration structure More...
struct	ObitOTFCal
	ObitOTFCal Class structure. More...
struct	ObitOTFCalClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitOTFCalUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitOTFCal returns a ObitOTFCal*.
#define	ObitOTFCalRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitOTFCal.
#define	ObitOTFCalIsA(in)   ObitIsA (in, ObitOTFCalGetClass())
	Macro to determine if an object is the member of this or a derived class.
Typedefs
typedef void(*	ObitOTFCalStartFP )(ObitOTFCal *in, ObitOTFSel *sel, ObitOTFArrayGeom *geom, ObitOTFDesc *inDesc, ObitOTFDesc *outDesc, ObitErr *err)
typedef gboolean(*	ObitOTFCalApplyFP )(ObitOTFCal *in, gfloat *recIn, gfloat *recOut, ObitErr *err)
typedef void(*	ObitOTFCalShutdownFP )(ObitOTFCal *in, ObitErr *err)
Functions
void	ObitOTFCalClassInit (void)
	Public: Class initializer.
ObitOTFCal *	newObitOTFCal (gchar *name)
	Public: Constructor.
gconstpointer	ObitOTFCalGetClass (void)
	Public: ClassInfo pointer.
ObitOTFCal *	ObitOTFCalCopy (ObitOTFCal *in, ObitOTFCal *out, ObitErr *err)
	Public: Copy (deep) constructor.
ObitOTFCal *	ObitOTFCalClone (ObitOTFCal *in, ObitOTFCal *out)
	Public: Copy (shallow) constructor.
void	ObitOTFCalStart (ObitOTFCal *in, ObitOTFSel *sel, ObitOTFDesc *inDesc, ObitOTFArrayGeom *geom, ObitOTFDesc *outDesc, ObitErr *err)
	Public: Initialize calibration.
gboolean	ObitOTFCalApply (ObitOTFCal *in, gfloat *recIn, gfloat *recOut, ObitErr *err)
	Public: Apply Calibration.
ObitOTFCal *	ObitOTFCalShutdown (ObitOTFCal *in, ObitErr *err)
	Public: Shutdown.

---

Detailed Description

ObitOTFCal "On the Fly" calibration class definition.

This class is derived from the Obit class.

This class is for the calibration, editing and selection of OTF data.

---

Define Documentation

#define ObitOTFCalIsA (  in   )     ObitIsA (in, ObitOTFCalGetClass())

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

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

#define ObitOTFCalUnref (  in   )     ObitUnref (in)

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

---

Typedef Documentation

typedef gboolean(* ObitOTFCalApplyFP)(ObitOTFCal *in, gfloat *recIn, gfloat *recOut, ObitErr *err)

typedef void(* ObitOTFCalShutdownFP)(ObitOTFCal *in, ObitErr *err)

typedef void(* ObitOTFCalStartFP)(ObitOTFCal *in, ObitOTFSel *sel, ObitOTFArrayGeom *geom, ObitOTFDesc *inDesc, ObitOTFDesc *outDesc, ObitErr *err)

---

Function Documentation

ObitOTFCal* newObitOTFCal (  gchar *  name  )

Public: Constructor. Initializes class if needed on first call. Parameters: name  An optional name for the object. Returns: the new object.

gboolean ObitOTFCalApply (  ObitOTFCal *  in, gfloat *  recIn, gfloat *  recOut, ObitErr *  err )

Public: Apply Calibration. Parameters: in  Calibration Object. recIn  input data array for a single record recOut  output data array for a single record, calibrated selected and translated. err  ObitError stack. Returns: TRUE if some of the data is valid, FALSE if none.

void ObitOTFCalClassInit (  void   )

Public: Class initializer.

ObitOTFCal* ObitOTFCalClone (  ObitOTFCal *  in, ObitOTFCal *  out )

Public: Copy (shallow) constructor. The result will have pointers to the more complex members. Parent class members are included but any derived class info is ignored. Parameters: in  The object to copy out  An existing object pointer for output or NULL if none exists. Returns: pointer to the new object.

ObitOTFCal* ObitOTFCalCopy (  ObitOTFCal *  in, ObitOTFCal *  out, ObitErr *  err )

Public: Copy (deep) constructor. Copies are made of complex members including disk files; these will be copied applying whatever selection is associated with the input. Parent class members are included but any derived class info is ignored. Parameters: in  The object to copy out  An existing object pointer for output or NULL if none exists. err  Error stack, returns if not empty. Returns: pointer to the new object.

gconstpointer ObitOTFCalGetClass (  void   )

Public: ClassInfo pointer. Returns: pointer to the class structure.

ObitOTFCal* ObitOTFCalShutdown (  ObitOTFCal *  in, ObitErr *  err )

Public: Shutdown. Parameters: in  Calibration Object. err  ObitError stack. Returns: NULL pointer for deallocated ObitOTFCal

void ObitOTFCalStart (  ObitOTFCal *  in, ObitOTFSel *  sel, ObitOTFDesc *  inDesc, ObitOTFArrayGeom *  geom, ObitOTFDesc *  outDesc, ObitErr *  err )

Public: Initialize calibration. Parameters: in  Object to initialize. sel  Data selector. inDesc  Input data descriptor. outDesc  Output data descriptor (after transformations/selection). err  ObitError stack.

---