Main Page | Class List | Directories | File List | Class Members | File Members

ObitUVWeight.c File Reference

ObitUVWeight class function definitions. More...

#include "ObitUVWeight.h"

Defines

#define DG2RAD   G_PI / 180.0
 Degrees to radians factor.
#define RAD2DG   180.0 / G_PI
 Radians to degrees factor.
#define ObitUVWeightUnref(in)   ObitUnref (in)
 Macro to unreference (and possibly destroy) an ObitUVWeight returns a ObitUVWeight*.
#define ObitUVWeightRef(in)   ObitRef (in)
 Macro to reference (update reference count) an ObitUVWeight.
#define ObitUVWeightIsA(in)   ObitIsA (in, ObitUVWeightGetClass())
 Macro to determine if an object is the member of this or a derived class.

Functions

void ObitUVWeightInit (gpointer in)
 Private: Initialize newly instantiated object.
void ObitUVWeightClear (gpointer in)
 Private: Deallocate members.
void ObitUVWeightInput (ObitUVWeight *in, ObitUV *uvdata, ObitErr *err)
 Private: Get input parameters from uvdata.
void ObitUVWeightReadUV (ObitUVWeight *in, ObitUV *UVin, ObitErr *err)
 Private: Read uv data accumulating to grid.
void ObitUVWeightWtUV (ObitUVWeight *in, ObitUV *UVin, ObitErr *err)
 Private: Reweight uv data accumulating to grids.
ObitUVWeightnewObitUVWeight (gchar *name)
 Public: Constructor.
gconstpointer ObitUVWeightGetClass (void)
 Public: ClassInfo pointer.
void ObitUVWeightData (ObitUV *uvdata, ObitErr *err)
 Public: Determine weighting and correct an ObitUV.
void ObitUVWeightClassInit (void)
 Public: Class initializer.


Detailed Description

ObitUVWeight class function definitions.

This class is derived from the Obit base class.


Define Documentation

#define DG2RAD   G_PI / 180.0
 

Degrees to radians factor.

#define ObitUVWeightIsA in   )     ObitIsA (in, ObitUVWeightGetClass())
 

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

Macro to reference (update reference count) an ObitUVWeight.

returns a ObitUVWeight*. in = object to reference

#define ObitUVWeightUnref in   )     ObitUnref (in)
 

Macro to unreference (and possibly destroy) an ObitUVWeight returns a ObitUVWeight*.

in = object to unreference

#define RAD2DG   180.0 / G_PI
 

Radians to degrees factor.


Function Documentation

ObitUVWeight* newObitUVWeight gchar *  name  ) 
 

Public: Constructor.

Initializes class if needed on first call.

Parameters:
name An optional name for the object.
Returns:
the new object.

void ObitUVWeightClassInit void   ) 
 

Public: Class initializer.

void ObitUVWeightClear gpointer  inn  ) 
 

Private: Deallocate members.

Does (recursive) deallocation of parent class members. For some reason this wasn't build into the GType class.

Parameters:
inn Pointer to the object to deallocate. Actually it should be an ObitUVWeight* cast to an Obit*.

void ObitUVWeightData ObitUV uvdata,
ObitErr err
 

Public: Determine weighting and correct an ObitUV.

Then the data weights are modified by the weighting function. The control parameters are attached to the ObitInfoList member info on uvdata. See ObitUVWeight class documentation for details

gconstpointer ObitUVWeightGetClass void   ) 
 

Public: ClassInfo pointer.

Returns:
pointer to the class structure.

void ObitUVWeightInit gpointer  inn  ) 
 

Private: Initialize newly instantiated object.

Parent classes portions are (recursively) initialized first

Parameters:
inn Pointer to the object to initialize.

void ObitUVWeightInput ObitUVWeight in,
ObitUV uvdata,
ObitErr err
 

Private: Get input parameters from uvdata.

The control parameters are attached to the ObitInfoList member info on uvdata. See ObitUVWeight Class documentation for details.

Parameters:
uvdata ObitUV whose data is to be weighted.
err ObitErr stack for reporting problems.

void ObitUVWeightReadUV ObitUVWeight in,
ObitUV UVin,
ObitErr err
 

Private: 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 #ObitUVWeightCreate. The gridding information should have been stored in the ObitInfoList on in:

  • "UVTaper" OBIT_float scalar = UV taper width in kilowavelengths. Default = no taper.
  • "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 #ObitUVWeightSetup for input in.
    err ObitErr stack for reporting problems.

void ObitUVWeightWtUV ObitUVWeight in,
ObitUV UVin,
ObitErr err
 

Private: Reweight uv data accumulating to grids.

Parameters:
in Weighting object.
UVin Uv data object to be corrected.
err ObitErr stack for reporting problems.


Generated on Fri Aug 31 22:13:10 2007 for Obit by  doxygen 1.3.9.1