ObitUVCal.h File Reference

ObitUVCal data calibration class definition. More...

#include "Obit.h"
#include "ObitErr.h"
#include "ObitThread.h"
#include "ObitInfoList.h"
#include "ObitUVDesc.h"
#include "ObitUVSel.h"
#include <string.h>
#include <stdio.h>
#include <stdlib.h>
#include <math.h>
#include <glib.h>
#include "ObitUVCal.h"
#include "ObitFFT.h"
#include "ObitSourceList.h"
#include "ObitAntennaList.h"
#include "ObitDef.h"
#include "ObitClassDef.h"

Go to the source code of this file.

Classes
struct	ObitUVCalCalibrateS
	Amp/phase/delay/rate calibration structure. More...
struct	ObitUVCalBaselineS
	Amp/phase/delay/rate calibration structure. More...
struct	ObitUVCalFlagS
	Amp/phase/delay/rate calibration structure. More...
struct	ObitUVCalBandpassS
	Amp/phase/delay/rate calibration structure. More...
struct	ObitUVCalPolarizationS
	Polarization calibration structure. More...
struct	ObitUVCal
	ObitUVCal Class structure. More...
struct	ObitUVCalClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitUVCalUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitUVCal returns a ObitUVCal*.
#define	ObitUVCalRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitUVCal.
#define	ObitUVCalIsA(in)   ObitIsA (in, ObitUVCalGetClass())
	Macro to determine if an object is the member of this or a derived class.
Typedefs
typedef void(*	ObitUVCalStartFP )(ObitUVCal *in, ObitUVSel *sel, ObitUVDesc *inDesc, ObitUVDesc *outDesc, ObitErr *err)
typedef gboolean(*	ObitUVCalApplyFP )(ObitUVCal *in, gfloat *visIn, gfloat *visOut, ObitErr *err)
typedef void(*	ObitUVCalShutdownFP )(ObitUVCal *in, ObitErr *err)
typedef gboolean(*	ObitUVCalWantFP )(ObitUVCal *in, gfloat time, glong ant1, glong ant2, gfloat *RP, gfloat *visIn, ObitErr *err)
typedef void(*	ObitUVCalSmoothFP )(ObitUVCal *in, float time, glong ant1, glong ant2, gfloat *visIn, ObitErr *err)
Functions
void	ObitUVCalClassInit (void)
	Public: Class initializer.
ObitUVCal *	newObitUVCal (gchar *name)
	Public: Constructor.
gconstpointer	ObitUVCalGetClass (void)
	Public: ClassInfo pointer.
ObitUVCal *	ObitUVCalCopy (ObitUVCal *in, ObitUVCal *out, ObitErr *err)
	Public: Copy (deep) constructor.
ObitUVCal *	ObitUVCalClone (ObitUVCal *in, ObitUVCal *out)
	Public: Copy (shallow) constructor.
void	ObitUVCalStart (ObitUVCal *in, ObitUVSel *sel, ObitUVDesc *inDesc, ObitUVDesc *outDesc, ObitErr *err)
	Public: Initialize calibration.
gboolean	ObitUVCalApply (ObitUVCal *in, gfloat *visIn, gfloat *visOut, ObitErr *err)
	Public: Apply Calibration.
void	ObitUVCalShutdown (ObitUVCal *in, ObitErr *err)
	Public: Shutdown.
gboolean	ObitUVCalWant (ObitUVCal *in, gfloat time, glong ant1, glong ant2, gfloat *RP, gfloat *visIn, ObitErr *err)
	Public: test if data wanted.
void	ObitUVCalSmooth (ObitUVCal *in, float time, glong ant1, glong ant2, gfloat *RP, gfloat *visIn, ObitErr *err)
	Public: Smooth data in frequency.

---

Detailed Description

ObitUVCal data calibration class definition.

This class is derived from the Obit class.

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

---

Define Documentation

#define ObitUVCalIsA (  in   )     ObitIsA (in, ObitUVCalGetClass())

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

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

#define ObitUVCalUnref (  in   )     ObitUnref (in)

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

---

Typedef Documentation

typedef gboolean(* ObitUVCalApplyFP)(ObitUVCal *in, gfloat *visIn, gfloat *visOut, ObitErr *err)

typedef void(* ObitUVCalShutdownFP)(ObitUVCal *in, ObitErr *err)

typedef void(* ObitUVCalSmoothFP)(ObitUVCal *in, float time, glong ant1, glong ant2, gfloat *visIn, ObitErr *err)

typedef void(* ObitUVCalStartFP)(ObitUVCal *in, ObitUVSel *sel, ObitUVDesc *inDesc, ObitUVDesc *outDesc, ObitErr *err)

typedef gboolean(* ObitUVCalWantFP)(ObitUVCal *in, gfloat time, glong ant1, glong ant2, gfloat *RP, gfloat *visIn, ObitErr *err)

---

Function Documentation

ObitUVCal* newObitUVCal (  gchar *  name  )

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

gboolean ObitUVCalApply (  ObitUVCal *  in, gfloat *  recIn, gfloat *  recOut, ObitErr *  err )

Public: Apply Calibration. Data should be uncompressed before calling. Parameters: in  Calibration Object. recIn  Input raw data array for a single visibility, random parameters then visibility array. recOut  Output calibrated, edited,transformed data. err  ObitError stack. Returns: TRUE if some of the data is valid, FALSE if none.

void ObitUVCalClassInit (  void   )

Public: Class initializer.

ObitUVCal* ObitUVCalClone (  ObitUVCal *  in, ObitUVCal *  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.

ObitUVCal* ObitUVCalCopy (  ObitUVCal *  in, ObitUVCal *  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 ObitUVCalGetClass (  void   )

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

void ObitUVCalShutdown (  ObitUVCal *  in, ObitErr *  err )

Public: Shutdown. Parameters: in  Calibration Object. err  ObitError stack.

void ObitUVCalSmooth (  ObitUVCal *  in, float  time, glong  ant1, glong  ant2, gfloat *  RP, gfloat *  visIn, ObitErr *  err )

Public: Smooth data in frequency. Parameters: in  Calibration Object. time  Time of datum ant1  first antenna number of baseline ant2  second antanna of baseline. RP  Random parameters array. visIn  1 visibility as an array of floats err  ObitError stack.

void ObitUVCalStart (  ObitUVCal *  in, ObitUVSel *  sel, ObitUVDesc *  inDesc, ObitUVDesc *  outDesc, ObitErr *  err )

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

gboolean ObitUVCalWant (  ObitUVCal *  in, gfloat  time, glong  ant1, glong  ant2, gfloat *  RP, gfloat *  visIn, ObitErr *  err )

Public: test if data wanted. Parameters: in  Calibration Object. time  Time of datum ant1  first antenna number of baseline ant2  second antanna of baseline. RP  Random parameter array visIn  1 visibility as an array of floats err  ObitError stack.

---