ObitImageMosaic.h File Reference

ObitImageMosaic class definition. More...

#include "Obit.h"
#include "ObitErr.h"
#include "ObitThread.h"
#include "ObitInfoList.h"
#include "ObitIO.h"
#include "ObitImage.h"
#include "ObitTableCC.h"
#include "ObitDef.h"
#include "ObitClassDef.h"

Go to the source code of this file.

Classes
struct	ObitImageMosaic
	ObitImageMosaic Class structure. More...
struct	ObitImageMosaicClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitImageMosaicUnref(in)   ObitUnref ( in)
	Macro to unreference (and possibly destroy) an ObitImageMosaic returns a ObitImageMosaic*.
#define	ObitImageMosaicRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitImageMosaic.
#define	ObitImageMosaicIsA(in)   ObitIsA (in, ObitImageMosaicGetClass())
	Macro to determine if an object is the member of this or a derived class.
Functions
void	ObitImageMosaicClassInit (void)
	Public: Class initializer.
ObitImageMosaic *	newObitImageMosaic (gchar *name, gint number)
	Public: Constructor.
gconstpointer	ObitImageMosaicGetClass (void)
	Public: ClassInfo pointer.
ObitImageMosaic *	ObitImageMosaicCopy (ObitImageMosaic *in, ObitImageMosaic *out, ObitErr *err)
	Public: Copy (shallow) constructor.
void	ObitImageMosaicZapImage (ObitImageMosaic *in, gint number, ObitErr *err)
	Public: Zap specified image.
ObitImage *	ObitImageMosaicGetImage (ObitImageMosaic *in, gint number, ObitErr *err)
	Public: Return specified image.
void	ObitImageMosaicSetImage (ObitImageMosaic *in, gint number, ObitImage *image, ObitErr *err)
	Public: Set specified image.
gfloat	ObitImageMosaicGetImageRMS (ObitImageMosaic *in, gint number, ObitErr *err)
	Public: Return RMS pixel value of image.
ObitImage *	ObitImageMosaicGetFullImage (ObitImageMosaic *in, ObitErr *err)
	Public: return Full Field image image.
void	ObitImageMosaicSetFullImage (ObitImageMosaic *in, ObitImage *image, ObitErr *err)
	Public: Set Full Field image.
void	ObitImageMosaicSetFiles (ObitImageMosaic *in, gboolean doBeam, ObitErr *err)
	Public: Set underlying files.
ObitImageMosaic *	ObitImageMosaicCreate (gchar *name, ObitUV *uvData, ObitErr *err)
	Public: Create Mosaic from uv data.
void	ObitImageMosaicDefine (ObitImageMosaic *in, ObitUV *uvData, gboolean doBeam, ObitErr *err)
	Public: Define parameters of images.
void	ObitImageMosaicFlatten (ObitImageMosaic *in, ObitErr *err)
	Public: Flatten tiles onto full field image.
gfloat	ObitImageMosaicFOV (ObitImageMosaic *in, ObitErr *err)
	Public: Give field of view.
gboolean	ObitImageMosaicReimage (ObitImageMosaic *mosaic, ObitErr *err)
	Public: Reimaging needed to center strong source on pixel?
void	ObitImageMosaicMaxCC (ObitTableCC *CCTab, gint nccpos, gfloat radius, gfloat *maxcmp, gfloat *xcenter, gfloat *ycenter, gfloat *xoff, gfloat *yoff, ObitErr *err)
	Public: Get max summed CC and determine offset from nearest pixel.
void	ObitImageMosaicFlagCC (ObitTableCC *CCTab, gint nccpos, gfloat radius, gfloat xcenter, gfloat ycenter, ObitErr *err)
	Public: Zero selected CC entries.
void	ObitImageMosaicAddField (ObitImageMosaic *in, ObitUV *uvData, gint nx, gint ny, gint nplane, gfloat RAShift, gfloat DecShift, ObitErr *err)
	Public: Add field to mosaic.
ObitImageMosaic *	ObitImageMosaicMaxField (ObitImageMosaic *mosaic, gfloat MinFlux, gint *ignore, gint *field, ObitErr *err)
	Public: Generate a mosaic for peeling.

---

Detailed Description

ObitImageMosaic class definition.

This class is derived from the Obit class.

This class contains an array of astronomical images and allows access. An ObitImageMosaic is the front end to persistent disk resident structures. An ObitImageMosaic is an array of associated images, generally intended to cover a region of the sky. Access to members is via the member's functions. Both FITS and AIPS cataloged images are supported.

Creators and Destructors

An ObitImageMosaic can be created using newObitImageMosaic which allows specifying a name for the object. This name is used to label messages. The copy constructor ObitImageMosaicCopy will make a shallow copy of an extant ObitImageMosaic.

A copy of a pointer to an ObitImageMosaic should always be made using the ObitImageMosaicRef function which updates the reference count in the object. Then whenever freeing an ObitImageMosaic or changing a pointer, the function ObitImageMosaicUnref will decrement the reference count and destroy the object when the reference count hits 0.

---

Define Documentation

#define ObitImageMosaicIsA (  in   )     ObitIsA (in, ObitImageMosaicGetClass())

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

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

#define ObitImageMosaicUnref (  in   )     ObitUnref ( in)

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

---

Function Documentation

ObitImageMosaic* newObitImageMosaic (  gchar *  name, gint  number )

Public: Constructor. Initializes class if needed on first call. Parameters: name  An optional name for the object. Returns: the new object.

void ObitImageMosaicAddField (  ObitImageMosaic *  in, ObitUV *  uvData, gint  nx, gint  ny, gint  nplane, gfloat  RAShift, gfloat  DecShift, ObitErr *  err )

Public: Add field to mosaic. Parameters: in  The object with images uvData  UV data from which the images are to be made. nx  Number of pixels in X for image, will be converted to next larger good FFT size. ny  Number of pixels in Y for image nplane  Number of planes for image RAShift  RA shift (asec) for image DecShift  Dec shift (asec) for image err  Error stack, returns if not empty.

void ObitImageMosaicClassInit (  void   )

Public: Class initializer.

ObitImageMosaic* ObitImageMosaicCopy (  ObitImageMosaic *  in, ObitImageMosaic *  out, ObitErr *  err )

Public: Copy (shallow) constructor. Parent class members are included but any derived class info is ignored. Parameters: in  The object to copy out  An existing object pointer for output or NULL if none exists. err  Error stack, returns if not empty. Returns: pointer to the new object.

ObitImageMosaic* ObitImageMosaicCreate (  gchar *  name, ObitUV *  uvData, ObitErr *  err )

Public: Create Mosaic from uv data. Parameters: name  Name to be given to new object uvData  The object to create images in, Details are defined in info members: FileType = Underlying file type, OBIT_IO_FITS, OBIT_IO_AIPS Name = Name of image, used as AIPS name or to derive FITS filename Class = Root of class, used as AIPS class or to derive FITS filename Seq = Sequence number Disk = Disk number for underlying files FOV = Field of view (deg) for Mosaic If > 0.0 then a mosaic of images will be added to cover this region. Note: these are in addition to the NField fields added by other parameters doFull = if TRUE, create full field image to cover FOV [def. FALSE] NField = Number of fields defined in input, if unspecified derive from data and FOV "xCells" = Cell spacing in X (asec) for all images, if unspecified derive from data "yCells" = Cell spacing in Y (asec) for all images, if unspecified derive from data "BMAJ" = OBIT_float scalar = Restoring beam major axis (asec) if = 0 then write fitted value to header "BMIN" = OBIT_float scalar = Restoring beam minor axis (asec) "BPA" = OBIT_float scalar = Restoring beam position angle (deg) "Beam" = OBIT_float [3] = (BMAJ, BMIN, BPA) alternate form nx = Minimum number of cells in X for NField images if unspecified derive from data ny = Minimum number of cells in Y for NField images if unspecified derive from data RAShift = Right ascension shift (AIPS convention) for each field if unspecified derive from FOV and data DecShift = Declination for each field if unspecified derive from FOV and data Catalog = AIPSVZ format catalog for defining outliers, 'None'=don't use [default] 'Default' = use default catalog. Assumed in FITSdata disk 1. OutlierDist = Maximum distance (deg) from center to include outlier fields from Catalog. [default 1 deg] OutlierFlux = Minimum estimated flux density include outlier fields from Catalog. [default 0.1 Jy ] OutlierSI = Spectral index to use to convert catalog flux density to observed frequency. [default = -0.75] OutlierSize = Width of outlier field in pixels. [default 50] err  Error stack, returns if not empty. Returns: Newly created object.

void ObitImageMosaicDefine (  ObitImageMosaic *  in, ObitUV *  uvData, gboolean  doBeam, ObitErr *  err )

Public: Define parameters of images. Parameters: in  The object to create images in, Details are defined in members: numberImage - Number of images in Mosaic nInit - number of images already initialized images - Image array xCells - Cell Spacing in X (deg) yCells - Cell Spacing in Y (deg) nx - Number of pixels in X for each image ny - Number of pixels in Y for each image nplane - Number of planes for each image RAShift - RA shift (asec) for each image DecShift - Dec shift (asec) for each image fileType - Are image OBIT_IO_AIPS or OBIT_IO_FITS? imName - Name of Mosaic images imClass - imClass imSeq - imSeq imDisk - imDisk uvData  UV data from which the images are to be made. Imaging information on uvData: "nChAvg" OBIT_int (1,1,1) number of channels to average. This is for spectral line observations and is ignored if the IF axis on the uv data has more than one IF. Default is continuum = average all freq/IFs. 0=> all. "rotate" OBIT_float (?,1,1) Desired rotation on sky (from N thru E) in deg. [0] doBeam  If true, make beam as well. err  Error stack, returns if not empty.

void ObitImageMosaicFlagCC (  ObitTableCC *  CCTab, gint  nccpos, gfloat  radius, gfloat  xcenter, gfloat  ycenter, ObitErr *  err )

Public: Zero selected CC entries. Parameters: CCTab  CC table object to filter. nccpos  Number of CC to consider. radius  Radius within which to consider components. (deg) xcenter  delta X (ra) of brightest pixel (deg) ycenter  delta Y (dec) of brightest pixel (deg) err  Error/message stack

void ObitImageMosaicFlatten (  ObitImageMosaic *  in, ObitErr *  err )

Public: Flatten tiles onto full field image. Parameters: in  The object with images err  Error stack, returns if not empty.

gfloat ObitImageMosaicFOV (  ObitImageMosaic *  in, ObitErr *  err )

Public: Give field of view. Parameters: in  The object with images err  Error stack, returns if not empty. Returns: the full width of the field of view in deg.

gconstpointer ObitImageMosaicGetClass (  void   )

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

ObitImage* ObitImageMosaicGetFullImage (  ObitImageMosaic *  in, ObitErr *  err )

Public: return Full Field image image. Returned reference has been Refed. Parameters: in  The array of images err  Error stack, returns if not empty. Returns: pointer to the selected image. NULL on failure.

ObitImage* ObitImageMosaicGetImage (  ObitImageMosaic *  in, gint  number, ObitErr *  err )

Public: Return specified image. Returned reference has been Refed. Parameters: in  The array of images number  The 0-rel image number err  Error stack, returns if not empty. Returns: pointer to the selected image. NULL on failure.

gfloat ObitImageMosaicGetImageRMS (  ObitImageMosaic *  in, gint  number, ObitErr *  err )

Public: Return RMS pixel value of image. Ignores outer 5 pixel in image. Parameters: in  The array of images number  The 0-rel image number in array image  Image reference to add err  Error stack, returns if not empty.

void ObitImageMosaicMaxCC (  ObitTableCC *  CCTab, gint  nccpos, gfloat  radius, gfloat *  maxcmp, gfloat *  xcenter, gfloat *  ycenter, gfloat *  xoff, gfloat *  yoff, ObitErr *  err )

Public: Get max summed CC and determine offset from nearest pixel. Also determines offset of peak from the central by a moment analysis. Routine translated from the AIPSish VLAUTIL.FOR/VLMXCC Parameters: CCTab  CC table object to filter. nccpos  Number of CC to consider. radius  Radius within which to consider components. (deg) maxcmp  [out] Maximum summed CC flux in search radius. xcenter  [out] delta X (ra) of brightest pixel (deg) ycenter  [out] delta Y (dec) of brightest pixel (deg) xoff  [out] Offset from central pixel in x (ra) (deg) yoff  [out] Offset from central pixel in y (dec) (deg) err  Error/message stack

ObitImageMosaic* ObitImageMosaicMaxField (  ObitImageMosaic *  mosaic, gfloat  MinFlux, gint *  ignore, gint *  field, ObitErr *  err )

Public: Generate a mosaic for peeling. Fields with 1-rel numbers in the zero terminated list ignore are ignored Parameters: mosaic  ImageMosaic to process MinFlux  Min. flux density for operation. ignore  0 terminated list of 1-rel field numbers to ignore field  [out] the 1-rel number of the field copied err  Error/message stack return Newly created ImageMosaic or NULL

gboolean ObitImageMosaicReimage (  ObitImageMosaic *  mosaic, ObitErr *  err )

Public: Reimaging needed to center strong source on pixel?

void ObitImageMosaicSetFiles (  ObitImageMosaic *  in, gboolean  doBeam, ObitErr *  err )

Public: Set underlying files. For AIPS files: Mosaic images have classes with the first character of the imClass followed by 'M', followed by 4 digits of the field number. The Beams are the same except that the second character is 'B'. The full field image has class imClass and 'F' as the 6th character. For FITS files: Image classes are imClass+digits of the field Beam classes are the same except the second character is replaced with a 'B' (unless it already is 'B' in which case 'b' is used). The full field image has class imClass followed by 'Full' Parameters: in  The object with images, Details are defined in members: numberImage - Number of images in Mosaic nInit - number of images already initialized images - Image array fileType - Are image OBIT_IO_AIPS or OBIT_IO_FITS? imName - Name of Mosaic images imClass - imClass imSeq - imSeq imDisk - imDisk doBeam  If true, make beam as well. err  Error stack, returns if not empty.

void ObitImageMosaicSetFullImage (  ObitImageMosaic *  in, ObitImage *  image, ObitErr *  err )

Public: Set Full Field image. Parameters: in  The array of images image  Image reference to add err  Error stack, returns if not empty.

void ObitImageMosaicSetImage (  ObitImageMosaic *  in, gint  number, ObitImage *  image, ObitErr *  err )

Public: Set specified image. Parameters: in  The array of images number  The 0-rel image number in array image  Image reference to add err  Error stack, returns if not empty.

void ObitImageMosaicZapImage (  ObitImageMosaic *  in, gint  number, ObitErr *  err )

Public: Zap specified image. Also deletes any associated beam member Parameters: in  The array of images number  The 0-rel image number, -1=> all err  Error stack, returns if not empty.

---