ObitAntennaList.h File Reference

ObitAntennaList class definition. More...

#include "Obit.h"
#include "ObitErr.h"
#include "ObitAntenna.h"
#include "ObitSource.h"
#include "ObitDef.h"
#include "ObitClassDef.h"

Go to the source code of this file.

Classes
struct	ObitAntennaList
	ObitAntennaList Class. More...
struct	ObitAntennaListClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitAntennaListUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitAntennaList returns a ObitAntennaList*.
#define	ObitAntennaListRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitAntennaList.
#define	ObitAntennaListIsA(in)   ObitIsA (in, ObitAntennaListGetClass())
	Macro to determine if an object is the member of this or a derived class.
Enumerations
enum	obitUVPolCalType {   OBIT_UVPoln_NoCal, OBIT_UVPoln_Unknown, OBIT_UVPoln_Approx, OBIT_UVPoln_VLBI,   OBIT_UVPoln_ELORI, OBIT_UVPoln_XYLin }
Functions
void	ObitAntennaListClassInit (void)
	Public: Class initializer.
ObitAntennaList *	newObitAntennaList (gchar *name)
	Public: Constructor.
gconstpointer	ObitAntennaListGetClass (void)
	Public: ClassInfo pointer.
ObitAntennaList *	ObitAntennaListCopy (ObitAntennaList *in, ObitAntennaList *out, ObitErr *err)
	Public: Copy constructor.
ObitAntennaList *	ObitAntennaListCreate (gchar *name, glong nant, glong numpolcal)
	Public: Create from value.
ObitUVPolCalType	ObitAntennaListGetPolType (gchar *type)
	Public: Determine polarization calibration type.
gfloat	ObitAntennaListElev (ObitAntennaList *inAList, gint ant, gfloat time, ObitSource *Source)
	Public: Determine antenna elevation.
gfloat	ObitAntennaListParAng (ObitAntennaList *inAList, gint ant, gfloat time, ObitSource *Source)
	Public: Determine antenna Parallactic angle.

---

Detailed Description

ObitAntennaList class definition.

This class is derived from the Obit class.

This class manages lists of antennas.

Usage

Instances can be obtained using the newObitAntennaList constructor, the ObitAntennaListCopy constructor or a pointer duplicated using the ObitAntennaListRef macro. When an instance is no longer needed, use the ObitAntennaListUnref macro to release it.

---

Define Documentation

#define ObitAntennaListIsA (  in   )     ObitIsA (in, ObitAntennaListGetClass())

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

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

#define ObitAntennaListUnref (  in   )     ObitUnref (in)

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

---

Enumeration Type Documentation

enum obitUVPolCalType

Enumeration values: OBIT_UVPoln_NoCal  No polarization calibration. OBIT_UVPoln_Unknown  Unrecognized code. OBIT_UVPoln_Approx  R/L Linear D-term approximation. OBIT_UVPoln_VLBI  R/L Linear D-term approximation for resolved sources. OBIT_UVPoln_ELORI  Elipticity-orientation. OBIT_UVPoln_XYLin  X/Y Linear D-term approximation.

---

Function Documentation

ObitAntennaList* newObitAntennaList (  gchar *  name  )

Public: Constructor. Initializes class if needed on first call. Returns: the new object.

void ObitAntennaListClassInit (  void   )

Public: Class initializer.

ObitAntennaList* ObitAntennaListCopy (  ObitAntennaList *  in, ObitAntennaList *  out, ObitErr *  err )

Public: Copy constructor. 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  Obit error stack object. Returns: pointer to the new object.

ObitAntennaList* ObitAntennaListCreate (  gchar *  name, glong  nant, glong  numpolcal )

Public: Create from value. Parameters: name  An optional name for the object. nant  Number of antennas (actually, the highest Antenna ID). numpolcal  Number of Polarization calibration parameters Returns: the new object.

gfloat ObitAntennaListElev (  ObitAntennaList *  inAList, gint  ant, gfloat  time, ObitSource *  Source )

Public: Determine antenna elevation. Parameters: inAList  Antenna List ant  Antenna number (1-rel) time  Time in Days Source  Source structure Returns: elevation in radians

gconstpointer ObitAntennaListGetClass (  void   )

Public: ClassInfo pointer. Initializes class if needed on first call. Returns: pointer to the class structure.

ObitUVPolCalType ObitAntennaListGetPolType (  gchar *  type  )

Public: Determine polarization calibration type. Parameters: type  Polarization calibration type name Returns: code, OBIT_UVPoln_Unknown -> not recognized, OBIT_UVPoln_NoCal -> no code (no poln cal)

gfloat ObitAntennaListParAng (  ObitAntennaList *  inAList, gint  ant, gfloat  time, ObitSource *  Source )

Public: Determine antenna Parallactic angle. Parameters: inAList  Antenna List ant  Antenna number (1-rel) time  Time in Days Source  Source structure Returns: paralactic angle in radians

---