ObitOTFDesc.h File Reference

ObitOTFDesc Obit "On the Fly" data descriptor class definition. More...

#include <glib.h>
#include "Obit.h"
#include "ObitErr.h"
#include "ObitImageDesc.h"

Go to the source code of this file.

Classes
struct	ObitOTFDesc
	ObitOTFDesc Class structure. More...
struct	ObitOTFDescClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitOTFDescUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitOTFDesc returns a ObitOTFDesc* (NULL).
#define	ObitOTFDescRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitOTFDesc.
#define	ObitOTFDescIsA(in)   ObitIsA (in, ObitOTFDescGetClass())
	Macro to determine if an object is the member of this or a derived class.
#define	OTF_MAXDIM   7
	maximum data array dimension
#define	OTF_MAX_COL   10
	Maximum number of columns in data.
#define	OTFLEN_VALUE   41
	Maximum length of descriptor string value.
#define	OTFLEN_KEYWORD   21
	Maximum length of descriptor keyword.
Enumerations
enum	obitGBTOTFType {   OBIT_GBTOTF_Unknown = 0, OBIT_GBTOTF_DCR, OBIT_GBTOTF_SP, OBIT_GBTOTF_CCB,   OBIT_GBTOTF_PAR }
	enum for GBT OTF type This specifies the GBT OTF data source More...
Functions
void	ObitOTFDescClassInit (void)
	Public: Class initializer.
ObitOTFDesc *	newObitOTFDesc (gchar *name)
	Public: Constructor.
ObitOTFDesc *	ObitOTFDescCopy (ObitOTFDesc *in, ObitOTFDesc *out, ObitErr *err)
	Public: Copy OTFDesc.
gconstpointer	ObitOTFDescGetClass (void)
	Public: Return class pointer.
void	ObitOTFDescCopyDesc (ObitOTFDesc *in, ObitOTFDesc *out, ObitErr *err)
	Public: Copy descriptive (nonstructural) information.
void	ObitOTFDescIndex (ObitOTFDesc *in)
	Public: Index for easier access.
void	ObitOTFDescDate2JD (const gchar *date, gdouble *JD)
	Public: Convert date string to JD.
void	ObitOTFDescJD2Date (gdouble JD, gchar *date)
	Public: Convert JD to date string.
void	ObitOTFDescType2String (ObitGBTOTFType OTFType, gchar *TString)
	Public: OTF type to string.
ObitGBTOTFType	ObitOTFDescString2Type (gchar *TString)
	Public: OTF string to type.

---

Detailed Description

ObitOTFDesc Obit "On the Fly" data descriptor class definition.

This class is derived from the Obit class. This contains information about the observations and the size and structure of the data.

Usage

Instances can be obtained using the newObitOTFDesc constructor the ObitOTFDescCopy copy constructor or a pointer duplicated using the ObitOTFDescRef function. When an instance is no longer needed, use the ObitOTFDescUnref macro to release it.

---

Define Documentation

#define ObitOTFDescIsA (  in   )     ObitIsA (in, ObitOTFDescGetClass())

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

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

#define ObitOTFDescUnref (  in   )     ObitUnref (in)

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

#define OTF_MAX_COL   10

Maximum number of columns in data.

#define OTF_MAXDIM   7

maximum data array dimension

#define OTFLEN_KEYWORD   21

Maximum length of descriptor keyword.

#define OTFLEN_VALUE   41

Maximum length of descriptor string value.

---

Enumeration Type Documentation

enum obitGBTOTFType

enum for GBT OTF type This specifies the GBT OTF data source Enumeration values: OBIT_GBTOTF_Unknown  Unspecified. OBIT_GBTOTF_DCR  DCR. OBIT_GBTOTF_SP  Spectral processor. OBIT_GBTOTF_CCB  CalTech Continuum Backend. OBIT_GBTOTF_PAR  Penn Array Receiver.

---

Function Documentation

ObitOTFDesc* newObitOTFDesc (  gchar *  name  )

Public: Constructor. Returns: pointer to object created.

void ObitOTFDescClassInit (  void   )

Public: Class initializer.

ObitOTFDesc* ObitOTFDescCopy (  ObitOTFDesc *  in, ObitOTFDesc *  out, ObitErr *  err )

Public: Copy OTFDesc. The output descriptor will have the size and reference pixel modified to reflect selection on the input, i.e. the output descriptor describes the input. Parameters: in  Pointer to object to be copied. out  Pointer to object to be written. If NULL then a new structure is created. err  ObitErr error stack Returns: Pointer to new object.

void ObitOTFDescCopyDesc (  ObitOTFDesc *  in, ObitOTFDesc *  out, ObitErr *  err )

Public: Copy descriptive (nonstructural) information. things that don't define the structure). Parameters: in  Pointer to object to be copied. out  Pointer to object to be written. err  ObitErr error stack

void ObitOTFDescDate2JD (  const gchar *  date, gdouble *  JD )

Public: Convert date string to JD.

gconstpointer ObitOTFDescGetClass (  void   )

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

void ObitOTFDescIndex (  ObitOTFDesc *  in  )

Public: Index for easier access. Parameters: in  Pointer to object.

void ObitOTFDescJD2Date (  gdouble  JD, gchar *  date )

Public: Convert JD to date string. Apdapted from ASM Algorithm no. 199 Parameters: date  [in] Julian date. date  [out] Date string, Must be at least 11 characters.

ObitGBTOTFType ObitOTFDescString2Type (  gchar *  TString  )

Public: OTF string to type. Parameters: OTFType  [in] enum TString  [out] readable representation (8 char)

void ObitOTFDescType2String (  ObitGBTOTFType  OTFType, gchar *  TString )

Public: OTF type to string. Parameters: OTFType  [in] enum TString  [out] readable representation (8 char+NULL)

---