ObitDCon.h File Reference

ObitDCon virtual deconvolution base class. More...

#include "Obit.h"
#include "ObitErr.h"
#include "ObitImageMosaic.h"
#include "ObitDef.h"
#include "ObitClassDef.h"

Go to the source code of this file.

Classes
struct	ObitDCon
	ObitDCon virtual deconvolution base class. More...
struct	ObitDConClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitDConUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitDCon returns a ObitDCon*.
#define	ObitDConRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitDCon.
#define	ObitDConIsA(in)   ObitIsA (in, ObitDConGetClass())
	Macro to determine if an object is the member of this or a derived class.
Typedefs
typedef void(*	ObitDConGetParmsFP )(ObitDCon *in, ObitErr *err)
typedef void(*	ObitDConDeconvolveFP )(ObitDCon *in, ObitErr *err)
Functions
void	ObitDConClassInit (void)
	Public: Class initializer.
ObitDCon *	newObitDCon (gchar *name)
	Public: Default Constructor.
ObitDCon *	ObitDConCreate (gchar *name, ObitImageMosaic *mosaic, ObitErr *err)
	Public: Create/initialize ObitDCon structures.
gconstpointer	ObitDConGetClass (void)
	Public: ClassInfo pointer.
ObitDCon *	ObitDConCopy (ObitDCon *in, ObitDCon *out, ObitErr *err)
	Public: Copy (deep) constructor.
void	ObitDConClone (ObitDCon *in, ObitDCon *out, ObitErr *err)
	Public: Copy structure.
void	ObitDConGetParms (ObitDCon *in, ObitErr *err)
	Public: Get Parameters.
void	ObitDConDeconvolve (ObitDCon *in, ObitErr *err)
	Public: Do deconvolution.

---

Detailed Description

ObitDCon virtual deconvolution base class.

This class is derived from the Obit class.

Actual deconvolution classes are derived from this class

Creators and Destructors

An ObitDCon will usually be created using ObitDConCreate which allows specifying a name for the object as well as other information.

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

---

Define Documentation

#define ObitDConIsA (  in   )     ObitIsA (in, ObitDConGetClass())

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

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

#define ObitDConUnref (  in   )     ObitUnref (in)

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

---

Typedef Documentation

typedef void(* ObitDConDeconvolveFP)(ObitDCon *in, ObitErr *err)

typedef void(* ObitDConGetParmsFP)(ObitDCon *in, ObitErr *err)

---

Function Documentation

ObitDCon* newObitDCon (  gchar *  name  )

Public: Default Constructor. VIRTUAL routine - should never be called - defined for convenience of derived classes Initializes class if needed on first call. Parameters: name  An optional name for the object. Returns: the new object.

void ObitDConClassInit (  void   )

Public: Class initializer.

void ObitDConClone (  ObitDCon *  in, ObitDCon *  out, ObitErr *  err )

Public: Copy structure. Parameters: in  The object to copy out  An existing object pointer for output, must be defined. err  Obit error stack object.

ObitDCon* ObitDConCopy (  ObitDCon *  in, ObitDCon *  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.

ObitDCon* ObitDConCreate (  gchar *  name, ObitImageMosaic *  mosaic, ObitErr *  err )

Public: Create/initialize ObitDCon structures. Parameters: name  An optional name for the object. mosaic  Image mosaic to be deconvolved. Returns: the new object.

void ObitDConDeconvolve (  ObitDCon *  in, ObitErr *  err )

Public: Do deconvolution. Parameters: in  The object to deconvolve err  Obit error stack object.

gconstpointer ObitDConGetClass (  void   )

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

void ObitDConGetParms (  ObitDCon *  in, ObitErr *  err )

Public: Get Parameters. Parameters: in  The CLEAN object as base class err  Obit error stack object.

---