ObitDConCleanPxHist.h File Reference

ObitDConCleanPxHist CLEAN image pixel histogram class. More...

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

Go to the source code of this file.

Classes
struct	ObitDConCleanPxHist
	ObitDConCleanPxHist Class structure. More...
struct	ObitDConCleanPxHistClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitDConCleanPxHistUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitDConCleanPxHist returns a ObitDConCleanPxHist*.
#define	ObitDConCleanPxHistRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitDConCleanPxHist.
#define	ObitDConCleanPxHistIsA(in)   ObitIsA (in, ObitDConCleanPxHistGetClass())
	Macro to determine if an object is the member of this or a derived class.
Functions
void	ObitDConCleanPxHistClassInit (void)
	Public: Class initializer.
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.

---

Detailed Description

ObitDConCleanPxHist CLEAN image pixel histogram class.

This class is derived from the Obit class.

Creators and Destructors

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

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

---

Define Documentation

#define ObitDConCleanPxHistIsA (  in   )     ObitIsA (in, ObitDConCleanPxHistGetClass())

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

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

#define ObitDConCleanPxHistUnref (  in   )     ObitUnref (in)

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

---

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 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.

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.

---