pipeline.hif.cli.hif_editimlist

pipeline.hif.cli.hif_editimlist = <pipeline.hif.cli.hif_editimlist._hif_editimlist object>

hif_editimlist —- Add to a list of images to be produced with hif_makeimages()

Add to a list of images to be produced with hif_makeimages(), which uses hif_tclean() to invoke CASA tclean. Many of the hif_editimlist() inputs map directly to tclean parameters.

If pipeline mode is ‘getinputs’ then None is returned. Otherwise the results object for the pipeline task is returned.

——— parameter descriptions ———————————————

imagename Prefix for output image names. search_radius_arcsec Size of the field finding beam search radius in arcsec. cell Image X and Y cell size(s) with units or pixels per beam.

Single value same for both. ‘<number>ppb’ for pixels per beam. Compute cell size based on the UV coverage of all the fields to be imaged and use a 5 pix per beam sampling. The pix per beam specification uses the above default cell size (‘5ppb’) and scales it accordingly. example: [‘0.5arcsec’, ‘0.5arcsec’] ‘3ppb’

cfcache Convolution function cache directory name conjbeams Use conjugate frequency in tclean for wideband A-terms. cyclefactor Controls the depth of clean in minor cycles based on PSF. cycleniter Controls max number of minor cycle iterations in a single major cycle. datacolumn Data column to image deconvolver Minor cycle algorithm (multiscale or mtmfs) editmode The edit mode of the task (e.g. add, edit). Defaults to ‘add’. field Set of data selection field names or ids. imaging_mode Identity of product type (e.g. VLASS quick look) desired. This will determine the heuristics used. imsize Image X and Y size(s) in pixels or PB level (single fields), ‘’ for default. Single value same for both. ‘<number>pb’ for PB level. intent Set of data selection intents gridder Name of the gridder to use with tclean mask Used to declare whether to use a predefined mask for tclean. nbin Channel binning factor. nchan Number of channels, -1 = all niter The max total number of minor cycle iterations allowed for tclean nterms Number of Taylor coefficients in the spectral model parameter_file keyword=value text file as alternative method of input parameters pblimit PB gain level at which to cut off normalizations phasecenter The default phase center is set to the mean of the field

directions of all fields that are to be image together. example: 0, ‘J2000 19h30m00 -40d00m00’

reffreq Reference frequency of the output image coordinate system restfreq List of rest frequencies or a rest frequency in a string for output image. robust Briggs robustness parameter for tclean scales The scales for multi-scale imaging. specmode Spectral gridding type (mfs, cont, cube, ‘’ for default) spw Set of data selection spectral window/channels, ‘’ for all start First channel for frequency mode images.

Starts at first input channel of the spw. example: ‘22.3GHz’

stokes Stokes Planes to make sensitivity threshold Stopping threshold (number in units of Jy, or string) nsigma Multiplicative factor for rms-based threshold stopping uvtaper Used to set a uv-taper during clean. uvrange Set of data selection uv ranges, ‘’ for all. width Channel width pipelinemode The pipeline operating mode. In ‘automatic’ mode the pipeline

determines the values of all context defined pipeline inputs automatically. In ‘interactive’ mode the user can set the pipeline context defined parameters manually. In ‘getinputs’ mode the user can check the settings of all pipeline parameters without running the task.

dryrun Run the task (False) or display the command(True) acceptresults Add the results to the pipeline context

——— examples ———————————————————–