Public Member Functions
def	__init__
def	initsinglems
def	initmultims
def	sortvislist
def	defineimages
def	definemultiimages
def	checkpsf
def	makeEmptyimages
def	makemultifieldmask
def	makemultifieldmask2
def	make_mask_from_threshhold
def	makemaskimage
def	datselweightfilter
def	datsel
def	datweightfilter
def	setrestoringbeam
def	convertmodelimage
def	readboxfile
def	readmultifieldboxfile
def	readoutlier
def	newreadoutlier
def	copymaskimage
def	flatten
def	getchanimage
def	putchanimage
def	qatostring
def	convertvf
def	getfreqs
def	setChannelizeDefault
def	setChannelizeNonDefault
def	convertframe
def	setspecframe
def	initChaniter
def	makeTemplateCubes
def	setChaniterParms
def	defineChaniterModelimages
def	convertAllModelImages_old
def	convertAllModelImages
	Multiple models for one field : [ [ 'm0', 'm1' ] ] Multiple taylor terms and one field : [ [ 't0','t1'] ] Multiple models per field : [ [ 'm0f0', 'm1f0' ] , [ 'm0f1', 'm1f1' ] ] Multiple taylor terms per field : [ [ 't0f0','t1f0' ] , [ 't0f1','t1f1' ] ].
def	storeCubeImages
def	cleanupTempFiles
def	convertImageFreqFrame
Static Public Member Functions
def	getspwtable
def	getOptimumSize
Public Attributes
	maskimages
	finalimages
	usescratch
	dataspecframe
	usespecframe
	end spwindex
	inframe
	srcdir
	sortedvislist
	im
	vis
	sortedvisindx
	phasecenter
	check that start and step have units
	spwindex
	understand spw
	fieldindex
	outputmask
	This goes when those tablerecord goes Make masks from tablerecords.
	csys
	This code to set the maskframe is copied from makemaskimages()
	nimages
	imagelist
	imageids
	if len(imageids) > 1: multifield=True
	skipclean
	csysorder
	paramlist
Private Member Functions
def	_selectlistinputs
Private Attributes
	_casalog

Detailed Description

Definition at line 20 of file cleanhelper.py.

Constructor & Destructor Documentation

def cleanhelper.cleanhelper.__init__	(	self,
		imtool = `''`,
		vis = `''`,
		usescratch = `False`,
		casalog = `None`
	)

Contruct the cleanhelper object with an imager tool
like so:
a=cleanhelper(im, vis)

Definition at line 21 of file cleanhelper.py.

References cleanhelper.cleanhelper.initmultims(), and cleanhelper.cleanhelper.initsinglems().

Member Function Documentation

def cleanhelper.cleanhelper._selectlistinputs	(	self,
		nvis,
		indx,
		params
	)	`[private]`

A little private function to do selection and checking for a parameter 
given in list of strings.
It checks nelement in each param either match with nvis or nelement=1
(or a string) otherwise exception is thrown.

Definition at line 1065 of file cleanhelper.py.

References cleanhelper.cleanhelper.datweightfilter().

def cleanhelper.cleanhelper.checkpsf	(	self,
		chan
	)

a check to make sure selected channel plane is not entirely flagged
(for chinter=T interactive clean)

Definition at line 389 of file cleanhelper.py.

References cleanhelper.cleanhelper.finalimages, cleanhelper.cleanhelper.getchanimage(), cleanhelper.cleanhelper.imagelist, and cleanhelper.cleanhelper.skipclean.

def cleanhelper.cleanhelper.cleanupTempFiles	(	self,
		tmppath
	)

Remove the directories listed by tmppath.

Definition at line 3089 of file cleanhelper.py.

Referenced by cleanhelper.cleanhelper.defineChaniterModelimages().

def cleanhelper.cleanhelper.convertAllModelImages	(	self,
		modelimage,
		mode,
		nterms,
		dochaniter,
		chan,
		tmppath
	)

Multiple models for one field : [ [ 'm0', 'm1' ] ] Multiple taylor terms and one field : [ [ 't0','t1'] ] Multiple models per field : [ [ 'm0f0', 'm1f0' ] , [ 'm0f1', 'm1f1' ] ] Multiple taylor terms per field : [ [ 't0f0','t1f0' ] , [ 't0f1','t1f1' ] ].

Cannot do multiple models per taylor term and per field for now. ....... later... [ [ ['m0t0f0','m1t0f0'],['m0t1f0','m1t1f0'] ] , [ [ ['t0f1'] ],[ ['t1f1'] ] ] ]

wrapper function for convertmodelimage for all different cases

Definition at line 3001 of file cleanhelper.py.

References make_mmsdata.all, cleanhelper.cleanhelper.convertmodelimage(), cleanhelper.cleanhelper.defineChaniterModelimages(), and cleanhelper.cleanhelper.imagelist.

def cleanhelper.cleanhelper.convertAllModelImages_old	(	self,
		modelimage,
		mode,
		nterms,
		dochaniter,
		chan,
		tmppath
	)

wrapper function for convertmodelimage for all different cases

Definition at line 2965 of file cleanhelper.py.

References make_mmsdata.all, cleanhelper.cleanhelper.convertmodelimage(), cleanhelper.cleanhelper.defineChaniterModelimages(), and cleanhelper.cleanhelper.imagelist.

def cleanhelper.cleanhelper.convertframe	(	self,
		fin,
		frame,
		field
	)

(not in use: its caller is setChannelization...)
convert freq frame in dataframe to specfied frame, assume fin in Hz
retruns converted freq in Hz (value only)

Definition at line 2535 of file cleanhelper.py.

References cleanhelper.cleanhelper.dataspecframe, cleanhelper.cleanhelper.sortedvisindx, cleanhelper.cleanhelper.srcdir, and cleanhelper.cleanhelper.vis.

def cleanhelper.cleanhelper.convertImageFreqFrame	(	self,
		imlist
	)

Convert output images to proper output frame
(after im.clean() executed)

Definition at line 3099 of file cleanhelper.py.

References cleanhelper.cleanhelper.dataspecframe, and cleanhelper.cleanhelper.usespecframe.

def cleanhelper.cleanhelper.convertmodelimage	(	self,
		modelimages = `[]`,
		outputmodel = `''`,
		imindex = `0`
	)

Convert model inputs to a model image

Keyword arguments:
modleimages -- input model list
outputmodel -- outout modelimage name
imindex     -- image name index (corresponding to imagelist) 
       for multi field hanlding

Definition at line 1187 of file cleanhelper.py.

References cleanhelper.cleanhelper.imagelist, cleanhelper.cleanhelper.makemaskimage(), irc_cs_task_regression.max, and cleanhelper.cleanhelper.outputmask.

Referenced by cleanhelper.cleanhelper.convertAllModelImages(), cleanhelper.cleanhelper.convertAllModelImages_old(), and cleanhelper.cleanhelper.defineChaniterModelimages().

def cleanhelper.cleanhelper.convertvf	(	self,
		vf,
		frame,
		field,
		restf,
		veltype = `'radio'`
	)

returns doppler(velocity) or frequency in string
currently use first rest frequency
Assume input vf (velocity or fequency in a string) and 
output are the same 'frame'.

Definition at line 1883 of file cleanhelper.py.

References cleanhelper.cleanhelper.dataspecframe, cleanhelper.cleanhelper.sortedvisindx, and cleanhelper.cleanhelper.vis.

Referenced by cleanhelper.cleanhelper.setChannelizeDefault(), and cleanhelper.cleanhelper.setChannelizeNonDefault().

def cleanhelper.cleanhelper.copymaskimage	(	self,
		maskimage,
		shp,
		outfile
	)

Copy mask image

Keyword arguments:
maskimage -- input maskimage 
shp       -- shape of output image 
outfile   -- output image name

Definition at line 1749 of file cleanhelper.py.

References cleanhelper.cleanhelper.csys.

def cleanhelper.cleanhelper.datsel	(	self,
		field,
		spw,
		timerange,
		uvrange,
		antenna,
		scan,
		observation,
		usescratch,
		nchan = `-1`,
		start = `0`,
		width = `1`
	)

Make selections in visibility data

Definition at line 1008 of file cleanhelper.py.

References cleanhelper.cleanhelper.fieldindex, and cleanhelper.cleanhelper.sortedvisindx.

Referenced by cleanhelper.cleanhelper.datselweightfilter(), and cleanhelper.cleanhelper.makeTemplateCubes().

def cleanhelper.cleanhelper.datselweightfilter	(	self,
		field,
		spw,
		timerange,
		uvrange,
		antenna,
		scan,
		wgttype,
		robust,
		noise,
		npixels,
		mosweight,
		innertaper,
		outertaper,
		usescratch,
		nchan = `-1`,
		start = `0`,
		width = `1`
	)

Make data selection 
(not in use, split into datsel and  datweightfileter)

Definition at line 970 of file cleanhelper.py.

References cleanhelper.cleanhelper.datsel(), cleanhelper.cleanhelper.fieldindex, and cleanhelper.cleanhelper.vis.

def cleanhelper.cleanhelper.datweightfilter	(	self,
		field,
		spw,
		timerange,
		uvrange,
		antenna,
		scan,
		wgttype,
		robust,
		noise,
		npixels,
		mosweight,
		uvtaper,
		innertaper,
		outertaper,
		usescratch,
		nchan = `-1`,
		start = `0`,
		width = `1`
	)

Apply weighting and tapering

Definition at line 1097 of file cleanhelper.py.

Referenced by cleanhelper.cleanhelper._selectlistinputs(), and cleanhelper.cleanhelper.makeTemplateCubes().

def cleanhelper.cleanhelper.defineChaniterModelimages	(	self,
		modelimage,
		chan,
		tmppath
	)

chaniter=T specific function to convert input models 
to a model image

Definition at line 2923 of file cleanhelper.py.

References cleanhelper.cleanhelper.cleanupTempFiles(), cleanhelper.cleanhelper.convertmodelimage(), and cleanhelper.cleanhelper.getchanimage().

Referenced by cleanhelper.cleanhelper.convertAllModelImages(), and cleanhelper.cleanhelper.convertAllModelImages_old().

def cleanhelper.cleanhelper.defineimages	(	self,
		imsize,
		cell,
		stokes,
		mode,
		spw,
		nchan,
		start,
		width,
		restfreq,
		field,
		phasecenter,
		facets = `1`,
		outframe = `''`,
		veltype = `'radio'`
	)

Define image parameters -calls im.defineimage.
for processing a single field 
(also called by definemultiimages for multifield)

Definition at line 165 of file cleanhelper.py.

References cleanhelper.cleanhelper.dataspecframe, cleanhelper.cleanhelper.definemultiimages(), cleanhelper.cleanhelper.phasecenter, cleanhelper.cleanhelper.sortedvisindx, cleanhelper.cleanhelper.spwindex, cleanhelper.cleanhelper.usespecframe, and cleanhelper.cleanhelper.vis.

Referenced by cleanhelper.cleanhelper.sortvislist().

def cleanhelper.cleanhelper.definemultiimages	(	self,
		rootname,
		imsizes,
		cell,
		stokes,
		mode,
		spw,
		nchan,
		start,
		width,
		restfreq,
		field,
		phasecenters,
		names = `[]`,
		facets = `1`,
		outframe = `''`,
		veltype = `'radio'`,
		makepbim = `False`,
		checkpsf = `False`
	)

Define image parameters - multiple field version
This fucntion set "private" variables (imagelist and imageids),
and then calls defineimages for ecah field.

Definition at line 302 of file cleanhelper.py.

Referenced by cleanhelper.cleanhelper.defineimages(), and cleanhelper.cleanhelper.makeTemplateCubes().

def cleanhelper.cleanhelper.flatten	(	self,
		l
	)

A utility function to flatten nested lists 
but allow nesting of [[elm1,elm2,elm3],[elm4,elm5],[elm6,elm7]]
to handle multifield masks.
This does not flatten if an element is a list of int or float. 
And also leave empty list as is.

Definition at line 1799 of file cleanhelper.py.

References cleanhelper.cleanhelper.flatten(), and tests.test_imcontsub.list.

Referenced by cleanhelper.cleanhelper.flatten(), and cleanhelper.cleanhelper.makemultifieldmask2().

def cleanhelper.cleanhelper.getchanimage	(	self,
		cubeimage,
		outim,
		chan
	)

Create a slice of channel image from cubeimage

Keyword arguments:
cubeimage -- input image cube
outim     -- output sliced image
chan      -- nth channel

Definition at line 1823 of file cleanhelper.py.

Referenced by cleanhelper.cleanhelper.checkpsf(), cleanhelper.cleanhelper.defineChaniterModelimages(), and parallel.parallel_cont.imagecont.imagechan_new().

def cleanhelper.cleanhelper.getfreqs	(	self,
		nchan,
		spw,
		start,
		width,
		dummy = `False`
	)

(not in used - currently commented out in its caller, initChaniter()) 
returns a list of frequencies to be used in output clean image
if width = -1, start is actually end (max) freq

Definition at line 1956 of file cleanhelper.py.

References cleanhelper.cleanhelper.dataspecframe, cleanhelper.cleanhelper.getspwtable(), cleanhelper.cleanhelper.sortedvisindx, and cleanhelper.cleanhelper.vis.

def cleanhelper.cleanhelper.getOptimumSize ( size ) [static]

This returns the next largest even composite of 2, 3, 5, 7

Definition at line 3121 of file cleanhelper.py.

def cleanhelper.cleanhelper.getspwtable ( visname = '' ) [static]

Definition at line 55 of file cleanhelper.py.

Referenced by cleanhelper.cleanhelper.getfreqs(), cleanhelper.cleanhelper.setChannelizeDefault(), cleanhelper.cleanhelper.setChannelizeNonDefault(), cleanhelper.cleanhelper.setspecframe(), and cleanhelper.cleanhelper.sortvislist().

def cleanhelper.cleanhelper.initChaniter	(	self,
		nchan,
		spw,
		start,
		width,
		imagename,
		mode,
		tmpdir = `'_tmpimdir/'`
	)

initialize for channel iteration in interactive clean
--- create a temporary directory, get frequencies for
mode='channel'
       
Keyword arguments:
nchan -- no. channels
spw   -- spw 
start -- start modified after channelization function 
width -- width modified after channelization function
imagename -- from task input 
mode  -- from task input
tmpdir -- temporary directory name to store channel images

returns: 
frequencies in a list
frequency increment
newmode -- force to set mode to frequency
tmppath -- path for the temporary directory

Definition at line 2638 of file cleanhelper.py.

References cleanhelper.cleanhelper.makeTemplateCubes().

def cleanhelper.cleanhelper.initmultims	(	self,
		imtool,
		vislist,
		usescratch
	)

initialization for multi-mses

Definition at line 84 of file cleanhelper.py.

References cleanhelper.cleanhelper.csys, cleanhelper.cleanhelper.fieldindex, cleanhelper.cleanhelper.im, cleanhelper.cleanhelper.outputmask, cleanhelper.cleanhelper.phasecenter, cleanhelper.cleanhelper.spwindex, and cleanhelper.cleanhelper.vis.

Referenced by cleanhelper.cleanhelper.__init__().

def cleanhelper.cleanhelper.initsinglems	(	self,
		imtool,
		vis,
		usescratch
	)

initialization for single ms case

Definition at line 64 of file cleanhelper.py.

Referenced by cleanhelper.cleanhelper.__init__().

def cleanhelper.cleanhelper.make_mask_from_threshhold	(	self,
		imagename,
		thresh,
		outputmask = `None`
	)

Makes a mask image with the same coords as imagename where each
pixel is True if and only if the corresponding pixel in imagename
is >= thresh.

The mask will be named outputmask (if provided) or imagename +
'.thresh_mask'.  The name is returned on success, or False on failure.

Definition at line 722 of file cleanhelper.py.

def cleanhelper.cleanhelper.makeEmptyimages ( self )

Create empty images (0.0 pixel values) for 
image, residual, psf
must run after definemultiimages()
and it is assumed that definemultiimages creates 
empty images (self.imagelist).

Definition at line 416 of file cleanhelper.py.

References cleanhelper.cleanhelper.imagelist, and cleanhelper.cleanhelper.nimages.

def cleanhelper.cleanhelper.makemaskimage	(	self,
		outputmask = `''`,
		imagename = `''`,
		maskobject = `[]`,
		slice = `-1`
	)

This function is an attempt to convert all the kind of 'masks' that
people want to throw at it and convert it to a mask image to be used
by imager...For now 'masks' include

a)set of previous mask images
b)lists of blc trc's
c)record output from rg tool for e.g

* for a single field

Definition at line 759 of file cleanhelper.py.

References cleanhelper.convert_numpydtype(), cleanhelper.cleanhelper.csys, and cleanhelper.cleanhelper.imagelist.

Referenced by cleanhelper.cleanhelper.convertmodelimage(), and cleanhelper.cleanhelper.makemultifieldmask2().

def cleanhelper.cleanhelper.makemultifieldmask	(	self,
		maskobject = `''`
	)

This function assumes that the function definemultiimages has been run and thus
self.imagelist is defined
if single image use the single image version
(this is not up to date for current mask handling but used in task_widefield,
 to be removed after task_widefield is gone)

Definition at line 433 of file cleanhelper.py.

References cleanhelper.cleanhelper.imageids, cleanhelper.cleanhelper.imagelist, cleanhelper.cleanhelper.maskimages, and cleanhelper.cleanhelper.readmultifieldboxfile().

def cleanhelper.cleanhelper.makemultifieldmask2	(	self,
		maskobject = `''`,
		slice = `-1`,
		newformat = `True`,
		interactive = `False`
	)

Create mask images for multiple fields (flanking fields) 
This new makemultifieldmask to accomodate different kinds of masks supported
in clean with flanking fields.

Keyword arguments:
maskobject -- input mask, a list (of string or of list(s)) or a string 
slice      -- channel slice (to handle chaniter mode): default = -1 (all)
newformat  -- if mask is read from new format text file: default = True 

Prerequiste: definemultiimages has already ran so that imagelist is defined 
       
Notes: 
* It makes empty mask images at begenning, calls makemaskimage, and if no
  mask to be specified, the corresponding empty mask image is removed
  
* When clean is executed in commnad line style (e.g. clean(vis='..', ..))
  it is possible to have mask parameter consists of a mix of strings and int lists
  (i.e. mask=[['newreg.txt',[55,55,65,70]],['outliermask.rgn']]), and this function
  should be able to parse these properly. - although this won't work for the task execution
  by go() and tends to messed up inp() after such execution 
 
* Currently it is made to handle old outlier text file format and boxfile-style
  mask box specification for backward compartibility. But it is planned to
  be removed for 3.4.

* This is a refactored version of the previous makemultifieldmask2
  and  calls makemaskimage() for each field. 
  this was called makemultifieldmask3 in CASA 3.3 release but now renamed 
  makemultifieldmask2 as the previous makemultifieldmask2 was removed.

Definition at line 499 of file cleanhelper.py.

References make_mmsdata.all, nf_regression.append, cleanhelper.cleanhelper.csys, cleanhelper.cleanhelper.dataspecframe, cleanhelper.cleanhelper.flatten(), cleanhelper.cleanhelper.imageids, cleanhelper.cleanhelper.imagelist, cleanhelper.cleanhelper.makemaskimage(), cleanhelper.cleanhelper.maskimages, cleanhelper.cleanhelper.outputmask, cleanhelper.cleanhelper.readmultifieldboxfile(), pCASA.remove(), and cleanhelper.cleanhelper.usespecframe.

def cleanhelper.cleanhelper.makeTemplateCubes	(	self,
		imagename,
		outlierfile,
		field,
		spw,
		selectdata,
		timerange,
		uvrange,
		antenna,
		scan,
		observation,
		mode,
		facets,
		cfcache,
		interpolation,
		imagermode,
		localFTMachine,
		mosweight,
		locnchan,
		locstart,
		locwidth,
		outframe,
		veltype,
		imsize,
		cell,
		phasecenter,
		restfreq,
		stokes,
		weighting,
		robust,
		uvtaper,
		outertaper,
		innertaper,
		modelimage,
		restoringbeam,
		usescratch,
		noise,
		npixels,
		padding
	)

make template cubes to be used for chaniter=T interactive clean

Definition at line 2705 of file cleanhelper.py.

References cleanhelper.cleanhelper.datsel(), cleanhelper.cleanhelper.datweightfilter(), cleanhelper.cleanhelper.definemultiimages(), cleanhelper.cleanhelper.imageids, cleanhelper.cleanhelper.imagelist, and cleanhelper.cleanhelper.newreadoutlier().

Referenced by cleanhelper.cleanhelper.initChaniter().

def cleanhelper.cleanhelper.newreadoutlier	(	self,
		outlierfile
	)

Read a outlier file (both old and new format) 
 
The new format consists of a set of task parameter inputs.
imagename="outlier1" imsize=[128,128] phasecenter="J2000 hhmmss.s ddmmss.s" 
imagename="outlier2" imsize=[128,128] phasecenter="J2000 hhmmss.s ddmmss.s"
mask=['viewermask.rgn','box[[50,60],[50,60]]'] ...

Currently supported paramters are:
imagename (required: used to delinate a paramater set for each field)
imsize (required)
phasecenter (required)
mask (optional)
modelimage (optional) 
* other parameters can be included in the file but not parsed

For the old format, readoutlier() is called internally currently. But
the support will be removed by CASA3.4. 

Returns:
lists of imageids, imsizes, phasecenters, masks, 
and modelimages, and a dictionary contains all the parameters,
and a boolean to indicate read file is in the new format.

Definition at line 1584 of file cleanhelper.py.

References asap.asapmath.keys, and cleanhelper.cleanhelper.readoutlier().

Referenced by cleanhelper.cleanhelper.makeTemplateCubes().

def cleanhelper.cleanhelper.putchanimage	(	self,
		cubimage,
		inim,
		chan
	)

Put channel image back to a pre-exisiting cubeimage
 
Keyword arguments:
cubimage -- image cube
inim     -- input channel image 
chan     -- nth channel

Definition at line 1846 of file cleanhelper.py.

Referenced by parallel.parallel_cont.imagecont.cleanupcubeimages(), parallel.parallel_cont.imagecont.cleanupmodelimages(), parallel.parallel_cont.imagecont.cleanupresidualimages(), parallel.parallel_cont.imagecont.cleanuprestoredimages(), and cleanhelper.cleanhelper.storeCubeImages().

def cleanhelper.cleanhelper.qatostring	(	self,
		q
	)

A utility function to return a quantity in string
(currently only used in setChannelization which is deprecated)

Definition at line 1874 of file cleanhelper.py.

def cleanhelper.cleanhelper.readboxfile	(	self,
		boxfile
	)

Read a file containing clean boxes (compliant with AIPS BOXFILE)

Format is:
#FIELDID BLC-X BLC-Y TRC-X TRC-Y
0       110   110   150   150 
or
0       hh:mm:ss.s dd.mm.ss.s hh:mm:ss.s dd.mm.ss.s

Note all lines beginning with '#' are ignored.

Definition at line 1301 of file cleanhelper.py.

References cleanhelper.cleanhelper.csys, and cleanhelper.cleanhelper.csysorder.

def cleanhelper.cleanhelper.readmultifieldboxfile	(	self,
		boxfiles
	)

Read boxes and circles in text files in the 
AIPS clean boxfile format.

Keyword arguments:
boxfiles -- text files in boxfile format

returns:
circles -- dictionary containing circles      
boxes   -- dictionary conatining boxes ([blc, trc])
oldfileformats -- a list of boolean if the input textfiles
   are boxfile format.

Definition at line 1466 of file cleanhelper.py.

References nf_regression.append, and cleanhelper.cleanhelper.imageids.

Referenced by cleanhelper.cleanhelper.makemultifieldmask(), and cleanhelper.cleanhelper.makemultifieldmask2().

def cleanhelper.cleanhelper.readoutlier	(	self,
		outlierfile
	)

Read a file containing clean boxes (kind of
compliant with AIPS FACET FILE)
    
Format is:
 col0    col1   col2  col3 col4 col5 col6 col7  col8   col9
  C    FIELDID SIZEX SIZEY RAHH RAMM RASS DECDD DECMM DECSS      
why first column has to have C ... because its should
not to be A or B ...now D would be a totally different thing.

'C' as in AIPS BOXFILE format indicates the file specify the coordiates
for field center(s). 

Note all lines beginning with '#' are ignored.
(* Lines with first column other than C or c are also ignored)

Definition at line 1541 of file cleanhelper.py.

Referenced by cleanhelper.cleanhelper.newreadoutlier().

def cleanhelper.cleanhelper.setChaniterParms	(	self,
		finalimagename,
		spw,
		chan,
		start,
		width,
		freqs,
		finc,
		tmppath
	)

Set parameters for channel by channel iterations
returns:
start and width to define each channel image plane

Definition at line 2868 of file cleanhelper.py.

References cleanhelper.cleanhelper.maskimages.

def cleanhelper.cleanhelper.setChannelizeDefault	(	self,
		mode,
		spw,
		field,
		nchan,
		start,
		width,
		frame,
		veltype,
		phasec,
		restf,
		obstime = `''`
	)

Determine appropriate values for channelization
parameters when default values are used
for mode='velocity' or 'frequency' or 'channel'
This makes use of ms.cvelfreqs.

Definition at line 2071 of file cleanhelper.py.

References cleanhelper.cleanhelper.convertvf(), cleanhelper.cleanhelper.dataspecframe, cleanhelper.cleanhelper.getspwtable(), cleanhelper.cleanhelper.inframe, cleanhelper.cleanhelper.setChannelizeNonDefault(), cleanhelper.cleanhelper.sortedvisindx, cleanhelper.cleanhelper.sortedvislist, cleanhelper.cleanhelper.usespecframe, and cleanhelper.cleanhelper.vis.

def cleanhelper.cleanhelper.setChannelizeNonDefault	(	self,
		mode,
		spw,
		field,
		nchan,
		start,
		width,
		frame,
		veltype,
		phasec,
		restf
	)

Determine appropriate values for channelization
parameters when default values are used
for mode='velocity' or 'frequency' or 'channel'
This does not replaces setChannelization and make no use of ms.cvelfreqs.

Definition at line 2334 of file cleanhelper.py.

References cleanhelper.cleanhelper.convertvf(), cleanhelper.cleanhelper.getspwtable(), tests.test_imcontsub.list, irc_cs_task_regression.max, cleanhelper.cleanhelper.sortedvisindx, and cleanhelper.cleanhelper.vis.

Referenced by cleanhelper.cleanhelper.setChannelizeDefault().

def cleanhelper.cleanhelper.setrestoringbeam	(	self,
		restoringbeam
	)

Set restoring beam

Definition at line 1157 of file cleanhelper.py.

def cleanhelper.cleanhelper.setspecframe	(	self,
		spw
	)

set spectral frame for mfs to data frame based
on spw selection 
(part copied from setChannelization)

Definition at line 2590 of file cleanhelper.py.

References cleanhelper.cleanhelper.dataspecframe, cleanhelper.cleanhelper.getspwtable(), cleanhelper.cleanhelper.sortedvisindx, and cleanhelper.cleanhelper.vis.

def cleanhelper.cleanhelper.sortvislist	(	self,
		spw,
		mode,
		width
	)

sorting user input vis if it is multiple MSes based on
frequencies (spw). So that in sebsequent processing such
as setChannelization() correctly works.
Returns sorted vis. name list

Definition at line 102 of file cleanhelper.py.

References cleanhelper.cleanhelper.defineimages(), cleanhelper.cleanhelper.getspwtable(), irc_cs_task_regression.max, cleanhelper.cleanhelper.sortedvisindx, cleanhelper.cleanhelper.sortedvislist, and cleanhelper.cleanhelper.vis.

def cleanhelper.cleanhelper.storeCubeImages	(	self,
		cubeimageroot,
		chanimageroot,
		chan,
		imagermode
	)

Put channel images back into CubeImages for chaniter=T mode

Keyword arguments:
cubeimageroot -- root name for output cube image
chanimageroot -- root name for channel image
chan          -- channel plane index
imagermode    -- imagermode

Definition at line 3057 of file cleanhelper.py.

References cleanhelper.cleanhelper.nimages, and cleanhelper.cleanhelper.putchanimage().

Member Data Documentation

cleanhelper.cleanhelper._casalog [private]

Definition at line 52 of file cleanhelper.py.

Referenced by setjy_helper.ss_setjy_helper.setSolarObjectJy().

cleanhelper.cleanhelper.csys

This code to set the maskframe is copied from makemaskimages()

don't know what to do with this

Can be a file name, or an explicit region-string

Definition at line 82 of file cleanhelper.py.

Referenced by cleanhelper.cleanhelper.copymaskimage(), cleanhelper.cleanhelper.initmultims(), cleanhelper.cleanhelper.makemaskimage(), cleanhelper.cleanhelper.makemultifieldmask2(), and cleanhelper.cleanhelper.readboxfile().

cleanhelper.cleanhelper.csysorder

Definition at line 854 of file cleanhelper.py.

Referenced by cleanhelper.cleanhelper.readboxfile().

cleanhelper.cleanhelper.dataspecframe

Definition at line 41 of file cleanhelper.py.

Referenced by cleanhelper.cleanhelper.convertframe(), cleanhelper.cleanhelper.convertImageFreqFrame(), cleanhelper.cleanhelper.convertvf(), cleanhelper.cleanhelper.defineimages(), cleanhelper.cleanhelper.getfreqs(), cleanhelper.cleanhelper.makemultifieldmask2(), cleanhelper.cleanhelper.setChannelizeDefault(), and cleanhelper.cleanhelper.setspecframe().

cleanhelper.cleanhelper.fieldindex

Definition at line 80 of file cleanhelper.py.

Referenced by cleanhelper.cleanhelper.datsel(), cleanhelper.cleanhelper.datselweightfilter(), and cleanhelper.cleanhelper.initmultims().

cleanhelper.cleanhelper.finalimages

Definition at line 39 of file cleanhelper.py.

Referenced by cleanhelper.cleanhelper.checkpsf().

cleanhelper.cleanhelper.im

Definition at line 68 of file cleanhelper.py.

Referenced by parallel.parallel_cont.imagecont.imagecontbychan(), parallel.parallel_cont.imagecont.imagecontmultims(), and cleanhelper.cleanhelper.initmultims().

cleanhelper.cleanhelper.imageids

if len(imageids) > 1: multifield=True

Definition at line 325 of file cleanhelper.py.

Referenced by cleanhelper.cleanhelper.makemultifieldmask(), cleanhelper.cleanhelper.makemultifieldmask2(), cleanhelper.cleanhelper.makeTemplateCubes(), and cleanhelper.cleanhelper.readmultifieldboxfile().

cleanhelper.cleanhelper.imagelist

Definition at line 323 of file cleanhelper.py.

Referenced by cleanhelper.cleanhelper.checkpsf(), cleanhelper.cleanhelper.convertAllModelImages(), cleanhelper.cleanhelper.convertAllModelImages_old(), cleanhelper.cleanhelper.convertmodelimage(), cleanhelper.cleanhelper.makeEmptyimages(), cleanhelper.cleanhelper.makemaskimage(), cleanhelper.cleanhelper.makemultifieldmask(), cleanhelper.cleanhelper.makemultifieldmask2(), and cleanhelper.cleanhelper.makeTemplateCubes().

cleanhelper.cleanhelper.inframe

Definition at line 43 of file cleanhelper.py.

Referenced by cleanhelper.cleanhelper.setChannelizeDefault().

cleanhelper.cleanhelper.maskimages

Definition at line 38 of file cleanhelper.py.

Referenced by cleanhelper.cleanhelper.makemultifieldmask(), cleanhelper.cleanhelper.makemultifieldmask2(), and cleanhelper.cleanhelper.setChaniterParms().

cleanhelper.cleanhelper.nimages

Definition at line 311 of file cleanhelper.py.

Referenced by cleanhelper.cleanhelper.makeEmptyimages(), and cleanhelper.cleanhelper.storeCubeImages().

cleanhelper.cleanhelper.outputmask

This goes when those tablerecord goes Make masks from tablerecords.

okay if outputmask exists then we need to do an "and" with the sdmask one

Make masks from region dictionaries Make masks from text files Make masks from inline lists of pixel coordinates Make masks from inline region-strings Make mask from an image-mask

Definition at line 81 of file cleanhelper.py.

Referenced by cleanhelper.cleanhelper.convertmodelimage(), cleanhelper.cleanhelper.initmultims(), and cleanhelper.cleanhelper.makemultifieldmask2().

cleanhelper.cleanhelper.paramlist

Definition at line 1018 of file cleanhelper.py.

cleanhelper.cleanhelper.phasecenter

check that start and step have units

make sure we respect outframe check that start and step have units make sure we respect outframe understand phasecenter blank means take field[0] succesful must be string like '0' or 'NGC*' failed must be a string 'J2000 18h00m00 10d00m00'

Definition at line 78 of file cleanhelper.py.