ObitSkyModelVMIon.h File Reference

ObitSkyModelVMIon class represents ionospheric corrected sky models and their Fourier transforms. More...

#include "Obit.h"
#include "ObitErr.h"
#include "ObitFArray.h"
#include "ObitCArray.h"
#include "ObitCInterpolate.h"
#include "ObitImageMosaic.h"
#include "ObitUV.h"
#include "ObitSkyModelVM.h"
#include "ObitTableNI.h"

Go to the source code of this file.

Classes
struct	ObitSkyModelVMIon
	ObitSkyModelVMIon Class structure. More...
struct	ObitSkyModelVMIonClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitSkyModelVMIonUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitSkyModelVMIon returns a ObitSkyModelVMIon*.
#define	ObitSkyModelVMIonRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitSkyModelVMIon.
#define	ObitSkyModelVMIonIsA(in)   ObitIsA (in, ObitSkyModelVMIonGetClass())
	Macro to determine if an object is the member of this or a derived class.
Functions
void	ObitSkyModelVMIonClassInit (void)
	Public: Class initializer.
ObitSkyModelVMIon *	newObitSkyModelVMIon (gchar *name)
	Public: Default Constructor.
ObitSkyModelVMIon *	ObitSkyModelVMIonCreate (gchar *name, ObitImageMosaic *mosaic)
	Public: Create/initialize ObitSkyModelVMIon structures.
void	ObitSkyModelVMIonInitMod (ObitSkyModel *in, ObitUV *uvdata, ObitErr *err)
	Public: initialize ObitSkyModelVMIon structures.
void	ObitSkyModelVMIonShutDownMod (ObitSkyModel *in, ObitUV *uvdata, ObitErr *err)
	Public: shutdown ObitSkyModel processes.
void	ObitSkyModelVMInitModel (ObitSkyModel *in, ObitErr *err)
	Public: initialize model for pass through data.
gconstpointer	ObitSkyModelVMIonGetClass (void)
	Public: ClassInfo pointer.
ObitSkyModelVMIon *	ObitSkyModelVMIonCopy (ObitSkyModelVMIon *in, ObitSkyModelVMIon *out, ObitErr *err)
	Public: Copy (deep) constructor.
void	ObitSkyModelVMIonClone (ObitSkyModelVMIon *in, ObitSkyModelVMIon *out, ObitErr *err)
	Public: Copy structure.
void	ObitSkyModelVMIonUpdateModel (ObitSkyModelVM *in, gfloat time, gint suba, ObitUV *uvdata, ObitErr *err)
	Public: Routine to update model.

---

Detailed Description

ObitSkyModelVMIon class represents ionospheric corrected sky models and their Fourier transforms.

This class represents sky models incorporating ionospheric phase models and their Fourier transforms and is derived from the ObitSkyModelVMIon class. Models of visibility data incorporating the corrupting effects of a time and spatially variable ionospheric model are calculated

This class is derived from the ObitSkyModelVM class.

Creators and Destructors

An ObitSkyModelVMIon will usually be created using ObitSkyModelVMIonCreate which allows specifying a name for the object as well as the ImageMosaic containing the model.

A copy of a pointer to an ObitSkyModelVMIon should always be made using the ObitSkyModelVMIonRef function which updates the reference count in the object. Then whenever freeing an ObitSkyModelVMIon or changing a pointer, the function ObitSkyModelVMIonUnref will decrement the reference count and destroy the object when the reference count hits 0. There is no explicit destructor.

Data selection

The selection of data to be modified is through values added to the info (ObitInfoList) member and include the following:

• "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 "I"] In the above 'F' can substitute for "formal" 'I' (both RR+LL).
• "ionVer"OBIT_int (1,1,1) NI table version number, 0-> use highest, def=1
• "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]
• "do3D" OBIT_bool (1,1,1) If 3D imaging wanted. [def false]
• "DIVIDE" OBIT_bool (1,1,1) If division rather than subtraction wanted. [def false]
• "REPLACE" OBIT_bool (1,1,1) If TRUE replace data with model. [def false]
• "PBCor" OBIT_bool (1,1,1) If TRUE make relative primary beam corrections [def true]
• "noNeg" OBIT_bool (1,1,1) If TRUE only positive flux comps are to be used [def false]
• "antSize" OBIT_float (1,1,1) Diameter of antennas for rel. r,.[def 25.0]
• "Factor" OBIT_float (1,1,1) model multiplications factor (-1=>add) [def 1]
• "minFlux" OBIT_float (1,1,1) Minimum flux density model or pixel [def -1.0e20]
• "ModelType" OBIT_int (1,1,1) Model type (ObitSkyModelType) [def OBIT_SkyModel_Comps]
• "MODPTFLX" OBIT_float (1,1,1) Point model flux in Jy, [def 0.0]
• "MODPTXOF" OBIT_float (1,1,1) Point model "x" offset in deg [def 0.0]
• "MODPTYOF" OBIT_float (1,1,1) Point model "y" offset in deg [def 0.0]
• "MODPTYPM" OBIT_float (4,1,1) Point other parameters [def all 0.0]
• "CCVer" OBIT_int (?,1,1) CC table versions to use [def all 0 => highest]
• "BComp" OBIT_int (?,1,1) Start CC to use per table, 1-rel [def 1 ]
• "EComp" OBIT_int (?,1,1) Highest CC to use per table, 1-rel [def to end ]
• "UpdateInt" OBIT_float (1,1,1) Model update interval (d) [def 1 min]
• "ionVer"OBIT_int (1,1,1) NI table version number, 0-> use highest, def=1

---

Define Documentation

#define ObitSkyModelVMIonIsA (  in   )     ObitIsA (in, ObitSkyModelVMIonGetClass())

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

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

#define ObitSkyModelVMIonUnref (  in   )     ObitUnref (in)

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

---

Function Documentation

ObitSkyModelVMIon* newObitSkyModelVMIon (  gchar *  name  )

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

void ObitSkyModelVMInitModel (  ObitSkyModel *  inn, ObitErr *  err )

Public: initialize model for pass through data. Parameters: inn  SkyModel to initialize err  Obit error stack object.

void ObitSkyModelVMIonClassInit (  void   )

Public: Class initializer.

void ObitSkyModelVMIonClone (  ObitSkyModelVMIon *  in, ObitSkyModelVMIon *  out, ObitErr *  err )

Public: Copy structure.

ObitSkyModelVMIon* ObitSkyModelVMIonCopy (  ObitSkyModelVMIon *  in, ObitSkyModelVMIon *  out, ObitErr *  err )

Public: Copy (deep) constructor. Parameters: in  The object to copy out  An existing object pointer for output or NULL if none exists. err  Obit error stack object. Returns: pointer to the new object.

ObitSkyModelVMIon* ObitSkyModelVMIonCreate (  gchar *  name, ObitImageMosaic *  mosaic )

Public: Create/initialize ObitSkyModelVMIon structures. Parameters: name  An optional name for the object. mosaic  ObitImageMosaic giving one or more images/CC tables Returns: the new object.

gconstpointer ObitSkyModelVMIonGetClass (  void   )

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

void ObitSkyModelVMIonInitMod (  ObitSkyModel *  inn, ObitUV *  uvdata, ObitErr *  err )

Public: initialize ObitSkyModelVMIon structures. fieldIndex index in field based tables for a given field (0-rel) uRotTab Table of rotation matrices for components 6 needed per row (field) Only fields with actual components are included ZernX Table of Zernike X gradient terms per field ZernY Table of Zernike Y gradient terms per field do3D if true need 3D rotation ccrot, ssrot = cosine, sine of rotation difference between uv, image Parameters: inn  SkyModel to initialize uvdata  uv data being modeled. err  Obit error stack object.

void ObitSkyModelVMIonShutDownMod (  ObitSkyModel *  inn, ObitUV *  uvdata, ObitErr *  err )

Public: shutdown ObitSkyModel processes. Parameters: inn  SkyModel to shutdown uvdata  uv data being modeled. err  Obit error stack object.

void ObitSkyModelVMIonUpdateModel (  ObitSkyModelVM *  inn, gfloat  time, gint  suba, ObitUV *  uvdata, ObitErr *  err )

Public: Routine to update model. Parameters: inn  SkyModelVM time  current time (d) suba  0-rel subarray number (not used here) err  Obit error stack object.

---