ObitSkyModelVM.h File Reference

ObitSkyModelVMIon class represents temporally or spatially variable effect 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 "ObitSkyModel.h"

Go to the source code of this file.

Classes
struct	ObitSkyModelVM
	ObitSkyModelVM Class structure. More...
struct	ObitSkyModelVMClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitSkyModelVMUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitSkyModelVM returns a ObitSkyModelVM*.
#define	ObitSkyModelVMRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitSkyModelVM.
#define	ObitSkyModelVMIsA(in)   ObitIsA (in, ObitSkyModelVMGetClass())
	Macro to determine if an object is the member of this or a derived class.
Typedefs
typedef void(*	ObitSkyModelVMUpdateModelFP )(ObitSkyModelVM *in, gfloat time, gint suba, ObitUV *uvdata, ObitErr *err)
Functions
void	ObitSkyModelVMClassInit (void)
	Public: Class initializer.
ObitSkyModelVM *	newObitSkyModelVM (gchar *name)
	Public: Default Constructor.
ObitSkyModelVM *	ObitSkyModelVMCreate (gchar *name, ObitImageMosaic *mosaic)
	Public: Create/initialize ObitSkyModelVM structures.
void	ObitSkyModelVMGetInput (ObitSkyModel *inn, ObitErr *err)
	Public: Get Inputs.
void	ObitSkyModelVMInitMod (ObitSkyModel *in, ObitUV *uvdata, ObitErr *err)
	Public: initialize ObitSkyModelVM structures.
void	ObitSkyModelVMShutDownMod (ObitSkyModel *in, ObitUV *uvdata, ObitErr *err)
	Public: shutdown ObitSkyModel processes.
void	ObitSkyModelVMInitModel (ObitSkyModel *in, ObitErr *err)
	Public: initialize model for pass in time through data.
gconstpointer	ObitSkyModelVMGetClass (void)
	Public: ClassInfo pointer.
ObitSkyModel *	ObitSkyModelVMCopy (ObitSkyModel *in, ObitSkyModel *out, ObitErr *err)
	Public: Copy (deep) constructor.
void	ObitSkyModelVMUpdateModel (ObitSkyModelVM *in, gfloat time, gint suba, ObitUV *uvdata, ObitErr *err)
	Public: Routine to update model.

---

Detailed Description

ObitSkyModelVMIon class represents temporally or spatially variable effect corrected sky models and their Fourier transforms .

This is a virtual ObitSkyModel class for implementing incorporation of temporally and/or spatially variable effects.

This class is derived from the ObitSkyModel class.

Creators and Destructors

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

A copy of a pointer to an ObitSkyModelVM should always be made using the ObitSkyModelVMRef function which updates the reference count in the object. Then whenever freeing an ObitSkyModelVM or changing a pointer, the function ObitSkyModelVMUnref 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]

---

Define Documentation

#define ObitSkyModelVMIsA (  in   )     ObitIsA (in, ObitSkyModelVMGetClass())

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

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

#define ObitSkyModelVMUnref (  in   )     ObitUnref (in)

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

---

Typedef Documentation

typedef void(* ObitSkyModelVMUpdateModelFP)(ObitSkyModelVM *in, gfloat time, gint suba, ObitUV *uvdata, ObitErr *err)

---

Function Documentation

ObitSkyModelVM* newObitSkyModelVM (  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 ObitSkyModelVMClassInit (  void   )

Public: Class initializer.

ObitSkyModel* ObitSkyModelVMCopy (  ObitSkyModel *  inn, ObitSkyModel *  outt, ObitErr *  err )

Public: Copy (deep) constructor. Since this is a virtual class it only calls parent class. Parameters: inn  The object to copy outt  An existing object pointer for output or NULL if none exists. err  Obit error stack object. Returns: pointer to the new object.

ObitSkyModelVM* ObitSkyModelVMCreate (  gchar *  name, ObitImageMosaic *  mosaic )

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

gconstpointer ObitSkyModelVMGetClass (  void   )

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

void ObitSkyModelVMGetInput (  ObitSkyModel *  inn, ObitErr *  err )

Public: Get Inputs. Parameters: inn  Pointer to the ObitSkyModelVM . err  Obit error stack object.

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

Public: initialize ObitSkyModelVM structures. Recurses through inheritence heirarchy Parameters: inn  SkyModel to initialize uvdata  uv data being modeled. err  Obit error stack object. Returns: the new object.

void ObitSkyModelVMInitModel (  ObitSkyModel *  inn, ObitErr *  err )

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

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

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

void ObitSkyModelVMUpdateModel (  ObitSkyModelVM *  in, gfloat  time, gint  suba, ObitUV *  uvdata, ObitErr *  err )

Public: Routine to update model. Parameters: in  SkyModelVM time  current time (d) suba  0-rel subarray number uvdata  uv data being modeled. err  Obit error stack object.

---