ObitDConCleanBmHist.h File Reference

ObitDConCleanBmHist CLEAN beam histogram class. More...

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

Go to the source code of this file.

Classes
struct	ObitDConCleanBmHist
	ObitDConCleanBmHist Class structure. More...
struct	ObitDConCleanBmHistClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitDConCleanBmHistUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitDConCleanBmHist returns a ObitDConCleanBmHist*.
#define	ObitDConCleanBmHistRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitDConCleanBmHist.
#define	ObitDConCleanBmHistIsA(in)   ObitIsA (in, ObitDConCleanBmHistGetClass())
	Macro to determine if an object is the member of this or a derived class.
Functions
void	ObitDConCleanBmHistClassInit (void)
	Public: Class initializer.
ObitDConCleanBmHist *	newObitDConCleanBmHist (gchar *name)
	Public: Default Constructor.
ObitDConCleanBmHist *	ObitDConCleanBmHistCreate (gchar *name, ObitImage *Beam, ObitErr *err)
	Public: Create/initialize ObitDConCleanBmHist structures.
gconstpointer	ObitDConCleanBmHistGetClass (void)
	Public: ClassInfo pointer.
ObitDConCleanBmHist *	ObitDConCleanBmHistCopy (ObitDConCleanBmHist *in, ObitDConCleanBmHist *out, ObitErr *err)
	Public: Copy (deep) constructor.
void	ObitDConCleanBmHistClone (ObitDConCleanBmHist *in, ObitDConCleanBmHist *out, ObitErr *err)
	Public: Copy structure.
void	ObitDConCleanBmHistUpdate (ObitDConCleanBmHist *in, ObitImage *Beam, glong *plane, ObitErr *err)
	Public: Update with new Beam image.
gfloat	ObitDConCleanBmHistPeak (ObitDConCleanBmHist *in, glong radius, ObitErr *err)
	Public: Give maximum abs.

---

Detailed Description

ObitDConCleanBmHist CLEAN beam histogram class.

This class is derived from the Obit class.

This class has information about the maximum sidelobe exterior to a given radius.

Creators and Destructors

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

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

---

Define Documentation

#define ObitDConCleanBmHistIsA (  in   )     ObitIsA (in, ObitDConCleanBmHistGetClass())

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

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

#define ObitDConCleanBmHistUnref (  in   )     ObitUnref (in)

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

---

Function Documentation

ObitDConCleanBmHist* newObitDConCleanBmHist (  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 ObitDConCleanBmHistClassInit (  void   )

Public: Class initializer.

void ObitDConCleanBmHistClone (  ObitDConCleanBmHist *  in, ObitDConCleanBmHist *  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.

ObitDConCleanBmHist* ObitDConCleanBmHistCopy (  ObitDConCleanBmHist *  in, ObitDConCleanBmHist *  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.

ObitDConCleanBmHist* ObitDConCleanBmHistCreate (  gchar *  name, ObitImage *  Beam, ObitErr *  err )

Public: Create/initialize ObitDConCleanBmHist structures. Parameters: name  An optional name for the object. Beam  from which to create object err  Obit error stack object. Returns: the new object.

gconstpointer ObitDConCleanBmHistGetClass (  void   )

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

gfloat ObitDConCleanBmHistPeak (  ObitDConCleanBmHist *  in, glong  radius, ObitErr *  err )

Public: Give maximum abs. abs. value of sidelobe exterior to a given radius. Parameters: in  The Beam histogram object radius  How far from center in cells? (Not radius in the usual sense but a beam patch sense). err  Obit error stack object. Returns: the absolute values of the maximum exterior sidelobe.

void ObitDConCleanBmHistUpdate (  ObitDConCleanBmHist *  in, ObitImage *  Beam, glong *  plane, ObitErr *  err )

Public: Update with new Beam image. Parameters: in  The Beam histogram object plane  1-rel indices on dimensions 3-? Beam  The Beam image err  Obit error stack object.

---