ObitOTFSkyModel.h File Reference

OTF Sky model. 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 "ObitTableSkyModel.h"

Go to the source code of this file.

Classes
struct	ObitOTFSkyModel
	ObitOTFSkyModel Class structure. More...
struct	ObitOTFSkyModelClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitOTFSkyModelUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitOTFSkyModel returns a ObitOTFSkyModel*.
#define	ObitOTFSkyModelRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitOTFSkyModel.
#define	ObitOTFSkyModelIsA(in)   ObitIsA (in, ObitOTFSkyModelGetClass())
	Macro to determine if an object is the member of this or a derived class.
Typedefs
typedef void(*	ObitOTFSkyModelCreateFP )(glong ndetect)
	Typedef for definition of class pointer structure.
Enumerations
enum	obitOTFProj { OBIT_OTF_SIN = 0, OBIT_OTF_ARC, OBIT_OTF_TAN }
	enum for OTF projection types. More...
Functions
void	ObitOTFSkyModelClassInit (void)
	Public : Class initializer.
ObitOTFSkyModel *	newObitOTFSkyModel (gchar *name)
	Public: Default Constructor.
ObitOTFSkyModel *	ObitOTFSkyModelCreate (glong ndetect)
	Public: Create/initialize ObitOTFSkyModel structures.
gconstpointer	ObitOTFSkyModelGetClass (void)
	Public: ClassInfo pointer.
ObitOTFSkyModel *	ObitOTFSkyModelCopy (ObitOTFSkyModel *in, ObitOTFSkyModel *out, ObitErr *err)
	Public: Copy (deep) constructor.
ObitIOCode	ObitOTFSkyModelRead (ObitOTFSkyModel **in, ObitTableSkyModel *table, ObitErr *err)
	Public: Read Table from disk.
ObitIOCode	ObitOTFSkyModelWrite (ObitOTFSkyModel *in, ObitTableSkyModel *table, ObitErr *err)
	Public: Write Table to disk.
ObitOTFProj	ObitOTFSkyModelProj (gchar *string)
	Public: Determine Projection type from a string.

---

Detailed Description

OTF Sky model.

This class is for creating and manipulating sky model objects for OTF data.

Creators and Destructors

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

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

---

Define Documentation

#define ObitOTFSkyModelIsA (  in   )     ObitIsA (in, ObitOTFSkyModelGetClass())

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

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

#define ObitOTFSkyModelUnref (  in   )     ObitUnref (in)

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

---

Typedef Documentation

typedef void(* ObitOTFSkyModelCreateFP)(glong ndetect)

Typedef for definition of class pointer structure.

---

Enumeration Type Documentation

enum obitOTFProj

enum for OTF projection types. Enumeration values: OBIT_OTF_SIN  -SIN projection OBIT_OTF_ARC  -ARC projection OBIT_OTF_TAN  -TAN projection

---

Function Documentation

ObitOTFSkyModel* newObitOTFSkyModel (  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 ObitOTFSkyModelClassInit (  void   )

Public : Class initializer.

ObitOTFSkyModel* ObitOTFSkyModelCopy (  ObitOTFSkyModel *  in, ObitOTFSkyModel *  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.

ObitOTFSkyModel* ObitOTFSkyModelCreate (  glong  ncomp  )

Public: Create/initialize ObitOTFSkyModel structures. Parameters: ncomp  Number of components Returns: the new object.

gconstpointer ObitOTFSkyModelGetClass (  void   )

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

ObitOTFProj ObitOTFSkyModelProj (  gchar *  string  )

Public: Determine Projection type from a string. Parameters: string  string code to test. table  table to write to err  Error stack Returns: return code OBIT_IO_OK => OK

ObitIOCode ObitOTFSkyModelRead (  ObitOTFSkyModel **  in, ObitTableSkyModel *  table, ObitErr *  err )

Public: Read Table from disk. Parameters: in  Sky model to update, if Null, it is created table  table to read from err  Error stack Returns: return code OBIT_IO_OK => OK

ObitIOCode ObitOTFSkyModelWrite (  ObitOTFSkyModel *  in, ObitTableSkyModel *  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

---