pipeline.hif.cli.hif_polarization

pipeline.hif.cli.hif_polarization = <pipeline.hif.cli.hif_polarization._hif_polarization object>

hif_polarization —- Base polarization task

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

vis List of input visibility data pipelinemode The pipeline operating mode dryrun Run the task (False) or display task command (True) acceptresults Add the results into the pipeline context

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

The hif_polarization task

Keyword arguments:

—- pipeline parameter arguments which can be set in any pipeline mode

vis – List of visibility data files. These may be ASDMs, tar files of ASDMs, MSs, or tar files of MSs, If ASDM files are specified, they will be converted to MS format. default: [] example: vis=[‘X227.ms’, ‘asdms.tar.gz’]

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. default: ‘automatic’.

—- pipeline context defined parameter argument which can be set only in ‘interactive mode’

— pipeline task execution modes

dryrun – Run the commands (True) or generate the commands to be run but do not execute (False). default: True

acceptresults – Add the results of the task to the pipeline context (True) or reject them (False). default: True

Output:

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

Examples

1. Basic polarization task

hif_polarization()