ObitImageDesc.h File Reference

ObitImageDesc Obit Image descriptor class definition. More...

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

Go to the source code of this file.

Classes
struct	ObitImageDesc
	ObitImageDesc Class structure. More...
struct	ObitImageDescClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitImageDescUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitImageDesc returns a ObitImageDesc* (NULL).
#define	ObitImageDescRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitImageDesc.
#define	ObitImageDescIsA(in)   ObitIsA (in, ObitImageDescGetClass())
	Macro to determine if an object is the member of this or a derived class.
#define	IM_MAXDIM   7
	Maximum number of dimensions.
#define	IMLEN_VALUE   41
	Maximum length of descriptor string value.
#define	IMLEN_KEYWORD   21
	Maximum length of descriptor keyword.
Enumerations
enum	obitCoordType { OBIT_Equatorial, OBIT_Galactic, OBIT_Ecliptic }
	enum for coordinate system types (Equatorial, Galactic, Ecliptic) More...
Functions
void	ObitImageDescClassInit (void)
	Public: Class initializer.
ObitImageDesc *	newObitImageDesc (gchar *name)
	Public: Constructor.
gconstpointer	ObitImageDescGetClass (void)
	Public: Return class pointer.
ObitImageDesc *	ObitImageDescCopy (ObitImageDesc *in, ObitImageDesc *out, ObitErr *err)
	Public: Copy ImageDesc.
void	ObitImageDescCopyDesc (ObitImageDesc *in, ObitImageDesc *out, ObitErr *err)
	Public: Copy descriptive (nonstructural) information.
ObitImageDesc *	ObitImageDescDefault (gchar *name)
	Public: Default ImageDesc.
void	ObitImageDescCo (ObitImageDesc *in, ObitImageDesc *out, ObitErr *err)
	Public: Transform pixel in one image to another.
void	ObitImageDescIndex (ObitImageDesc *in)
	Public: Index for easier access.
gboolean	ObitImageDescCvtPixel (ObitImageDesc *in, ObitImageDesc *out, gfloat *inPixel, gfloat *outPixel, ObitErr *err)
	Public: Convert pixels on one image to those in another.
gboolean	ObitImageDescCvtZern (ObitImageDesc *in, ObitImageDesc *out, gint nZern, gfloat *ZCoef, gfloat *inPixel, gfloat *outPixel, ObitErr *err)
	Public: Convert pixels on one image to those in another with Zernike corrections.
void	ObitImageDescGetPos (ObitImageDesc *in, gfloat *inPixel, gdouble *pos, ObitErr *err)
	Public: Determine the location of a pixel in an image.
void	ObitImageDescGetPixel (ObitImageDesc *in, gdouble *pos, gfloat *outPixel, ObitErr *err)
	Public: Determine the pixel of a location in an image.
gboolean	ObitImageDescOverlap (ObitImageDesc *in1, ObitImageDesc *in2, ObitErr *err)
	Public: Is there overlap in two images.
gfloat	ObitImageDescRotate (ObitImageDesc *in)
	Public: Tell rotation angle of image.
void	ObitImageDescGetPoint (ObitImageDesc *in, gdouble *RAPnt, gdouble *DecPnt)
	Public: Tell Pointing position.
gfloat	ObitImageDescAngle (ObitImageDesc *in, gfloat y, gfloat x)
	Public: Determine the angular distance to the antenna pointing position.

---

Detailed Description

ObitImageDesc Obit Image descriptor class definition.

This class is derived from the Obit class.

This contains information about the observations and the size and coordinates in the image. Also included are the current location of the image in an ObitImage image buffer and the specified subimaging parameters.

Usage

Instances can be obtained using the newObitImageDesc constructor the ObitImageDescCopy copy constructor or a pointer duplicated using the ObitImageDescRef function. When an instance is no longer needed, use the ObitImageDescUnref macro to release it.

---

Define Documentation

#define IM_MAXDIM   7

Maximum number of dimensions.

#define IMLEN_KEYWORD   21

Maximum length of descriptor keyword.

#define IMLEN_VALUE   41

Maximum length of descriptor string value.

#define ObitImageDescIsA (  in   )     ObitIsA (in, ObitImageDescGetClass())

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

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

#define ObitImageDescUnref (  in   )     ObitUnref (in)

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

---

Enumeration Type Documentation

enum obitCoordType

enum for coordinate system types (Equatorial, Galactic, Ecliptic) Enumeration values: OBIT_Equatorial  Equatorial (RA, Dec). OBIT_Galactic  Galactic (GLONG, GLAT). OBIT_Ecliptic  Ecliptic (ELONG, ELAT).

---

Function Documentation

ObitImageDesc* newObitImageDesc (  gchar *  name  )

Public: Constructor. Parameters: name  Optional name for object, NULL = don't use Returns: pointer to object created.

gfloat ObitImageDescAngle (  ObitImageDesc *  in, gfloat  y, gfloat  x )

Public: Determine the angular distance to the antenna pointing position. Parameters: in  Image descriptor x  X offset in deg from ref pixel in in This should be in the same system and equinox as in in. y  Y offset in deg from ref pixel in in err  Error stack, returns if not empty. Returns: angular distance on the sky (deg)

void ObitImageDescClassInit (  void   )

Public: Class initializer.

void ObitImageDescCo (  ObitImageDesc *  in, ObitImageDesc *  out, ObitErr *  err )

Public: Transform pixel in one image to another.

ObitImageDesc* ObitImageDescCopy (  ObitImageDesc *  in, ObitImageDesc *  out, ObitErr *  err )

Public: Copy ImageDesc. The output descriptor will have the size and reference pixel modified to reflect subimaging on the input, i.e. the output descriptor describes the input after being read. 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 ObitImageDescCopyDesc (  ObitImageDesc *  in, ObitImageDesc *  out, ObitErr *  err )

Public: Copy descriptive (nonstructural) information. things that don't define the structure). Parameters: in  Pointer to object to be copied. out  Pointer to object to be written. err  ObitErr error stack

gboolean ObitImageDescCvtPixel (  ObitImageDesc *  in, ObitImageDesc *  out, gfloat *  inPixel, gfloat *  outPixel, ObitErr *  err )

Public: Convert pixels on one image to those in another. Parameters: in  input image descriptor out  output image descriptor inPixel  Pixel location in input image outPixel  [out] Pixel location in input image err  ObitErr error stack Returns: TRUE if outPixel is in out, else FALSE

gboolean ObitImageDescCvtZern (  ObitImageDesc *  in, ObitImageDesc *  out, gint  nZern, gfloat *  ZCoef, gfloat *  inPixel, gfloat *  outPixel, ObitErr *  err )

Public: Convert pixels on one image to those in another with Zernike corrections. Parameters: in  input image descriptor out  output image descriptor nZern  Number of Zernike terms, can handle up to 17 ZCoef  Array of Zernike coefficients (piston ignored) inPixel  Pixel location in input image outPixel  [out] Pixel location in input image err  ObitErr error stack Returns: TRUE if outPixel is in out, else FALSE

ObitImageDesc* ObitImageDescDefault (  gchar *  name  )

Public: Default ImageDesc. Default is a 1 x 1 floating array Parameters: name  Optional name for object, NULL = don't use Returns: Pointer to new object.

gconstpointer ObitImageDescGetClass (  void   )

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

void ObitImageDescGetPixel (  ObitImageDesc *  in, gdouble *  pos, gfloat *  outPixel, ObitErr *  err )

Public: Determine the pixel of a location in an image. to pixel inPixel in image described by in. Parameters: in  input image descriptor pos  celestial coordinate (RA, dec in deg) outPixel  [out] Pixel location in input image err  ObitErr error stack

void ObitImageDescGetPoint (  ObitImageDesc *  in, gdouble *  RAPnt, gdouble *  DecPnt )

Public: Tell Pointing position. If observed value given in in (not both 0), these are returned, else the reference position. Parameters: in  Image descriptor [out]  RAPnt  Observed RA (deg) [out]  DecPnt  Observed Dec (deg)

void ObitImageDescGetPos (  ObitImageDesc *  in, gfloat *  inPixel, gdouble *  pos, ObitErr *  err )

Public: Determine the location of a pixel in an image. Parameters: in  input image descriptor inPixel  Pixel location in input image pos  [out] celestial coordinate (RA, dec in deg) err  ObitErr error stack

void ObitImageDescIndex (  ObitImageDesc *  in  )

Public: Index for easier access. Parameters: in  Pointer to object.

gboolean ObitImageDescOverlap (  ObitImageDesc *  in1, ObitImageDesc *  in2, ObitErr *  err )

Public: Is there overlap in two images. a pair of image descriptors Tes if if the difference in ra and dec is less than the sum of the halfwidths. Nonlinearities of coordinates ignored but test is somewhat generous. Parameters: in1  first input image descriptor in2  second input image descriptor err  ObitErr error stack Returns: TRUE if there is overlap, else FALSE

gfloat ObitImageDescRotate (  ObitImageDesc *  imDesc  )

Public: Tell rotation angle of image. Parameters: imDesc  Image descriptor Returns: rotation angle on sky (of u,v,w) in deg.

---