casa::Imager Class Reference

Class that contains functions needed for imager. More...

#include <Imager.h>

Inheritance diagram for casa::Imager:

Public Member Functions
	Imager ()
	Default constructor.
	Imager (MeasurementSet &ms, Bool compress=False, Bool useModel=False)
	Imager (MeasurementSet &ms, Bool compress=False)
	Imager (const Imager &)
	Copy constructor and assignment operator.
Imager &	operator= (const Imager &)
virtual	~Imager ()
	Destructor.
virtual Bool	openSubTables ()
	open all the subtables as userNoReadLock
virtual Bool	lock ()
	Lock the ms and its subtables.
virtual Bool	unlock ()
	Unlock the ms and its subtables.
Bool	selectDataChannel (Vector< Int > &spectralwindowids, String &dataMode, Vector< Int > &dataNchan, Vector< Int > &dataStart, Vector< Int > &dataStep, MRadialVelocity &mDataStart, MRadialVelocity &mDataStep)
	Utility function to do channel selection.
virtual Bool	checkCoord (const CoordinateSystem &coordsys, const String &imageName)
	Utility function to check coordinate match with existing image.
virtual void	setImageParam (Int &nx, Int &ny, Int &npol, Int &nchan)
virtual void	makeVisSet (MeasurementSet &ms, Bool compress=False, Bool mosaicOrder=False)
	VisSet and resort.
virtual void	writeHistory (LogIO &os)
	Just to create the SORTED_TABLE if one can virtual void makeVisSet(MeasurementSet& ms, Bool compress=False, Bool mosaicOrder=False);.
virtual void	writeCommand (LogIO &os)
Bool	makeEmptyImage (CoordinateSystem &imageCoord, String &name, Int fieldID=0)
	make an empty image
Bool	makePBImage (ImageInterface< Float > &pbImage, Bool useSymmetricBeam=True)
	Functions to make Primary beams.
Bool	makePBImage (const CoordinateSystem &imageCoord, const String &telescopeName, const String &diskPBName, Bool useSymmetricBeam=True, Double dishdiam=-1.0)
Bool	makePBImage (const CoordinateSystem &imageCoord, const Table &vpTable, const String &diskPBName)
Bool	makePBImage (const Table &vpTable, ImageInterface< Float > &pbImage)
Bool	makePBImage (const CoordinateSystem &imageCoord, PBMath &pbMath, const String &diskPBName)
Bool	makePBImage (PBMath &pbMath, ImageInterface< Float > &pbImage)
void	setObsInfo (ObsInfo &obsinfo)
ObsInfo &	latestObsInfo ()
Bool	open (MeasurementSet &thems, Bool compress=False, Bool useModel=False)
	Close the current ms, and replace it with the supplied ms.
Bool	close ()
	Flush the ms to disk and detach from the ms file.
String	name () const
	Return the name of the MeasurementSet.
virtual Bool	setimage (const Int nx, const Int ny, const Quantity &cellx, const Quantity &celly, const String &stokes, Bool doShift, const MDirection &phaseCenter, const Quantity &shiftx, const Quantity &shifty, const String &mode, const Int nchan, const Int start, const Int step, const MRadialVelocity &mStart, const MRadialVelocity &mStep, const Vector< Int > &spectralwindowids, const Int fieldid, const Int facets, const Quantity &distance)
	The following setup methods define the state of the imager.
virtual Bool	defineImage (const Int nx, const Int ny, const Quantity &cellx, const Quantity &celly, const String &stokes, const MDirection &phaseCenter, const Int fieldid, const String &mode, const Int nchan, const Int start, const Int step, const MFrequency &mFreqStart, const MRadialVelocity &mStart, const Quantity &qStep, const Vector< Int > &spectralwindowids, const Int facets=1, const Quantity &restFreq=Quantity(0,"Hz"), const MFrequency::Types &mFreqFrame=MFrequency::LSRK, const Quantity &distance=Quantity(0,"m"), const Bool trackSource=False, const MDirection &trackDir=MDirection(Quantity(0.0,"deg"), Quantity(90.0,"deg")))
virtual Bool	setDataPerMS (const String &msname, const String &mode, const Vector< Int > &nchan, const Vector< Int > &start, const Vector< Int > &step, const Vector< Int > &spectralwindowids, const Vector< Int > &fieldid, const String &msSelect="", const String &timerng="", const String &fieldnames="", const Vector< Int > &antIndex=Vector< Int >(), const String &antnames="", const String &spwstring="", const String &uvdist="", const String &scan="", const String &intent="", const String &obs="", const Bool useModelCol=False, const Bool readonly=False)
	Set the data selection parameters.
Bool	setdata (const String &mode, const Vector< Int > &nchan, const Vector< Int > &start, const Vector< Int > &step, const MRadialVelocity &mStart, const MRadialVelocity &mStep, const Vector< Int > &spectralwindowids, const Vector< Int > &fieldid, const String &msSelect="", const String &timerng="", const String &fieldnames="", const Vector< Int > &antIndex=Vector< Int >(), const String &antnames="", const String &spwstring="", const String &uvdist="", const String &scan="", const String &intent="", const String &obs="", const Bool usemodelCol=False, const Bool be_calm=false)
	Select some data.
Bool	setoptions (const String &ftmachine, const Long cache, const Int tile, const String &gridfunction, const MPosition &mLocation, const Float padding, const Int wprojplanes=-1, const String &epJTableName="", const Bool applyPointingOffsets=True, const Bool doPointingCorrection=True, const String &cfCacheDirName="", const Float &rotpastep=5.0, const Float &computepastep=360.0, const Float &pbLimit=5.0e-2, const String &freqinterpmethod="linear", const Int imageTileSizeInPix=0, const Bool singleprecisiononly=False, const Int numthreads=-1, const Bool psTermOn=True, const Bool aTermOn=True, const Bool mTermOn=False, const Bool wbAWP=False, const Bool conjBeams=True)
	Set the processing options.
Bool	setsdoptions (const Float scale, const Float weight, const Int convsupport=-1, String pointingColToUse="DIRECTION", const Quantity truncate=Quantity(), const Quantity gwidth=Quantity(), const Quantity jwidth=Quantity(), const Float minweight=0., const Bool clipminmax=False)
	Set the single dish processing options.
Bool	setvp (const Bool dovp, const Bool defaultVP, const String &vpTable, const Bool doSquint, const Quantity &parAngleInc, const Quantity &skyPosThreshold, String defaultTel="", const Bool verbose=true)
	Set the voltage pattern.
Bool	setscales (const String &scaleMethod, const Int inscales, const Vector< Float > &userScaleSizes)
	Set the scales to be searched in Multi Scale clean.
Bool	setSmallScaleBias (const Float inbias)
	set bias
Bool	settaylorterms (const Int intaylor, const Double inreffreq)
	Set the number of taylor series terms in the expansion of the image as a function of frequency.
Bool	advise (const Bool takeAdvice, const Float amplitudeloss, const Quantity &fieldOfView, Quantity &cell, Int &npixels, Int &facets, MDirection &phaseCenter)
	Advise on suitable values.
Bool	summary ()
	Output a summary of the state of the object.
String	state ()
	Return the state of the object as a string.
uInt	count_visibilities (ROVisibilityIterator *rvi, const Bool unflagged_only, const Bool must_have_imwt)
	Return the # of visibilities accessible to *rvi, optionally excluding flagged ones (if unflagged_only is true) and/or ones without imaging weights (if must_have_imwt is true).
Bool	imagecoordinates (CoordinateSystem &coordInfo, const Bool verbose=true)
	Return the image coordinates.
Bool	imagecoordinates2 (CoordinateSystem &coordInfo, const Bool verbose=true)
	new version
IPosition	imageshape () const
	Return the image shape.
Bool	weight (const String &algorithm, const String &rmode, const Quantity &noise, const Double robust, const Quantity &fieldofview, const Int npixels, const Bool multiField=False)
	Weight the MeasurementSet For some time of weighting briggs/uniform ...one can do it on a per field basis to calculate weight density distribution.
Bool	filter (const String &type, const Quantity &bmaj, const Quantity &bmin, const Quantity &bpa)
	Filter the MeasurementSet.
Bool	uvrange (const Double &uvmin, const Double &uvmax)
	Apply a uvrange.
Bool	sensitivity (Quantity &pointsourcesens, Double &relativesens, Double &sumwt, Double &effectiveBandwidth, Double &effectiveIntegration, Int &mBaselines, Matrix< Int > &mssChanSel, Vector< Vector< Int > > &nData, Vector< Vector< Double > > &sumwtChan, Vector< Vector< Double > > &sumwtsqChan, Vector< Vector< Double > > &sumInverseVarianceChan)
	Sensitivity.
Bool	apparentSensitivity (Double &effSensitivity, Double &relToNat)
	Apparent sensitivity calculator Accounts for gridding weights and assumes MS weights have correct units.
Bool	makeimage (const String &type, const String &imageName, const String &complexImageName="", const Bool verbose=true)
	Make plain image + keep the complex image as well if complexImageName != "".
Bool	boxmask (const String &mask, const Vector< Int > &blc, const Vector< Int > &trc, const Float value)
	Fill in a region of a mask.
Bool	regionmask (const String &maskimage, Record *imageRegRec, Matrix< Quantity > &blctrcs, Matrix< Float > &circles, const Float &value=1.0)
	Make a region either from record or array of blc trc (Matrix(nboxes,4)) into a mask image value is the value of the mask pixels circular masks has form Matrix(ncircles,3) where the 3 values on a row are radius, x, y pixel values.
Bool	clipimage (const String &image, const Quantity &threshold)
	Clip on Stokes I.
Bool	restore (const Vector< String > &model, const String &complist, const Vector< String > &image, const Vector< String > &residual)
	Restore.
Bool	updateresidual (const Vector< String > &model, const String &complist, const Vector< String > &image, const Vector< String > &residual)
	similar to restore except this is to be called if you fiddle with the model and complist outside of this object (say you clip stuff etc) ...keep the sm_p and se_p state but just calculate new residuals and restored images.
Bool	setbeam (const ImageBeamSet &beam)
	Setbeam.
Bool	residual (const Vector< String > &model, const String &complist, const Vector< String > &image)
	Residual.
Bool	approximatepsf (const String &psf)
	Approximate PSF.
Bool	smooth (const Vector< String > &model, const Vector< String > &image, Bool usefit, ImageBeamSet &mbeam, Bool normalizeVolume)
	Smooth.
Record	clean (const String &algorithm, const Int niter, const Float gain, const Quantity &threshold, const Bool displayProgress, const Vector< String > &model, const Vector< Bool > &fixed, const String &complist, const Vector< String > &mask, const Vector< String > &restored, const Vector< String > &residual, const Vector< String > &psf=Vector< String >(0), const Bool firstrun=true)
	Clean algorithm.
Record	iClean (const String &algorithm, const Int niter, const Double gain, const Quantity &threshold, const Bool displayprogress, const Vector< String > &model, const Vector< Bool > &keepfixed, const String &complist, const Vector< String > &mask, const Vector< String > &image, const Vector< String > &residual, const Vector< String > &psfnames, const Bool interactive, const Int npercycle, const String &masktemplate)
Bool	mem (const String &algorithm, const Int niter, const Quantity &sigma, const Quantity &targetflux, const Bool constrainflux, const Bool displayProgress, const Vector< String > &model, const Vector< Bool > &fixed, const String &complist, const Vector< String > &prior, const Vector< String > &mask, const Vector< String > &restored, const Vector< String > &residual)
	MEM algorithm.
Bool	pixon (const String &algorithm, const Quantity &sigma, const String &model)
	pixon algorithm
Bool	nnls (const String &algorithm, const Int niter, const Float tolerance, const Vector< String > &model, const Vector< Bool > &fixed, const String &complist, const Vector< String > &fluxMask, const Vector< String > &dataMask, const Vector< String > &restored, const Vector< String > &residual)
	NNLS algorithm.
Bool	setmfcontrol (const Float cyclefactor, const Float cyclespeedup, const Float cyclemaxpsffraction, const Int stoplargenegatives, const Int stoppointmode, const String &scaleType, const Float minPB, const Float constPB, const Vector< String > &fluxscale, const Bool flatnoise=True)
	Multi-field control parameters flat noise is the parameter that control the search of clean components in a flat noise image or an optimum beam^2 image.
Bool	feather (const String &image, const String &highres, const String &lowres, const String &lowpsf, const Float dishDiam=-1.0, const Bool lowPassFilterSD=False)
	Feathering algorithm.
Bool	pb (const String &inimage, const String &outimage, const String &incomps, const String &outcomps, const String &operation, const MDirection &pointngCenter, const Quantity &pa, const String &pborvp)
	Apply or correct for Primary Beam or Voltage Pattern.
Bool	linearmosaic (const String &mosaic, const String &fluxscale, const String &sensitivity, const Vector< String > &images, const Vector< Int > &fieldids)
	Make a linear mosaic of several images.
Bool	ft (const Vector< String > &model, const String &complist, Bool incremental=False)
	Fourier transform the model and componentlist.
Bool	setjy (const Int fieldid, const Int spectralwindowid, const Vector< Double > &fluxDensity, const String &standard)
	Compute the model visibility using specified source flux densities.
Bool	setjy (const Vector< Int > &fieldid, const Vector< Int > &spectralwindowid, const String &fieldnames, const String &spwstring, const Vector< Double > &fluxDensity, const String &standard)
Record	setjy (const Vector< Int > &fieldid, const Vector< Int > &spectralwindowid, const String &fieldnames, const String &spwstring, const String &model, const Vector< Double > &fluxDensity, const String &standard, const Bool chanDep=False, const Vector< Double > &spix=Vector< Double >(), const MFrequency &reffreq=MFrequency(Quantity(1.0,"GHz"), MFrequency::LSRK), const Vector< Double > &pipars=Vector< Double >(), const Vector< Double > &papars=Vector< Double >(), const Double &rotMeas=0.0, const String &timerange="", const String &scanstr="", const String &intentstr="", const String &obsidstr="", const String &interpolation="nearest")
	Setjy with model image.
Bool	make (const String &model)
	Make an empty image.
Bool	makemodelfromsd (const String &sdImage, const String &modelimage, const String &lowPSF, String &maskImage)
	make a model from a SD image.
String	make_comp (const String &objName, const String &standard, const MEpoch &mtime, const Vector< MFrequency > &freqv, const String &prefix)
	Write a component list to disk, starting with prefix, using a setjy standard, and return the name of the list.
Bool	fitpsf (const String &psf, ImageBeamSet &mbeam)
	Fit the psf.
Bool	correct (const Bool doparallactic, const Quantity &t)
	Correct the visibility data (OBSERVED->CORRECTED).
Bool	plotuv (const Bool rotate)
	Plot the uv plane.
Bool	plotvis (const String &type, const Int increment)
	Plot the visibilities.
Bool	plotweights (const Bool gridded, const Int increment)
	Plot the weights.
Bool	plotsummary ()
	Plot a summary.
Bool	clipvis (const Quantity &threshold)
	Clip visibilities.
Bool	valid () const
	Check if can proceed with this object.
Int	interactivemask (const String &imagename, const String &maskname, Int &niter, Int &ncycles, String &threshold, const Bool forceReload=False)
	Interactive mask drawing forceReload..forces the viewer to dump previous image that is being displayed.
Bool	calcImFreqs (Vector< Double > &imfreqs, Vector< Double > &imfreqres, const MFrequency::Types &oldRefFrame, const MEpoch &obsEpoch, const MPosition &obsPosition, const Double &restFreq)
	spectral gridding calculation for output images (use SubMS::calcChanFreqs)
Bool	adviseChanSelex (Double &freqStart, Double &freqEnd, const Double &freqStep, const MFrequency::Types &freqframe, Vector< Vector< Int > > &spw, Vector< Vector< Int > > &start, Vector< Vector< Int > > &nchan, const String &msname="", const Int fieldid=0, const Bool getFreqRange=False, const String spwselection="")
	Advise the chanselection needed for the frequency range or give the frequency range for a give spwselection if getFreqRange==True if the parameter msname is used then the MSs associated associated with this object (that have been either 'open'ed or 'selectvis'ed) are ignored In this mode it is a helper function to the general world ...no need to open or selectvis.
Bool	getWeightGrid (Block< Matrix< Float > > &weightgrid, const String &type, const Vector< String > &weightImagenames=Vector< String >())
	These are utility functions when weights from different imager instances need to reconciled in parallel gridding by different instances of imagers for example.
Bool	setWeightGrid (const Block< Matrix< Float > > &weightgrid, const String &type)
String	dQuantitytoString (const Quantity &dq)
virtual Bool	mapExtent (const String &referenceFrame, const String &movingSource, const String &pointingColumn, Vector< Double > &center, Vector< Double > &blc, Vector< Double > &trc, Vector< Double > &extent)
	Automatic evaluation of map extent for given visibility.
Static Public Member Functions
static Bool	regionToImageMask (const String &maskimage, Record *imageRegRec, Matrix< Quantity > &blctrcs, Matrix< Float > &circles, const Float &value=1.0)
static Bool	mask (const String &mask, const String &imageName, const Quantity &threshold)
	Make a mask image.
static Bool	clone (const String &imageName, const String &newImageName)
	Clone an image.
static Bool	copyMask (ImageInterface< Float > &out, const ImageInterface< Float > &in, String maskname="mask0", Bool setdefault=True)
	helper function to copy a mask from one image to another
static Bool	expand_blank_sel (Vector< Int > &v, const uInt nelem)
	Supports the "[] or -1 => everything" convention using the rule: If v is empty or only has 1 element, and it is < 0, replace v with 0, 1, .
static void	transferHistory (LoggerHolder &imageLog, ROMSHistoryColumns &msHis)
	Helper function to transfer history table to a logger holder which can be stored in images.
Protected Member Functions
void	defaults ()
	Set the defaults.
Bool	detached () const
	check if it is dettahced from ms.
virtual Bool	createFTMachine ()
	Create the FTMachines when necessary or when the control parameters have changed.
void	openSubTable (const Table &otherTable, Table &table, const TableLock &tableLock)
Bool	removeTable (const String &tablename)
Bool	updateSkyModel (const Vector< String > &model, const String complist)
Bool	createSkyEquation (const String complist="")
Bool	createSkyEquation (const Vector< String > &image, const Vector< Bool > &fixed, const String complist="")
Bool	createSkyEquation (const Vector< String > &image, const String complist="")
Bool	createSkyEquation (const Vector< String > &image, const Vector< Bool > &fixed, const Vector< String > &mask, const String complist="")
Bool	createSkyEquation (const Vector< String > &image, const Vector< Bool > &fixed, const Vector< String > &mask, const Vector< String > &fluxMask, const String complist="")
ATerm *	createTelescopeATerm (MeasurementSet &ms, const Bool &isATermOn=True)
void	destroySkyEquation ()
Bool	addResiduals (const Vector< String > &residual)
	add residual to the private vars or create residual images
Bool	addResidualsToSkyEquation (const Vector< String > &residual)
	Add the residuals to the SkyEquation.
Bool	addMasksToSkyEquation (const Vector< String > &mask, const Vector< Bool > &fixed=Vector< Bool >(0))
	Add or replace the masks.
Bool	getRestFreq (Vector< Double > &restFreq, const Int &spw)
	Get the rest frequency ..returns 1 element in restfreq if user specified or try to get the info from the SOURCE table.
Bool	restoreImages (const Vector< String > &restored, Bool modresiduals=True)
Bool	writeFluxScales (const Vector< String > &fluxScaleNames)
	names of flux scale images
Unit	sjy_setup_arrs (Vector< Vector< Flux< Double > > > &returnFluxes, Vector< Vector< Flux< Double > > > &returnFluxErrs, Vector< Vector< Double > > &fluxUsed, Vector< String > &tempCLs, Vector< Vector< MFrequency > > &mfreqs, const ROMSSpWindowColumns &spwcols, const uInt nspws, const Vector< Int > &selToRawSpwIds, const Bool chanDep)
	Helper functions to hide some setjy code.
Bool	sjy_make_visibilities (TempImage< Float > *tmodimage, LogIO &os, const Int rawspwid, const Int fldid, const String &clname, const String &timerange="", const String &scanstr="", const String &obsidstr="", const String &intentstr="", const Vector< Double > &freqofscale=Vector< Double >(0), const Vector< Double > &scale=Vector< Double >(0))
	Returns whether it might have made any visibilities.
Bool	sjy_concatComponentLists (LogIO &os, const Vector< String > &tempCLs, const String &outTempCL)
	Concatenate multiple CLs.
Bool	sjy_computeFlux (LogIO &os, FluxStandard &fluxStd, Vector< Vector< Flux< Double > > > &returnFluxes, Vector< Vector< Flux< Double > > > &returnFluxErrs, Vector< String > &tempCLs, Vector< Vector< Double > > &fluxUsed, String &fluxScaleName, MEpoch &aveEpoch, const Vector< Vector< MFrequency > > &mfreqs, const String &model, const String &fieldName, const ROMSColumns &msc, const Int fldid, const MDirection &fieldDir, const Vector< Int > &selToRawSpwIds, const String &standard)
	Returns whether it found a source.
void	sjy_makeComponentList (LogIO &os, Vector< String > &tempCLs, Vector< Vector< Flux< Double > > > &returnFluxes, const Vector< Double > &fluxUsed, const Vector< Int > &selToRawSpwIds, const Vector< Vector< MFrequency > > &mfreqs, const String &fieldName, const MDirection &fieldDir, const Vector< Double > &spix, const Vector< Double > &pipars, const Vector< Double > &papars, const Double &rotMeas, const MFrequency &reffreq, const MEpoch &aveEpoch, const Int fldId)
TempImage< Float > *	sjy_prepImage (LogIO &os, FluxStandard &fluxStd, Vector< Double > &fluxUsed, Vector< Double > &freq, Vector< Double > &scale, const String &model, const ROMSSpWindowColumns &spwcols, const Vector< Int > rawspwids, const Bool chanDep, const Vector< Vector< MFrequency > > &mfreqs, const String &fieldName, const MDirection &fieldDir, const Unit &freqUnit, const Vector< Double > &fluxdens, const Bool precompute, const Vector< Double > &spix, const MFrequency &reffreq, const MEpoch &aveEpoch, const Int fieldId)
	Returns NULL if no image is prepared.
Bool	sjy_regridCubeChans (TempImage< Float > *tmodimage, PagedImage< Float > &modimage, Int freqAxis)
	Returns True or throws up.
Bool	sjy_setRadiusLimit (TempImage< Float > *tmodimage, PagedImage< Float > &modimage, const String &model, DirectionCoordinate &dircsys)
	set a radius limit if the model image is one of the known source otherwise simply copy modimage to tmodimage
Bool	sjy_calciflux (const Vector< MFrequency > &freqs, const MFrequency &reffreq, const Double refflux, const Vector< Double > &vspix, Vector< Double > &iflux)
Bool	sjy_calcquflux (const Vector< Double > &pipars, const Vector< Double > &papars, const Vector< Double > &iflux, const Double rotMeas, const Vector< MFrequency > &freqs, const MFrequency &reffreq, Vector< Double > &qflux, Vector< Double > &uflux)
String	imageName ()
Bool	pbguts (ImageInterface< Float > &in, ImageInterface< Float > &out, const MDirection &, const Quantity &)
void	printbeam (CleanImageSkyModel *sm_p, LogIO &os, const Bool firstrun=true)
	Helper func for printing clean's restoring beam to the logger.
String	tangentPoint ()
	Helper func for createFTMachine().
Bool	assertDefinedImageParameters () const
virtual void	setWFCleanImageSkyModel ()
	Virtual methods to set the ImageSkyModel and SkyEquation.
virtual void	setClarkCleanImageSkyModel ()
virtual void	setSkyEquation ()
virtual void	savePSF (const Vector< String > &psf)
String	frmtTime (const Double time)
virtual void	setMosaicFTMachine (Bool useDoublePrec=False)
	set the mosaic ft machine and right convolution function
String	makeComponentList (const String &fieldName, const Int spwid, const Flux< Double > &fluxval, const ComponentShape &cmp, const ConstantSpectrum &cspectrum) const
	Makes a component list on disk containing cmp (with fluxval and cspectrum) named msname_p.fieldName.spw<spwid>.tempcl and returns the name.
Vector< Int >	decideNPolPlanes (Bool checkwithMS)
Bool	nonDefaultLocation ()
	returns if mLocation_p is set (= non-default MPosition)
Bool	getMapExtent (const MeasurementSet &ms, const String &referenceFrame, const String &movingSource, const String &pointingColumn, Vector< Double > &center, Vector< Double > &blc, Vector< Double > &trc, Vector< Double > &extent)
	implementation of mapExtent
Static Protected Member Functions
static Bool	regionToMask (ImageInterface< Float > &maskImage, ImageRegion &imagreg, const Float &value=1.0)
	copy imageregion to pixels on image as value given
Protected Attributes
CountedPtr< MeasurementSet >	ms_p
CountedPtr< MSHistoryHandler >	hist_p
Table	antab_p
Table	datadesctab_p
Table	feedtab_p
Table	fieldtab_p
Table	obstab_p
Table	pointingtab_p
Table	poltab_p
Table	proctab_p
Table	spwtab_p
Table	statetab_p
Table	dopplertab_p
Table	flagcmdtab_p
Table	freqoffsettab_p
Table	historytab_p
Table	sourcetab_p
Table	syscaltab_p
Table	weathertab_p
Int	lockCounter_p
Int	nx_p
Int	ny_p
Int	npol_p
Int	nchan_p
ObsInfo	latestObsInfo_p
Int	imageTileVol_p
	What should be the tile volume on disk.
String	msname_p
CountedPtr< MeasurementSet >	mssel_p
VisSet *	vs_p
ROVisibilityIterator *	rvi_p
VisibilityIterator *	wvi_p
FTMachine *	ft_p
ComponentFTMachine *	cft_p
SkyEquation *	se_p
CleanImageSkyModel *	sm_p
VPSkyJones *	vp_p
VPSkyJones *	gvp_p
Bool	setimaged_p
Bool	nullSelect_p
Bool	redoSkyModel_p
Float	rotPAStep_p
	if setimage was changed hence redo the skyModel.
Float	computePAStep_p
Float	pbLimit_p
Int	facets_p
Int	wprojPlanes_p
Quantity	mcellx_p
Quantity	mcelly_p
String	stokes_p
String	dataMode_p
String	imageMode_p
Vector< Int >	dataNchan_p
Int	imageNchan_p
Vector< Int >	dataStart_p
Vector< Int >	dataStep_p
Int	imageStart_p
Int	imageStep_p
MRadialVelocity	mDataStart_p
MRadialVelocity	mImageStart_p
MRadialVelocity	mDataStep_p
MRadialVelocity	mImageStep_p
MFrequency	mfImageStart_p
MFrequency	mfImageStep_p
MFrequency::Types	freqFrame_p
MDirection	phaseCenter_p
Quantity	restFreq_p
Quantity	distance_p
Bool	doShift_p
Quantity	shiftx_p
Quantity	shifty_p
String	ftmachine_p
String	gridfunction_p
Bool	wfGridding_p
Long	cache_p
Int	tile_p
MPosition	mLocation_p
Bool	doVP_p
ImageBeamSet	beam_p
Bool	beamValid_p
Float	padding_p
Float	sdScale_p
Float	sdWeight_p
Int	sdConvSupport_p
Quantity	qtruncate_p
Quantity	qgwidth_p
Quantity	qjwidth_p
Float	minWeight_p
Bool	clipminmax_p
Float	cyclefactor_p
	special mf control parms, etc
Float	cyclespeedup_p
Float	cyclemaxpsffraction_p
Int	stoplargenegatives_p
Int	stoppointmode_p
Vector< String >	fluxscale_p
String	scaleType_p
Float	minPB_p
Float	constPB_p
Vector< Int >	spectralwindowids_p
Int	fieldid_p
Vector< Int >	dataspectralwindowids_p
Vector< Int >	datadescids_p
Vector< Int >	datafieldids_p
Cube< Int >	spwchansels_p
	TT.
Matrix< Double >	freqrange_p
Matrix< Double >	mssFreqSel_p
Matrix< Int >	mssChanSel_p
Int	numMS_p
String	telescope_p
String	vpTableStr_p
Quantity	parAngleInc_p
	in the MS
Quantity	skyPosThreshold_p
BeamSquint::SquintType	squintType_p
Bool	doDefaultVP_p
Bool	doMultiFields_p
Bool	multiFields_p
Bool	doWideBand_p
String	freqInterpMethod_p
Bool	flatnoise_p
ComponentList *	componentList_p
String	scaleMethod_p
Int	nscales_p
Int	ntaylor_p
Double	reffreq_p
Bool	useNewMTFT_p
Vector< Float >	userScaleSizes_p
Bool	scaleInfoValid_p
Float	smallScaleBias_p
Int	nmodels_p
Block< CountedPtr< PagedImage < Float > > >	images_p
	Everything here must be a real class since we make, handle and destroy these.
Block< CountedPtr< PagedImage < Float > > >	masks_p
Block< CountedPtr< PagedImage < Float > > >	fluxMasks_p
Block< CountedPtr< PagedImage < Float > > >	residuals_p
Bool	freqFrameValid_p
	Freq frame is good and valid conversions can be done (or not).
StokesImageUtil::PolRep	polRep_p
	Preferred complex polarization representation.
Bool	useModelCol_p
	Whether to use model column or use it in memory on the fly.
Bool	singlePrec_p
	Force single precision always.
LogSink	logSink_p
	sink used to store history mainly
EPJones *	epJ
	Objects required for pointing correction (ftmachine=PBWProject).
String	epJTableName_p
String	cfCacheDirName_p
Bool	doPointing
Bool	doPBCorr
Bool	psTermOn_p
Bool	aTermOn_p
Bool	mTermOn_p
Bool	wbAWP_p
Bool	conjBeams_p
Record	interactiveState_p
	SimplePlotterPtr plotter_p;.
Bool	doTrackSource_p
	Track moving source stuff.
MDirection	trackDir_p
String	pointingDirCol_p
VisImagingWeight	imwgt_p
ViewerProxy *	viewer_p
	viewer connection
int	clean_panel_p
int	image_id_p
int	mask_id_p
int	prev_image_id_p
int	prev_mask_id_p
Int	numthreads_p
	numthreads
Bool	avoidTempLatt_p

Detailed Description

Class that contains functions needed for imager.

Definition at line 76 of file Imager.h.

Constructor & Destructor Documentation

casa::Imager::Imager ( )

Default constructor.

casa::Imager::Imager	(	MeasurementSet &	ms,
		Bool	compress = `False`,
		Bool	useModel = `False`
	)

casa::Imager::Imager	(	MeasurementSet &	ms,
		Bool	compress = `False`
	)

casa::Imager::Imager ( const Imager & )

Copy constructor and assignment operator.

virtual casa::Imager::~Imager ( ) [virtual]

Destructor.

Member Function Documentation

Bool casa::Imager::addMasksToSkyEquation	(	const Vector< String > &	mask,
		const Vector< Bool > &	fixed = `Vector< Bool >(0)`
	)			`[protected]`

Add or replace the masks.

Bool casa::Imager::addResiduals ( const Vector< String > & residual ) [protected]

add residual to the private vars or create residual images

Bool casa::Imager::addResidualsToSkyEquation ( const Vector< String > & residual ) [protected]

Add the residuals to the SkyEquation.

Bool casa::Imager::advise	(	const Bool	takeAdvice,
		const Float	amplitudeloss,
		const Quantity &	fieldOfView,
		Quantity &	cell,
		Int &	npixels,
		Int &	facets,
		MDirection &	phaseCenter
	)

Advise on suitable values.

Bool casa::Imager::adviseChanSelex	(	Double &	freqStart,
		Double &	freqEnd,
		const Double &	freqStep,
		const MFrequency::Types &	freqframe,
		Vector< Vector< Int > > &	spw,
		Vector< Vector< Int > > &	start,
		Vector< Vector< Int > > &	nchan,
		const String &	msname = `""`,
		const Int	fieldid = `0`,
		const Bool	getFreqRange = `False`,
		const String	spwselection = `""`
	)

Advise the chanselection needed for the frequency range or give the frequency range for a give spwselection if getFreqRange==True if the parameter msname is used then the MSs associated associated with this object (that have been either 'open'ed or 'selectvis'ed) are ignored In this mode it is a helper function to the general world ...no need to open or selectvis.

You need to specify the field_id for which this calculation is being done for in the helper mode. If you have already set MS's and selected data and msname="" then the calulation is done for the field(s) selected in selectvis. getFreqRange=True then the freqrange in the frame and spwselection you choose is returned in freqStart and freqEnd (in the case of msname="" then it is for the fields and spw you have chosen in selectvis).

Bool casa::Imager::apparentSensitivity	(	Double &	effSensitivity,
		Double &	relToNat
	)

Apparent sensitivity calculator Accounts for gridding weights and assumes MS weights have correct units.

Bool casa::Imager::approximatepsf ( const String & psf )

Approximate PSF.

Bool casa::Imager::assertDefinedImageParameters ( ) const [protected]

Bool casa::Imager::boxmask	(	const String &	mask,
		const Vector< Int > &	blc,
		const Vector< Int > &	trc,
		const Float	value
	)

Fill in a region of a mask.

Bool casa::Imager::calcImFreqs	(	Vector< Double > &	imfreqs,
		Vector< Double > &	imfreqres,
		const MFrequency::Types &	oldRefFrame,
		const MEpoch &	obsEpoch,
		const MPosition &	obsPosition,
		const Double &	restFreq
	)

spectral gridding calculation for output images (use SubMS::calcChanFreqs)

virtual Bool casa::Imager::checkCoord	(	const CoordinateSystem &	coordsys,
		const String &	imageName
	)			`[virtual]`

Utility function to check coordinate match with existing image.

Record casa::Imager::clean	(	const String &	algorithm,
		const Int	niter,
		const Float	gain,
		const Quantity &	threshold,
		const Bool	displayProgress,
		const Vector< String > &	model,
		const Vector< Bool > &	fixed,
		const String &	complist,
		const Vector< String > &	mask,
		const Vector< String > &	restored,
		const Vector< String > &	residual,
		const Vector< String > &	psf = `Vector< String >(0)`,
		const Bool	firstrun = `true`
	)

Clean algorithm.

Bool casa::Imager::clipimage	(	const String &	image,
		const Quantity &	threshold
	)

Clip on Stokes I.

Bool casa::Imager::clipvis ( const Quantity & threshold )

Clip visibilities.

static Bool casa::Imager::clone	(	const String &	imageName,
		const String &	newImageName
	)			`[static]`

Clone an image.

Bool casa::Imager::close ( )

Flush the ms to disk and detach from the ms file.

All function calls after this will be a no-op.

static Bool casa::Imager::copyMask	(	ImageInterface< Float > &	out,
		const ImageInterface< Float > &	in,
		String	maskname = `"mask0"`,
		Bool	setdefault = `True`
	)			`[static]`

helper function to copy a mask from one image to another

Bool casa::Imager::correct	(	const Bool	doparallactic,
		const Quantity &	t
	)

Correct the visibility data (OBSERVED->CORRECTED).

uInt casa::Imager::count_visibilities	(	ROVisibilityIterator *	rvi,
		const Bool	unflagged_only,
		const Bool	must_have_imwt
	)

Return the # of visibilities accessible to *rvi, optionally excluding flagged ones (if unflagged_only is true) and/or ones without imaging weights (if must_have_imwt is true).

virtual Bool casa::Imager::createFTMachine ( ) [protected, virtual]

Create the FTMachines when necessary or when the control parameters have changed.

Bool casa::Imager::createSkyEquation	(	const Vector< String > &	image,
		const Vector< Bool > &	fixed,
		const Vector< String > &	mask,
		const Vector< String > &	fluxMask,
		const String	complist = `""`
	)			`[protected]`

Bool casa::Imager::createSkyEquation	(	const Vector< String > &	image,
		const Vector< Bool > &	fixed,
		const Vector< String > &	mask,
		const String	complist = `""`
	)			`[protected]`

Bool casa::Imager::createSkyEquation	(	const Vector< String > &	image,
		const String	complist = `""`
	)			`[protected]`

Bool casa::Imager::createSkyEquation	(	const Vector< String > &	image,
		const Vector< Bool > &	fixed,
		const String	complist = `""`
	)			`[protected]`

Bool casa::Imager::createSkyEquation ( const String complist = "" ) [protected]

ATerm* casa::Imager::createTelescopeATerm	(	MeasurementSet &	ms,
		const Bool &	isATermOn = `True`
	)			`[protected]`

Vector<Int> casa::Imager::decideNPolPlanes ( Bool checkwithMS ) [protected]

void casa::Imager::defaults ( ) [protected]

Set the defaults.

virtual Bool casa::Imager::defineImage	(	const Int	nx,
		const Int	ny,
		const Quantity &	cellx,
		const Quantity &	celly,
		const String &	stokes,
		const MDirection &	phaseCenter,
		const Int	fieldid,
		const String &	mode,
		const Int	nchan,
		const Int	start,
		const Int	step,
		const MFrequency &	mFreqStart,
		const MRadialVelocity &	mStart,
		const Quantity &	qStep,
		const Vector< Int > &	spectralwindowids,
		const Int	facets = `1`,
		const Quantity &	restFreq = `Quantity(0,"Hz")`,
		const MFrequency::Types &	mFreqFrame = `MFrequency::LSRK`,
		const Quantity &	distance = `Quantity(0,"m")`,
		const Bool	trackSource = `False`,
		const MDirection &	trackDir = `MDirection(Quantity(0.0,"deg"), Quantity(90.0,"deg"))`
	)			`[virtual]`

void casa::Imager::destroySkyEquation ( ) [protected]

Bool casa::Imager::detached ( ) const [protected]

check if it is dettahced from ms.

String casa::Imager::dQuantitytoString ( const Quantity & dq )

static Bool casa::Imager::expand_blank_sel	(	Vector< Int > &	v,
		const uInt	nelem
	)			`[static]`

Supports the "[] or -1 => everything" convention using the rule: If v is empty or only has 1 element, and it is < 0, replace v with 0, 1, .

.., nelem - 1. Returns whether or not it modified v. If so, v is modified in place.

Bool casa::Imager::feather	(	const String &	image,
		const String &	highres,
		const String &	lowres,
		const String &	lowpsf,
		const Float	dishDiam = `-1.0`,
		const Bool	lowPassFilterSD = `False`
	)

Feathering algorithm.

Bool casa::Imager::filter	(	const String &	type,
		const Quantity &	bmaj,
		const Quantity &	bmin,
		const Quantity &	bpa
	)

Filter the MeasurementSet.

Bool casa::Imager::fitpsf	(	const String &	psf,
		ImageBeamSet &	mbeam
	)

Fit the psf.

String casa::Imager::frmtTime ( const Double time ) [protected]

Bool casa::Imager::ft	(	const Vector< String > &	model,
		const String &	complist,
		Bool	incremental = `False`
	)

Fourier transform the model and componentlist.

Returns its nominal success value.

Bool casa::Imager::getMapExtent	(	const MeasurementSet &	ms,
		const String &	referenceFrame,
		const String &	movingSource,
		const String &	pointingColumn,
		Vector< Double > &	center,
		Vector< Double > &	blc,
		Vector< Double > &	trc,
		Vector< Double > &	extent
	)			`[protected]`

implementation of mapExtent

Bool casa::Imager::getRestFreq	(	Vector< Double > &	restFreq,
		const Int &	spw
	)			`[protected]`

Get the rest frequency ..returns 1 element in restfreq if user specified or try to get the info from the SOURCE table.

Bool casa::Imager::getWeightGrid	(	Block< Matrix< Float > > &	weightgrid,
		const String &	type,
		const Vector< String > &	weightImagenames = `Vector< String >()`
	)

These are utility functions when weights from different imager instances need to reconciled in parallel gridding by different instances of imagers for example.

when type is "imaging" getweightGrid will get the weight density for uniform style imaging weight the Block elements are for different fields if independent field weighting was done. when type is "ftweight"..then a Vector of string is expected in weightimage which is of the same length as the number of models put in clean etc

Record casa::Imager::iClean	(	const String &	algorithm,
		const Int	niter,
		const Double	gain,
		const Quantity &	threshold,
		const Bool	displayprogress,
		const Vector< String > &	model,
		const Vector< Bool > &	keepfixed,
		const String &	complist,
		const Vector< String > &	mask,
		const Vector< String > &	image,
		const Vector< String > &	residual,
		const Vector< String > &	psfnames,
		const Bool	interactive,
		const Int	npercycle,
		const String &	masktemplate
	)

Parameters:

threshold

const String& threshold,

Bool casa::Imager::imagecoordinates	(	CoordinateSystem &	coordInfo,
		const Bool	verbose = `true`
	)

Return the image coordinates.

Bool casa::Imager::imagecoordinates2	(	CoordinateSystem &	coordInfo,
		const Bool	verbose = `true`
	)

new version

String casa::Imager::imageName ( ) [protected]

IPosition casa::Imager::imageshape ( ) const

Return the image shape.

Int casa::Imager::interactivemask	(	const String &	imagename,
		const String &	maskname,
		Int &	niter,
		Int &	ncycles,
		String &	threshold,
		const Bool	forceReload = `False`
	)

Interactive mask drawing forceReload..forces the viewer to dump previous image that is being displayed.

ObsInfo& casa::Imager::latestObsInfo ( )

Bool casa::Imager::linearmosaic	(	const String &	mosaic,
		const String &	fluxscale,
		const String &	sensitivity,
		const Vector< String > &	images,
		const Vector< Int > &	fieldids
	)

Make a linear mosaic of several images.

virtual Bool casa::Imager::lock ( ) [virtual]

Lock the ms and its subtables.

Reimplemented in casa::ImagerMultiMS.

Bool casa::Imager::make ( const String & model )

Make an empty image.

String casa::Imager::make_comp	(	const String &	objName,
		const String &	standard,
		const MEpoch &	mtime,
		const Vector< MFrequency > &	freqv,
		const String &	prefix
	)

Write a component list to disk, starting with prefix, using a setjy standard, and return the name of the list.

String casa::Imager::makeComponentList	(	const String &	fieldName,
		const Int	spwid,
		const Flux< Double > &	fluxval,
		const ComponentShape &	cmp,
		const ConstantSpectrum &	cspectrum
	)			const `[protected]`

Makes a component list on disk containing cmp (with fluxval and cspectrum) named msname_p.fieldName.spw<spwid>.tempcl and returns the name.

Bool casa::Imager::makeEmptyImage	(	CoordinateSystem &	imageCoord,
		String &	name,
		Int	fieldID = `0`
	)

make an empty image

Bool casa::Imager::makeimage	(	const String &	type,
		const String &	imageName,
		const String &	complexImageName = `""`,
		const Bool	verbose = `true`
	)

Make plain image + keep the complex image as well if complexImageName != "".

Bool casa::Imager::makemodelfromsd	(	const String &	sdImage,
		const String &	modelimage,
		const String &	lowPSF,
		String &	maskImage
	)

make a model from a SD image.

This model then can be used as initial clean model to include the shorter spacing.

Bool casa::Imager::makePBImage	(	PBMath &	pbMath,
		ImageInterface< Float > &	pbImage
	)

Bool casa::Imager::makePBImage	(	const CoordinateSystem &	imageCoord,
		PBMath &	pbMath,
		const String &	diskPBName
	)

Bool casa::Imager::makePBImage	(	const Table &	vpTable,
		ImageInterface< Float > &	pbImage
	)

Bool casa::Imager::makePBImage	(	const CoordinateSystem &	imageCoord,
		const Table &	vpTable,
		const String &	diskPBName
	)

Bool casa::Imager::makePBImage	(	const CoordinateSystem &	imageCoord,
		const String &	telescopeName,
		const String &	diskPBName,
		Bool	useSymmetricBeam = `True`,
		Double	dishdiam = `-1.0`
	)

Bool casa::Imager::makePBImage	(	ImageInterface< Float > &	pbImage,
		Bool	useSymmetricBeam = `True`
	)

Functions to make Primary beams.

virtual void casa::Imager::makeVisSet	(	MeasurementSet &	ms,
		Bool	compress = `False`,
		Bool	mosaicOrder = `False`
	)			`[virtual]`

VisSet and resort.

virtual Bool casa::Imager::mapExtent	(	const String &	referenceFrame,
		const String &	movingSource,
		const String &	pointingColumn,
		Vector< Double > &	center,
		Vector< Double > &	blc,
		Vector< Double > &	trc,
		Vector< Double > &	extent
	)			`[virtual]`

Automatic evaluation of map extent for given visibility.

Parameters:

`[in]`	referenceFrame	reference direction frame
`[in]`	movingSource	name of moving source
`[in]`	pointingColumn	pointing column to use
`[out]`	center	center of the map
`[out]`	blc	bottom left corner of the map
`[out]`	trc	top right corner of the map
`[out]`	extent	map extent

Returns:

Reimplemented in casa::ImagerMultiMS.

static Bool casa::Imager::mask	(	const String &	mask,
		const String &	imageName,
		const Quantity &	threshold
	)			`[static]`

Make a mask image.

Bool casa::Imager::mem	(	const String &	algorithm,
		const Int	niter,
		const Quantity &	sigma,
		const Quantity &	targetflux,
		const Bool	constrainflux,
		const Bool	displayProgress,
		const Vector< String > &	model,
		const Vector< Bool > &	fixed,
		const String &	complist,
		const Vector< String > &	prior,
		const Vector< String > &	mask,
		const Vector< String > &	restored,
		const Vector< String > &	residual
	)

MEM algorithm.

String casa::Imager::name ( ) const

Return the name of the MeasurementSet.

Bool casa::Imager::nnls	(	const String &	algorithm,
		const Int	niter,
		const Float	tolerance,
		const Vector< String > &	model,
		const Vector< Bool > &	fixed,
		const String &	complist,
		const Vector< String > &	fluxMask,
		const Vector< String > &	dataMask,
		const Vector< String > &	restored,
		const Vector< String > &	residual
	)

NNLS algorithm.

Bool casa::Imager::nonDefaultLocation ( ) [protected]

returns if mLocation_p is set (= non-default MPosition)

Bool casa::Imager::open	(	MeasurementSet &	thems,
		Bool	compress = `False`,
		Bool	useModel = `False`
	)

Close the current ms, and replace it with the supplied ms.

Optionally compress the attached calibration data columns if they are created here.

void casa::Imager::openSubTable	(	const Table &	otherTable,
		Table &	table,
		const TableLock &	tableLock
	)			`[protected]`

virtual Bool casa::Imager::openSubTables ( ) [virtual]

open all the subtables as userNoReadLock

Reimplemented in casa::ImagerMultiMS.

Imager& casa::Imager::operator= ( const Imager & )

Bool casa::Imager::pb	(	const String &	inimage,
		const String &	outimage,
		const String &	incomps,
		const String &	outcomps,
		const String &	operation,
		const MDirection &	pointngCenter,
		const Quantity &	pa,
		const String &	pborvp
	)

Apply or correct for Primary Beam or Voltage Pattern.

Bool casa::Imager::pbguts	(	ImageInterface< Float > &	in,
		ImageInterface< Float > &	out,
		const MDirection &	,
		const Quantity &
	)			`[protected]`

Bool casa::Imager::pixon	(	const String &	algorithm,
		const Quantity &	sigma,
		const String &	model
	)

pixon algorithm

Bool casa::Imager::plotsummary ( )

Plot a summary.

Bool casa::Imager::plotuv ( const Bool rotate )

Plot the uv plane.

Bool casa::Imager::plotvis	(	const String &	type,
		const Int	increment
	)

Plot the visibilities.

Bool casa::Imager::plotweights	(	const Bool	gridded,
		const Int	increment
	)

Plot the weights.

void casa::Imager::printbeam	(	CleanImageSkyModel *	sm_p,
		LogIO &	os,
		const Bool	firstrun = `true`
	)			`[protected]`

Helper func for printing clean's restoring beam to the logger.

May find the restoring beam as a side effect, so sm_p can't be const.

Bool casa::Imager::regionmask	(	const String &	maskimage,
		Record *	imageRegRec,
		Matrix< Quantity > &	blctrcs,
		Matrix< Float > &	circles,
		const Float &	value = `1.0`
	)

Make a region either from record or array of blc trc (Matrix(nboxes,4)) into a mask image value is the value of the mask pixels circular masks has form Matrix(ncircles,3) where the 3 values on a row are radius, x, y pixel values.

static Bool casa::Imager::regionToImageMask	(	const String &	maskimage,
		Record *	imageRegRec,
		Matrix< Quantity > &	blctrcs,
		Matrix< Float > &	circles,
		const Float &	value = `1.0`
	)			`[static]`

static Bool casa::Imager::regionToMask	(	ImageInterface< Float > &	maskImage,
		ImageRegion &	imagreg,
		const Float &	value = `1.0`
	)			`[static, protected]`

copy imageregion to pixels on image as value given

Bool casa::Imager::removeTable ( const String & tablename ) [protected]

Bool casa::Imager::residual	(	const Vector< String > &	model,
		const String &	complist,
		const Vector< String > &	image
	)

Residual.

Bool casa::Imager::restore	(	const Vector< String > &	model,
		const String &	complist,
		const Vector< String > &	image,
		const Vector< String > &	residual
	)

Restore.

Bool casa::Imager::restoreImages	(	const Vector< String > &	restored,
		Bool	modresiduals = `True`
	)			`[protected]`

virtual void casa::Imager::savePSF ( const Vector< String > & psf ) [protected, virtual]

Bool casa::Imager::selectDataChannel	(	Vector< Int > &	spectralwindowids,
		String &	dataMode,
		Vector< Int > &	dataNchan,
		Vector< Int > &	dataStart,
		Vector< Int > &	dataStep,
		MRadialVelocity &	mDataStart,
		MRadialVelocity &	mDataStep
	)

Utility function to do channel selection.

Bool casa::Imager::sensitivity	(	Quantity &	pointsourcesens,
		Double &	relativesens,
		Double &	sumwt,
		Double &	effectiveBandwidth,
		Double &	effectiveIntegration,
		Int &	mBaselines,
		Matrix< Int > &	mssChanSel,
		Vector< Vector< Int > > &	nData,
		Vector< Vector< Double > > &	sumwtChan,
		Vector< Vector< Double > > &	sumwtsqChan,
		Vector< Vector< Double > > &	sumInverseVarianceChan
	)

Sensitivity.

Bool casa::Imager::setbeam ( const ImageBeamSet & beam )

Setbeam.

virtual void casa::Imager::setClarkCleanImageSkyModel ( ) [inline, protected, virtual]

Definition at line 944 of file Imager.h.

References sm_p.

Bool casa::Imager::setdata	(	const String &	mode,
		const Vector< Int > &	nchan,
		const Vector< Int > &	start,
		const Vector< Int > &	step,
		const MRadialVelocity &	mStart,
		const MRadialVelocity &	mStep,
		const Vector< Int > &	spectralwindowids,
		const Vector< Int > &	fieldid,
		const String &	msSelect = `""`,
		const String &	timerng = `""`,
		const String &	fieldnames = `""`,
		const Vector< Int > &	antIndex = `Vector< Int >()`,
		const String &	antnames = `""`,
		const String &	spwstring = `""`,
		const String &	uvdist = `""`,
		const String &	scan = `""`,
		const String &	intent = `""`,
		const String &	obs = `""`,
		const Bool	usemodelCol = `False`,
		const Bool	be_calm = `false`
	)

Select some data.

Sets nullSelect_p and returns !nullSelect_p. be_calm: lowers the logging level of some messages if True.

virtual Bool casa::Imager::setDataPerMS	(	const String &	msname,
		const String &	mode,
		const Vector< Int > &	nchan,
		const Vector< Int > &	start,
		const Vector< Int > &	step,
		const Vector< Int > &	spectralwindowids,
		const Vector< Int > &	fieldid,
		const String &	msSelect = `""`,
		const String &	timerng = `""`,
		const String &	fieldnames = `""`,
		const Vector< Int > &	antIndex = `Vector< Int >()`,
		const String &	antnames = `""`,
		const String &	spwstring = `""`,
		const String &	uvdist = `""`,
		const String &	scan = `""`,
		const String &	intent = `""`,
		const String &	obs = `""`,
		const Bool	useModelCol = `False`,
		const Bool	readonly = `False`
	)			`[virtual]`

Set the data selection parameters.

The parameters useModelcol and readonly is dummy here as they are useful for the ImagerMultiMS version only

Reimplemented in casa::ImagerMultiMS.

virtual Bool casa::Imager::setimage	(	const Int	nx,
		const Int	ny,
		const Quantity &	cellx,
		const Quantity &	celly,
		const String &	stokes,
		Bool	doShift,
		const MDirection &	phaseCenter,
		const Quantity &	shiftx,
		const Quantity &	shifty,
		const String &	mode,
		const Int	nchan,
		const Int	start,
		const Int	step,
		const MRadialVelocity &	mStart,
		const MRadialVelocity &	mStep,
		const Vector< Int > &	spectralwindowids,
		const Int	fieldid,
		const Int	facets,
		const Quantity &	distance
	)			`[virtual]`

The following setup methods define the state of the imager.

Set image construction parameters

Reimplemented in casa::ImagerMultiMS.

virtual void casa::Imager::setImageParam	(	Int &	nx,
		Int &	ny,
		Int &	npol,
		Int &	nchan
	)			`[virtual]`

Record casa::Imager::setjy	(	const Vector< Int > &	fieldid,
		const Vector< Int > &	spectralwindowid,
		const String &	fieldnames,
		const String &	spwstring,
		const String &	model,
		const Vector< Double > &	fluxDensity,
		const String &	standard,
		const Bool	chanDep = `False`,
		const Vector< Double > &	spix = `Vector< Double >()`,
		const MFrequency &	reffreq = `MFrequency(Quantity(1.0,"GHz"), MFrequency::LSRK)`,
		const Vector< Double > &	pipars = `Vector< Double >()`,
		const Vector< Double > &	papars = `Vector< Double >()`,
		const Double &	rotMeas = `0.0`,
		const String &	timerange = `""`,
		const String &	scanstr = `""`,
		const String &	intentstr = `""`,
		const String &	obsidstr = `""`,
		const String &	interpolation = `"nearest"`
	)

Setjy with model image.

If chanDep=True then the scaling is calculated on a per channel basis for the model image...otherwise the whole spw gets the same flux density. Bool setjy(const Vector<Int>& fieldid,

Bool casa::Imager::setjy	(	const Vector< Int > &	fieldid,
		const Vector< Int > &	spectralwindowid,
		const String &	fieldnames,
		const String &	spwstring,
		const Vector< Double > &	fluxDensity,
		const String &	standard
	)

Bool casa::Imager::setjy	(	const Int	fieldid,
		const Int	spectralwindowid,
		const Vector< Double > &	fluxDensity,
		const String &	standard
	)

Compute the model visibility using specified source flux densities.

Bool casa::Imager::setmfcontrol	(	const Float	cyclefactor,
		const Float	cyclespeedup,
		const Float	cyclemaxpsffraction,
		const Int	stoplargenegatives,
		const Int	stoppointmode,
		const String &	scaleType,
		const Float	minPB,
		const Float	constPB,
		const Vector< String > &	fluxscale,
		const Bool	flatnoise = `True`
	)

Multi-field control parameters flat noise is the parameter that control the search of clean components in a flat noise image or an optimum beam^2 image.

virtual void casa::Imager::setMosaicFTMachine ( Bool useDoublePrec = False ) [protected, virtual]

set the mosaic ft machine and right convolution function

void casa::Imager::setObsInfo ( ObsInfo & obsinfo )

Bool casa::Imager::setoptions	(	const String &	ftmachine,
		const Long	cache,
		const Int	tile,
		const String &	gridfunction,
		const MPosition &	mLocation,
		const Float	padding,
		const Int	wprojplanes = `-1`,
		const String &	epJTableName = `""`,
		const Bool	applyPointingOffsets = `True`,
		const Bool	doPointingCorrection = `True`,
		const String &	cfCacheDirName = `""`,
		const Float &	rotpastep = `5.0`,
		const Float &	computepastep = `360.0`,
		const Float &	pbLimit = `5.0e-2`,
		const String &	freqinterpmethod = `"linear"`,
		const Int	imageTileSizeInPix = `0`,
		const Bool	singleprecisiononly = `False`,
		const Int	numthreads = `-1`,
		const Bool	psTermOn = `True`,
		const Bool	aTermOn = `True`,
		const Bool	mTermOn = `False`,
		const Bool	wbAWP = `False`,
		const Bool	conjBeams = `True`
	)

Set the processing options.

Bool casa::Imager::setscales	(	const String &	scaleMethod,
		const Int	inscales,
		const Vector< Float > &	userScaleSizes
	)

Set the scales to be searched in Multi Scale clean.

Bool casa::Imager::setsdoptions	(	const Float	scale,
		const Float	weight,
		const Int	convsupport = `-1`,
		String	pointingColToUse = `"DIRECTION"`,
		const Quantity	truncate = `Quantity()`,
		const Quantity	gwidth = `Quantity()`,
		const Quantity	jwidth = `Quantity()`,
		const Float	minweight = `0.`,
		const Bool	clipminmax = `False`
	)

Set the single dish processing options.

virtual void casa::Imager::setSkyEquation ( ) [protected, virtual]

Bool casa::Imager::setSmallScaleBias ( const Float inbias )

set bias

Bool casa::Imager::settaylorterms	(	const Int	intaylor,
		const Double	inreffreq
	)

Set the number of taylor series terms in the expansion of the image as a function of frequency.

Bool casa::Imager::setvp	(	const Bool	dovp,
		const Bool	defaultVP,
		const String &	vpTable,
		const Bool	doSquint,
		const Quantity &	parAngleInc,
		const Quantity &	skyPosThreshold,
		String	defaultTel = `""`,
		const Bool	verbose = `true`
	)

Set the voltage pattern.

Bool casa::Imager::setWeightGrid	(	const Block< Matrix< Float > > &	weightgrid,
		const String &	type
	)

virtual void casa::Imager::setWFCleanImageSkyModel ( ) [inline, protected, virtual]

Virtual methods to set the ImageSkyModel and SkyEquation.

This allows derived class pimager to set parallelized specializations.

Definition at line 941 of file Imager.h.

References facets_p, sm_p, and wfGridding_p.

Bool casa::Imager::sjy_calciflux	(	const Vector< MFrequency > &	freqs,
		const MFrequency &	reffreq,
		const Double	refflux,
		const Vector< Double > &	vspix,
		Vector< Double > &	iflux
	)			`[protected]`

Bool casa::Imager::sjy_calcquflux	(	const Vector< Double > &	pipars,
		const Vector< Double > &	papars,
		const Vector< Double > &	iflux,
		const Double	rotMeas,
		const Vector< MFrequency > &	freqs,
		const MFrequency &	reffreq,
		Vector< Double > &	qflux,
		Vector< Double > &	uflux
	)			`[protected]`

Bool casa::Imager::sjy_computeFlux	(	LogIO &	os,
		FluxStandard &	fluxStd,
		Vector< Vector< Flux< Double > > > &	returnFluxes,
		Vector< Vector< Flux< Double > > > &	returnFluxErrs,
		Vector< String > &	tempCLs,
		Vector< Vector< Double > > &	fluxUsed,
		String &	fluxScaleName,
		MEpoch &	aveEpoch,
		const Vector< Vector< MFrequency > > &	mfreqs,
		const String &	model,
		const String &	fieldName,
		const ROMSColumns &	msc,
		const Int	fldid,
		const MDirection &	fieldDir,
		const Vector< Int > &	selToRawSpwIds,
		const String &	standard
	)			`[protected]`

Returns whether it found a source.

Parameters:

fluxUsed

Vector<Double>& fluxUsed,

Bool casa::Imager::sjy_concatComponentLists	(	LogIO &	os,
		const Vector< String > &	tempCLs,
		const String &	outTempCL
	)			`[protected]`

Concatenate multiple CLs.

Bool casa::Imager::sjy_make_visibilities	(	TempImage< Float > *	tmodimage,
		LogIO &	os,
		const Int	rawspwid,
		const Int	fldid,
		const String &	clname,
		const String &	timerange = `""`,
		const String &	scanstr = `""`,
		const String &	obsidstr = `""`,
		const String &	intentstr = `""`,
		const Vector< Double > &	freqofscale = `Vector< Double >(0)`,
		const Vector< Double > &	scale = `Vector< Double >(0)`
	)			`[protected]`

Returns whether it might have made any visibilities.

Parameters:

rawspwid

Bool sjy_make_visibilities(Block<CountedPtr<TempImage<Float> > >& tmodimages, LogIO& os, const Int rawspwid, const Int fldid, for new one const Vector<Int>& rawspwids, const Int fldid,

void casa::Imager::sjy_makeComponentList	(	LogIO &	os,
		Vector< String > &	tempCLs,
		Vector< Vector< Flux< Double > > > &	returnFluxes,
		const Vector< Double > &	fluxUsed,
		const Vector< Int > &	selToRawSpwIds,
		const Vector< Vector< MFrequency > > &	mfreqs,
		const String &	fieldName,
		const MDirection &	fieldDir,
		const Vector< Double > &	spix,
		const Vector< Double > &	pipars,
		const Vector< Double > &	papars,
		const Double &	rotMeas,
		const MFrequency &	reffreq,
		const MEpoch &	aveEpoch,
		const Int	fldId
	)			`[protected]`

Parameters:

reffreq

const Vector<Double>& cppars,

TempImage<Float>* casa::Imager::sjy_prepImage	(	LogIO &	os,
		FluxStandard &	fluxStd,
		Vector< Double > &	fluxUsed,
		Vector< Double > &	freq,
		Vector< Double > &	scale,
		const String &	model,
		const ROMSSpWindowColumns &	spwcols,
		const Vector< Int >	rawspwids,
		const Bool	chanDep,
		const Vector< Vector< MFrequency > > &	mfreqs,
		const String &	fieldName,
		const MDirection &	fieldDir,
		const Unit &	freqUnit,
		const Vector< Double > &	fluxdens,
		const Bool	precompute,
		const Vector< Double > &	spix,
		const MFrequency &	reffreq,
		const MEpoch &	aveEpoch,
		const Int	fieldId
	)			`[protected]`

Returns NULL if no image is prepared.

Parameters:

	rawspwids	const Int rawspwid, const Bool chanDep,
	fieldName	const uInt selspw, const String& fieldName,
	spix	const Double spix,

Bool casa::Imager::sjy_regridCubeChans	(	TempImage< Float > *	tmodimage,
		PagedImage< Float > &	modimage,
		Int	freqAxis
	)			`[protected]`

Returns True or throws up.

Bool casa::Imager::sjy_setRadiusLimit	(	TempImage< Float > *	tmodimage,
		PagedImage< Float > &	modimage,
		const String &	model,
		DirectionCoordinate &	dircsys
	)			`[protected]`

set a radius limit if the model image is one of the known source otherwise simply copy modimage to tmodimage

Unit casa::Imager::sjy_setup_arrs	(	Vector< Vector< Flux< Double > > > &	returnFluxes,
		Vector< Vector< Flux< Double > > > &	returnFluxErrs,
		Vector< Vector< Double > > &	fluxUsed,
		Vector< String > &	tempCLs,
		Vector< Vector< MFrequency > > &	mfreqs,
		const ROMSSpWindowColumns &	spwcols,
		const uInt	nspws,
		const Vector< Int > &	selToRawSpwIds,
		const Bool	chanDep
	)			`[protected]`

Helper functions to hide some setjy code.

Bool casa::Imager::smooth	(	const Vector< String > &	model,
		const Vector< String > &	image,
		Bool	usefit,
		ImageBeamSet &	mbeam,
		Bool	normalizeVolume
	)

Smooth.

String casa::Imager::state ( )

Return the state of the object as a string.

Bool casa::Imager::summary ( )

Output a summary of the state of the object.

String casa::Imager::tangentPoint ( ) [protected]

Helper func for createFTMachine().

Returns phaseCenter_p as a String, assuming* it is set. It does not check!

static void casa::Imager::transferHistory	(	LoggerHolder &	imageLog,
		ROMSHistoryColumns &	msHis
	)			`[static]`

Helper function to transfer history table to a logger holder which can be stored in images.

virtual Bool casa::Imager::unlock ( ) [virtual]

Unlock the ms and its subtables.

Reimplemented in casa::ImagerMultiMS.

Bool casa::Imager::updateresidual	(	const Vector< String > &	model,
		const String &	complist,
		const Vector< String > &	image,
		const Vector< String > &	residual
	)

similar to restore except this is to be called if you fiddle with the model and complist outside of this object (say you clip stuff etc) ...keep the sm_p and se_p state but just calculate new residuals and restored images.

Will throw an exception is se_p or sm_p is not valid (i.e you should have used clean, mem etc before hand).

Bool casa::Imager::updateSkyModel	(	const Vector< String > &	model,
		const String	complist
	)			`[protected]`

Bool casa::Imager::uvrange	(	const Double &	uvmin,
		const Double &	uvmax
	)

Apply a uvrange.

Bool casa::Imager::valid ( ) const

Check if can proceed with this object.

Bool casa::Imager::weight	(	const String &	algorithm,
		const String &	rmode,
		const Quantity &	noise,
		const Double	robust,
		const Quantity &	fieldofview,
		const Int	npixels,
		const Bool	multiField = `False`
	)