pipeline.hif.cli.hif_checkproductsize

hif_checkproductsize(vis=None, maxcubesize=None, maxcubelimit=None, maxproductsize=None, maximsize=None, calcsb=None, parallel=None) → Results[source]

Check imaging product size.

Check interferometry imaging product size and try to mitigate to maximum allowed values. hif_checkproductsize implements a mitigation cascade computing the largest cube size and tries 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 to maximsize.

Note that mitigation for image pixel count and for the product size currently are mutually exclusive, with maximsize taking precedence if set.

Parameters:

  • vis --

    The list of input MeasurementSets. Defaults to the list of MeasurementSets specified in hifa_importdata and hifv_importdata.

    Examples: 'ngc5921.ms', ['ngc5921a.ms', ngc5921b.ms', 'ngc5921c.ms']

  • maxcubesize --

    Maximum allowed cube size in gigabytes (mitigation goal)

    Default: -1 - automatic from performance parameters

  • maxcubelimit --

    Maximum allowed cube limit in gigabytes (mitigation failure limit)

    Default: -1 - automatic from performance parameters

  • maxproductsize --

    Maximum allowed product size in gigabytes (mitigation goal and failure limit)

    Default: -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. *Caution* maximsize is disabled by default and cannot be set at the same time as maxcubesize, maxcubelimit and maxproductsize.

    Default: -1 - disables mitigation for this parameter

  • calcsb -- Force (re-)calculation of sensitivities and beams

  • parallel --

    Use the CASA imager parallelization when possible.

    Options: 'automatic', 'true', 'false', True, False

    Default: 'automatic'

Returns:

The results object for the pipeline task is returned.

Examples

  1. Basic call to check the product sizes using internal defaults

>>> hif_checkproductsize()

  1. Typical ALMA call

>>> hif_checkproductsize(maxcubesize=40.0, maxcubelimit=60.0, maxproductsize=350.0)