ObitUVGrid.h File Reference

ObitUVGrid uv data class definition. More...

#include "Obit.h"
#include "ObitErr.h"
#include "ObitThread.h"
#include "ObitInfoList.h"
#include "ObitUV.h"
#include "ObitFArray.h"
#include "ObitCArray.h"
#include "ObitFFT.h"
#include "ObitDef.h"
#include "ObitClassDef.h"

Go to the source code of this file.

Classes
struct	ObitUVGrid
	ObitUVGrid Class structure. More...
struct	ObitUVGridClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitUVGridUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitUVGrid returns a ObitUVGrid*.
#define	ObitUVGridRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitUVGrid.
#define	ObitUVGridIsA(in)   ObitIsA (in, ObitUVGridGetClass())
	Macro to determine if an object is the member of this or a derived class.
Typedefs
typedef void(*	ObitUVGridSetupFP )(ObitUVGrid *in, ObitUV *UVin, ObitImageDesc *imageDesc, gboolean doBeam, ObitErr *err)
	Typedef for definition of class pointer structure.
typedef ObitIOCode(*	ObitUVGridReadUVFP )(ObitUVGrid *in, ObitUV *UVin, ObitErr *err)
typedef void(*	ObitUVGridFFT2ImFP )(ObitUVGrid *in, ObitFArray *array, ObitErr *err)
Functions
void	ObitUVGridClassInit (void)
	Public: Class initializer.
ObitUVGrid *	newObitUVGrid (gchar *name)
	Public: Constructor.
gconstpointer	ObitUVGridGetClass (void)
	Public: ClassInfo pointer.
void	ObitUVGridSetup (ObitUVGrid *in, ObitUV *UVin, ObitImageDesc *beamDesc, ObitImageDesc *imageDesc, gboolean doBeam, ObitErr *err)
	Public: initialize/reset ObitUVGrid structures.
void	ObitUVGridReadUV (ObitUVGrid *in, ObitUV *UVin, ObitErr *err)
	Public: Read uv data accumulating to grid.
void	ObitUVGridFFT2Im (ObitUVGrid *in, ObitFArray *array, ObitErr *err)
	Public: FFT grid to image plane with gridding correction.

---

Detailed Description

ObitUVGrid uv data class definition.

This class is derived from the Obit class.

This class is for creating and manipulating a UVGrid as a memory resident intermediate entity between ObitUV and ObitImage classes. The beam corresponding to each image should be made first using the same ObitUVGrid.

Creators and Destructors

An ObitUVGrid can be created using newObitUVGrid which allows specifying a name for the object. This name is used to label messages.

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

---

Define Documentation

#define ObitUVGridIsA (  in   )     ObitIsA (in, ObitUVGridGetClass())

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

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

#define ObitUVGridUnref (  in   )     ObitUnref (in)

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

---

Typedef Documentation

typedef void(* ObitUVGridFFT2ImFP)(ObitUVGrid *in, ObitFArray *array, ObitErr *err)

typedef ObitIOCode(* ObitUVGridReadUVFP)(ObitUVGrid *in, ObitUV *UVin, ObitErr *err)

typedef void(* ObitUVGridSetupFP)(ObitUVGrid *in, ObitUV *UVin, ObitImageDesc *imageDesc, gboolean doBeam, ObitErr *err)

Typedef for definition of class pointer structure.

---

Function Documentation

ObitUVGrid* newObitUVGrid (  gchar *  name  )

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

void ObitUVGridClassInit (  void   )

Public: Class initializer.

void ObitUVGridFFT2Im (  ObitUVGrid *  in, ObitFArray *  array, ObitErr *  err )

Public: FFT grid to image plane with gridding correction. Parameters: in  Object to initialize array  Output image array. err  ObitErr stack for reporting problems.

gconstpointer ObitUVGridGetClass (  void   )

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

void ObitUVGridReadUV (  ObitUVGrid *  in, ObitUV *  UVin, ObitErr *  err )

Public: Read uv data accumulating to grid. Buffering of data will use the buffers as defined on UVin ("nVisPIO" in info member). The UVin object will be closed at the termination of this routine. Requires setup by #ObitUVGridCreate. The gridding information should have been stored in the ObitInfoList on in: "Guardband" OBIT_float scalar = maximum fraction of U or v range allowed in grid. Default = 0.4. "MaxBaseline" OBIT_float scalar = maximum baseline length in wavelengths. Default = 1.0e15. "startChann" OBIT_int scalar = first channel (1-rel) in uv data to grid. Default = 1. "numberChann" OBIT_int scalar = number of channels in uv data to grid. Default = all. Parameters: in  Object to initialize UVin  Uv data object to be gridded. Should be the same as passed to previous call to ObitUVGridSetup for input in. err  ObitErr stack for reporting problems.

void ObitUVGridSetup (  ObitUVGrid *  in, ObitUV *  UVin, ObitImageDesc *  beamDesc, ObitImageDesc *  imageDesc, gboolean  doBeam, ObitErr *  err )

Public: initialize/reset ObitUVGrid structures. Input data should be fully edited and calibrated, with any weighting applied and converted to the appropriate Stokes type. The object UVin will be opened during this call if it is not already open. The output image should describe the center, size and grid spacing of the desired image. The beam corresponding to each image should be made first using the same ObitUVGrid. Parameters: in  Object to initialize UVin  Uv data object to be gridded. beamDesc  Descriptor for beam to be derived. imageDesc  Descriptor for image to be derived. doBeam  TRUE is this is a Beam. err  ObitErr stack for reporting problems.

---