ObitImageSel.h File Reference

ObitImageSel Obit image selection class definition. More...

#include "Obit.h"
#include "ObitErr.h"
#include "ObitInfoList.h"
#include "ObitImageDesc.h"
#include "ObitFArray.h"
#include "ObitDef.h"
#include "ObitClassDef.h"

Go to the source code of this file.

Classes
struct	ObitImageSel
	ObitImageSel Class structure. More...
struct	ObitImageSelClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitImageSelUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitImageSel returns a ObitImageSel* (NULL).
#define	ObitImageSelRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitImageSel.
#define	ObitImageSelIsA(in)   ObitIsA (in, ObitImageSelGetClass())
	Macro to determine if an object is the member of this or a derived class.
#define	IM_MAXDIM   7
	Maximum number of dimensions.
Functions
void	ObitImageSelClassInit (void)
	Public: Class initializer.
ObitImageSel *	newObitImageSel (gchar *name)
	Public: Constructor.
gconstpointer	ObitImageSelGetClass (void)
	Public: Return class pointer.
ObitImageSel *	ObitImageSelCopy (ObitImageSel *in, ObitImageSel *out, ObitErr *err)
	Public: Copy ImageSel.
ObitFArray *	ObitImageSelBuffer (ObitFArray *buffer, ObitImageDesc *desc, ObitImageSel *sel)
	Public: Create/resize buffer for image?
void	ObitImageSelDefault (ObitImageDesc *in, ObitImageSel *sel)
	Public: Enforces defaults in inaxes, blc, trc.
void	ObitImageSelSetDesc (ObitImageDesc *in, ObitImageSel *sel, ObitImageDesc *out, ObitErr *err)
	Public: Applies selection to a Descriptor.

---

Detailed Description

ObitImageSel Obit image selection class definition.

This class is derived from the Obit class.

This contains information about portions of an image selected.

Usage

Instances can be obtained using the newObitImageSel constructor the ObitImageSelCopy copy constructor or a pointer duplicated using the ObitImageSelRef function. When an instance is no longer needed, use the ObitImageSelUnref macro to release it.

---

Define Documentation

#define IM_MAXDIM   7

Maximum number of dimensions.

#define ObitImageSelIsA (  in   )     ObitIsA (in, ObitImageSelGetClass())

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

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

#define ObitImageSelUnref (  in   )     ObitUnref (in)

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

---

Function Documentation

ObitImageSel* newObitImageSel (  gchar *  name  )

Public: Constructor. Returns: pointer to object created.

ObitFArray* ObitImageSelBuffer (  ObitFArray *  buffer, ObitImageDesc *  desc, ObitImageSel *  sel )

Public: Create/resize buffer for image? Parameters: buffer  Preexisting buffer or NULL if none desc  Pointer input descriptor. sel  Image selector. Returns: size in floats needed for I/O.

void ObitImageSelClassInit (  void   )

Public: Class initializer.

ObitImageSel* ObitImageSelCopy (  ObitImageSel *  in, ObitImageSel *  out, ObitErr *  err )

Public: Copy ImageSel. Parameters: in  Pointer to object to be copied. out  Pointer to object to be written. If NULL then a new structure is created. err  ObitErr error stack Returns: Pointer to new object.

void ObitImageSelDefault (  ObitImageDesc *  in, ObitImageSel *  sel )

Public: Enforces defaults in inaxes, blc, trc. Also indexes structure. Parameters: in  Pointer to descriptor. sel  Image selector, blc, trc members changed if needed.

gconstpointer ObitImageSelGetClass (  void   )

Public: Return class pointer. Initializes class if needed on first call. Returns: pointer to the class structure.

void ObitImageSelSetDesc (  ObitImageDesc *  in, ObitImageSel *  sel, ObitImageDesc *  out, ObitErr *  err )

Public: Applies selection to a Descriptor. Parameters: in  Pointer to input descriptor. sel  Image selector, blc, trc members changed if needed. out  Pointer to output descriptor. err  Obit error stack

---