pipeline.hsd.cli.hsd_skycal

pipeline.hsd.cli.hsd_skycal = <pipeline.hsd.cli.hsd_skycal._hsd_skycal object>

hsd_skycal —- Calibrate data

The hsd_skycal generates a caltable for sky calibration that stores reference spectra, which is to be subtracted from on-source spectra to filter out non-source contribution.

Output:

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

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

calmode Calibration mode. Available options are ‘auto’ (default),

‘ps’, ‘otf’, and ‘otfraster’. When ‘auto’ is set, the task will use preset calibration mode that is determined by inspecting data. ‘ps’ mode is simple position switching using explicit reference scans. Other two modes, ‘otf’ and ‘otfraster’, will generate reference data from scans at the edge of the map. Those modes are intended for OTF observation and the former is defined for generic scanning pattern such as Lissajous, while the latter is specific use for raster scan.

options: ‘auto’, ‘ps’, ‘otf’, ‘otfraster’

fraction Sub-parameter for calmode. Edge marking parameter for

‘otf’ and ‘otfraster’ mode. It specifies a number of OFF scans as a fraction of total number of data points.

options: String style like ‘20%’, or float value less than 1.0. For ‘otfraster’ mode, you can also specify ‘auto’.

noff Sub-parameter for calmode. Edge marking parameter for ‘otfraster’

mode. It is used to specify a number of OFF scans near edge directly instead to specify it by fractional number by ‘fraction’. If it is set, the value will come before setting by ‘fraction’.

options: any positive integer value

width Sub-parameter for calmode. Edge marking parameter for ‘otf’

mode. It specifies pixel width with respect to a median spatial separation between neighboring two data in time. Default will be fine in most cases.

options: any float value

elongated Sub-parameter for calmode. Edge marking parameter for

‘otf’ mode. Please set True only if observed area is elongated in one direction.

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.

infiles List of data files. These must be a name of MeasurementSets that

are registered to context via hsd_importdata task.

example: vis=[‘X227.ms’, ‘X228.ms’]

field Data selection by field name. spw Data selection by spw. (defalut all spws)

example: ‘3,4’ (generate caltable for spw 3 and 4)

[‘0’,’2’] (spw 0 for first data, 2 for second)

scan Data selection by scan number. (default all scans)

example: ‘22,23’ (use scan 22 and 23 for calibration)

[‘22’,’24’] (scan 22 for first data, 24 for second)

dryrun Run the commands (True) or generate the commands to be run but

do not execute (False).

acceptresults Add the results of the task to the pipeline context (True) or

reject them (False).

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

1. Generate caltables for all data managed by context. default(hsd_skycal) hsd_skycal()