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

ObitOTFArrayGeom.h File Reference

GBT/OTF feed geometry. More...

#include <string.h>
#include <stdio.h>
#include <stdlib.h>
#include <math.h>
#include <glib.h>
#include "Obit.h"
#include "ObitErr.h"
#include "ObitThread.h"
#include "ObitInfoList.h"
#include "ObitOTFSkyModel.h"
#include "ObitOTFDesc.h"
#include "ObitTableOTFArrayGeom.h"

Go to the source code of this file.

Classes

struct  ObitOTFArrayGeom
 ObitOTFArrayGeom Class structure. More...
struct  ObitOTFArrayGeomClassInfo
 ClassInfo Structure. More...

Defines

#define ObitOTFArrayGeomUnref(in)   ObitUnref (in)
 Macro to unreference (and possibly destroy) an ObitOTFArrayGeom returns a ObitOTFArrayGeom*.
#define ObitOTFArrayGeomRef(in)   ObitRef (in)
 Macro to reference (update reference count) an ObitOTFArrayGeom.
#define ObitOTFArrayGeomIsA(in)   ObitIsA (in, ObitOTFArrayGeomGetClass())
 Macro to determine if an object is the member of this or a derived class.

Typedefs

typedef void(* ObitOTFArrayGeomCreateFP )(glong ndetect)
 Typedef for definition of class pointer structure.

Functions

void ObitOTFArrayGeomClassInit (void)
 Publi: Class initializer.
ObitOTFArrayGeomnewObitOTFArrayGeom (gchar *name)
 Public: Default Constructor.
ObitOTFArrayGeomObitOTFArrayGeomCreate (glong ndetect)
 Public: Create/initialize ObitOTFArrayGeom structures.
gconstpointer ObitOTFArrayGeomGetClass (void)
 Public: ClassInfo pointer.
ObitOTFArrayGeomObitOTFArrayGeomCopy (ObitOTFArrayGeom *in, ObitOTFArrayGeom *out, ObitErr *err)
 Public: Copy (deep) constructor.
ObitOTFArrayGeomObitOTFArrayGeomAver (ObitOTFArrayGeom *in, ObitOTFDesc *inDesc, ObitOTFArrayGeom *out, ObitOTFDesc *outDesc, ObitErr *err)
 Public: Copy (deep) constructor averaging over frequency .
ObitIOCode ObitOTFArrayGeomRead (ObitOTFArrayGeom **in, ObitTableOTFArrayGeom *table, ObitErr *err)
 Public: Read Table from disk.
ObitIOCode ObitOTFArrayGeomWrite (ObitOTFArrayGeom *in, ObitTableOTFArrayGeom *table, ObitErr *err)
 Public: Write Table to disk.
gfloat ObitOTFArrayGeomParAng (ObitOTFArrayGeom *in, gfloat time, gfloat ra, gfloat dec)
 Public: Get Parallactic angle for a given time and direction.
gfloat ObitOTFArrayGeomElev (ObitOTFArrayGeom *in, gfloat time, gfloat ra, gfloat dec)
 Public: Get Elevation for a given time and direction.
void ObitOTFArrayGeomCoord (ObitOTFArrayGeom *in, gfloat raPoint, gfloat decPoint, gfloat rot, gfloat *x, gfloat *y)
 Public: Get detector coordinates on sky.
void ObitOTFArrayGeomProj (ObitOTFArrayGeom *in, gfloat raPoint, gfloat decPoint, gfloat rot, gfloat raProj, gfloat decProj, ObitOTFProj Proj, gfloat *x, gfloat *y)
 Public: Get detector locations projected onto a plane.
void ObitOTFArrayGeomCorrPoint (gfloat azOff, gfloat elOff, gfloat pa, gfloat *raPoint, gfloat *decPoint)
 Public: Offset a celestial position in az, el.


Detailed Description

GBT/OTF feed geometry.

This class is for creating and manipulating Array geometry description objects for OTF data for the GBT

Creators and Destructors

An ObitOTFArrayGeom will usually be created using ObitOTFArrayGeomCreate which allows specifying a name for the object as well as dimensionality of the array.

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


Define Documentation

#define ObitOTFArrayGeomIsA in   )     ObitIsA (in, ObitOTFArrayGeomGetClass())
 

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

Macro to reference (update reference count) an ObitOTFArrayGeom.

returns a ObitOTFArrayGeom*. in = object to reference

#define ObitOTFArrayGeomUnref in   )     ObitUnref (in)
 

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

in = object to unreference


Typedef Documentation

typedef void(* ObitOTFArrayGeomCreateFP)(glong ndetect)
 

Typedef for definition of class pointer structure.


Function Documentation

ObitOTFArrayGeom* newObitOTFArrayGeom gchar *  name  ) 
 

Public: Default Constructor.

Initializes class if needed on first call.

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

ObitOTFArrayGeom* ObitOTFArrayGeomAver ObitOTFArrayGeom in,
ObitOTFDesc inDesc,
ObitOTFArrayGeom out,
ObitOTFDesc outDesc,
ObitErr *  err
 

Public: Copy (deep) constructor averaging over frequency .

Parameters:
in The object to copy
inDesc OTFdescriptor for in
out An existing object pointer for output or NULL if none exists.
outDesc OTFdescriptor for out
err Obit error stack object.
Returns:
pointer to the new object.

void ObitOTFArrayGeomClassInit void   ) 
 

Publi: Class initializer.

void ObitOTFArrayGeomCoord ObitOTFArrayGeom in,
gfloat  raPoint,
gfloat  decPoint,
gfloat  rot,
gfloat *  x,
gfloat *  y
 

Public: Get detector coordinates on sky.

Parameters:
in Array geometry
raPoint Telescope pointing RA (deg)
decPoint Telescope pointing Declination (deg)
rot Array rotation (parallactic angle ) (deg)
x Array of output RAs (deg). allocated in calling routine, must be at least in->numberDetect.
y Array of output Decs.

ObitOTFArrayGeom* ObitOTFArrayGeomCopy ObitOTFArrayGeom in,
ObitOTFArrayGeom 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.

void ObitOTFArrayGeomCorrPoint gfloat  azOff,
gfloat  elOff,
gfloat  pa,
gfloat *  raPoint,
gfloat *  decPoint
 

Public: Offset a celestial position in az, el.

Parameters:
azOff azimuth ( xcos el) in deg.
eloff elevation offset in deg
pa parallactic angle (+any feed rotation)
raPoint Telescope pointing RA (deg), returned corrected
decPoint Telescope pointing Declination (deg) returned corrected

ObitOTFArrayGeom* ObitOTFArrayGeomCreate glong  ndetect  ) 
 

Public: Create/initialize ObitOTFArrayGeom structures.

Parameters:
ndetect Number of detectors in array
Returns:
the new object.

gfloat ObitOTFArrayGeomElev ObitOTFArrayGeom in,
gfloat  time,
gfloat  ra,
gfloat  dec
 

Public: Get Elevation for a given time and direction.

Parameters:
in Array geometry to write
time Time (days)
ra RA (deg)
dec Declination (deg)
Returns:
elevation angle in degrees ).

gconstpointer ObitOTFArrayGeomGetClass void   ) 
 

Public: ClassInfo pointer.

Returns:
pointer to the class structure.

gfloat ObitOTFArrayGeomParAng ObitOTFArrayGeom in,
gfloat  time,
gfloat  ra,
gfloat  dec
 

Public: Get Parallactic angle for a given time and direction.

Parameters:
in Array geometry to write
time Time (days)
ra RA (deg)
dec Declination (deg)
Returns:
parallactic angle in degrees ).

void ObitOTFArrayGeomProj ObitOTFArrayGeom in,
gfloat  raPoint,
gfloat  decPoint,
gfloat  rot,
gfloat  raProj,
gfloat  decProj,
ObitOTFProj  Proj,
gfloat *  x,
gfloat *  y
 

Public: Get detector locations projected onto a plane.

Parameters:
in Array geometry
raPoint Telescope pointing RA (deg)
decPoint Telescope pointing Declination (deg)
rot Array rotation (parallactic angle ) (deg)
raProj Central RA of desired projection (deg)
decProj Central Dec of desired projection (deg)
Proj enum defining which projection OBIT_OTF_SIN, OBIT_OTF_ARC, OBIT_OTF_TAN
x Array of output "X" offsets (deg) on projected plane allocated in calling routine, must be at least in->numberDetect.
y Array of output "Y" offsets (deg) on projected plane

ObitIOCode ObitOTFArrayGeomRead ObitOTFArrayGeom **  in,
ObitTableOTFArrayGeom table,
ObitErr *  err
 

Public: Read Table from disk.

Parameters:
in Array geometry to update, if (*in) Null, it is created
table table to read from
err Error stack
Returns:
return code OBIT_IO_OK => OK

ObitIOCode ObitOTFArrayGeomWrite ObitOTFArrayGeom in,
ObitTableOTFArrayGeom table,
ObitErr *  err
 

Public: Write Table to disk.

Parameters:
in Array geometry to write
table table to write to
err Error stack
Returns:
return code OBIT_IO_OK => OK


Generated on Mon Sep 3 20:43:53 2007 by  doxygen 1.3.9.1