pipeline.hif.cli.hif_checkproductsize

pipeline.hif.cli.hif_checkproductsize = <pipeline.hif.cli.hif_checkproductsize._hif_checkproductsize object>

hif_checkproductsize —- Check imaging product size

Check interferometry imaging product size and try to mitigate to maximum allowed values. The task implements a mitigation cascade computing the largest cube size and trying to reduce it below a given limit by adjusting the nbins, hm_imsize and hm_cell parameters. If this step succeeds, it also checks the overall imaging product size and if necessary reduces the number of fields to be imaged.

Alternatively, if maximsize is set, the image product pixel count is mitigated by trying to adjust hm_cell parameter. If the pixel count is still greater than maximsize at hm_cell of 4ppb, then this value is kept and the image field is truncated around the phase center by forcing hm_imsize = maximsize.

Note that mitigation for image pixel count and for the product size currently are mutually exclusive.

Output:

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

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

vis The list of input MeasurementSets. Defaults to the list of

MeasurementSets specified in the h_init or hif_importdata task. ‘’: use all MeasurementSets in the context

Examples: ‘ngc5921.ms’, [‘ngc5921a.ms’, ngc5921b.ms’, ‘ngc5921c.ms’]

maxcubesize Maximum allowed cube size in gigabytes (mitigation goal)

-1: automatic from performance parameters

maxcubelimit Maximum allowed cube limit in gigabytes (mitigation failure

limit) -1: automatic from performance parameters

maxproductsize Maximum allowed product size in gigabytes (mitigation goal and

failure limit) -1: automatic from performance parameters

maximsize Maximum allowed image count size (mitigation goal and hard

maximum). Parameter maximsize must be even and divisible by 2,3,5,7 only. Note that maximsize is disabled by default and cannot be set at the same time as maxcubesize, maxcubelimit and maxproductsize! -1: disables mitigation for this parameter

calcsb Force (re-)calculation of sensitivities and beams parallel Use MPI cluster where possible 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 just display the command (True) acceptresults Add the results of the task to the pipeline context (True) or

reject them (False).

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