ObitDConCleanBmHist.c File Reference

ObitDConCleanBmHist class function definitions. More...

#include "ObitDConCleanBmHist.h"
#include "ObitMem.h"

Functions
void	ObitDConCleanBmHistInit (gpointer in)
	Private: Initialize newly instantiated object.
void	ObitDConCleanBmHistClear (gpointer in)
	Private: Deallocate members.
ObitDConCleanBmHist *	newObitDConCleanBmHist (gchar *name)
	Public: Default Constructor.
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.
ObitDConCleanBmHist *	ObitDConCleanBmHistCreate (gchar *name, ObitImage *Beam, ObitErr *err)
	Public: Create/initialize ObitDConCleanBmHist structures.
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.
void	ObitDConCleanBmHistClassInit (void)
	Public: Class initializer.

---

Detailed Description

ObitDConCleanBmHist class function definitions.

This class determines the maximum beam sidelobe exterior to a given x or y distance. This class is derived from the Obit base class.

---

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 ObitDConCleanBmHistClear (  gpointer  inn  )

Private: Deallocate members. Does (recursive) deallocation of parent class members. Parameters: inn  Pointer to the object to deallocate. Actually it should be an ObitDConCleanBmHist* cast to an Obit*.

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.

void ObitDConCleanBmHistInit (  gpointer  inn  )

Private: Initialize newly instantiated object. Parent classes portions are (recursively) initialized first Parameters: inn  Pointer to the object to initialize.

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.

---