ObitDConCleanPxHist.c File Reference

ObitDConCleanPxHist class function definitions. More...

#include "ObitDConCleanPxHist.h"
#include "ObitMem.h"

Functions
void	ObitDConCleanPxHistInit (gpointer in)
	Private: Initialize newly instantiated object.
void	ObitDConCleanPxHistClear (gpointer in)
	Private: Deallocate members.
ObitDConCleanPxHist *	newObitDConCleanPxHist (gchar *name)
	Public: Default Constructor.
gconstpointer	ObitDConCleanPxHistGetClass (void)
	Public: ClassInfo pointer.
ObitDConCleanPxHist *	ObitDConCleanPxHistCopy (ObitDConCleanPxHist *in, ObitDConCleanPxHist *out, ObitErr *err)
	Public: Copy (deep) constructor.
void	ObitDConCleanPxHistClone (ObitDConCleanPxHist *in, ObitDConCleanPxHist *out, ObitErr *err)
	Public: Copy structure.
void	ObitDConCleanPxHistUpdate (ObitDConCleanPxHist *in, glong field, glong *plane, ObitImageMosaic *mosaic, ObitDConCleanWindow *window, ObitErr *err)
	Public: Update with new image and window.
glong	ObitDConCleanPxHistNumber (ObitDConCleanPxHist *in, gfloat value, ObitErr *err)
	Public: Tell how many pixels are larger than a given abs.
void	ObitDConCleanPxHistClassInit (void)
	Public: Class initializer.
Variables
glong	histSize = 8192
	Number of cells in histogram.

---

Detailed Description

ObitDConCleanPxHist class function definitions.

This class determines the pixel histogram of an image. This class is derived from the Obit base class.

---

Function Documentation

ObitDConCleanPxHist* newObitDConCleanPxHist (  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 ObitDConCleanPxHistClassInit (  void   )

Public: Class initializer.

void ObitDConCleanPxHistClear (  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 ObitDConCleanPxHist* cast to an Obit*.

void ObitDConCleanPxHistClone (  ObitDConCleanPxHist *  in, ObitDConCleanPxHist *  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.

ObitDConCleanPxHist* ObitDConCleanPxHistCopy (  ObitDConCleanPxHist *  in, ObitDConCleanPxHist *  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.

gconstpointer ObitDConCleanPxHistGetClass (  void   )

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

void ObitDConCleanPxHistInit (  gpointer  inn  )

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

glong ObitDConCleanPxHistNumber (  ObitDConCleanPxHist *  in, gfloat  value, ObitErr *  err )

Public: Tell how many pixels are larger than a given abs. value larger than value. Only pixels inside of the CLEAN window are used. Parameters: in  The Beam histogram object value  The value of interest err  Obit error stack object. Returns: number of pixels of abs value > value

void ObitDConCleanPxHistUpdate (  ObitDConCleanPxHist *  in, glong  field, glong *  plane, ObitImageMosaic *  mosaic, ObitDConCleanWindow *  window, ObitErr *  err )

Public: Update with new image and window. Parameters: in  The Pixel histogram object field  Which field? (1-rel) plane  1-rel indices on dimensions 3-? mosaic  Image Mosaic with images window  Corresponding windows in mosaic images. Only pixels inside of the CLEAN window are used. err  Obit error stack object.

---

Variable Documentation

glong histSize = 8192

Number of cells in histogram.

---