ObitFitRegionList.h File Reference

ObitFitRegionList List of ObitFitRegion for an image. More...

#include "Obit.h"
#include "ObitErr.h"
#include "ObitImage.h"
#include "ObitFitRegion.h"

Go to the source code of this file.

Classes
struct	ObitFitRegionList
	ObitFitRegionList Class structure. More...
struct	ObitFitRegionListClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitFitRegionListUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitFitRegionList returns a ObitFitRegionList*.
#define	ObitFitRegionListRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitFitRegionList.
#define	ObitFitRegionListIsA(in)   ObitIsA (in, ObitFitRegionListGetClass())
	Macro to determine if an object is the member of this or a derived class.
Typedefs
typedef ObitFitRegionList *(*	ObitFitRegionListCreateFP )(gchar *name, ObitImage *image)
	Typedef for definition of class pointer structure.
Functions
void	ObitFitRegionListClassInit (void)
	Public: Class initializer.
ObitFitRegionList *	newObitFitRegionList (gchar *name)
	Public: Default Constructor.
ObitFitRegionList *	ObitFitRegionListCreate (gchar *name, ObitImage *image)
	Public: Create/initialize ObitFitRegionList structures.
gconstpointer	ObitFitRegionListGetClass (void)
	Public: ClassInfo pointer.
void	ObitFitRegionListAppend (ObitFitRegionList *in, ObitFitRegion *reg)
	Public: Append an FitRegion to the list.
void	ObitFitRegionListRemove (ObitFitRegionList *in, ObitFitRegion *reg)
	Public: Remove an ObitFitRegion from the list.
ObitFitRegion *	ObitFitRegionListFind (ObitFitRegionList *in, gchar *name)
	Public: Find item in a list.
void	ObitFitRegionListSubtract (ObitFitRegionList *in, ObitImage *outImage, ObitErr *err)
	Public: Subtract regions from image.

---

Detailed Description

ObitFitRegionList List of ObitFitRegion for an image.

This class is derived from the Obit class.

Creators and Destructors

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

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

---

Define Documentation

#define ObitFitRegionListIsA (  in   )     ObitIsA (in, ObitFitRegionListGetClass())

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

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

#define ObitFitRegionListUnref (  in   )     ObitUnref (in)

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

---

Typedef Documentation

typedef ObitFitRegionList*(* ObitFitRegionListCreateFP)(gchar *name, ObitImage *image)

Typedef for definition of class pointer structure.

---

Function Documentation

ObitFitRegionList* newObitFitRegionList (  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 ObitFitRegionListAppend (  ObitFitRegionList *  in, ObitFitRegion *  reg )

Public: Append an FitRegion to the list. Parameters: in  Object with table to add reg to reg  the element to add. MUST have unique name in list

void ObitFitRegionListClassInit (  void   )

Public: Class initializer.

ObitFitRegionList* ObitFitRegionListCreate (  gchar *  name, ObitImage *  image )

Public: Create/initialize ObitFitRegionList structures. Parameters: name  An optional name for the object. image  ObitImage being described Returns: the new object.

ObitFitRegion* ObitFitRegionListFind (  ObitFitRegionList *  in, gchar *  name )

Public: Find item in a list. Parameters: in  Object with table to search name  Name of region Returns: pointer to Region containing item, NULL if not found.

gconstpointer ObitFitRegionListGetClass (  void   )

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

void ObitFitRegionListRemove (  ObitFitRegionList *  in, ObitFitRegion *  reg )

Public: Remove an ObitFitRegion from the list. Parameters: in  Object with table to remove elem from reg  the element to remove. MUST be in list, unreffed

void ObitFitRegionListSubtract (  ObitFitRegionList *  in, ObitImage *  outImage, ObitErr *  err )

Public: Subtract regions from image. Parameters: in  List of region models in image. outImage  Image to write results into err  Obit Error/message stack

---