impbcor(imagename, pbimage='""', outfile='', overwrite=False, box='', region='', chans='', stokes='', mask='', mode='divide', cutoff=- 1.0, stretch=False)¶
Construct a primary beam corrected image from an image and a primary beam pattern.
imagename (string) - Name of the input image
pbimage (variant=’””’) - Name of the primary beam image which must exist or array of values for the pb response.
outfile (string=’’) - Output image name. If empty, no image is written.
outfile != ''
overwrite (bool=False) - Overwrite the output if it exists?
box (string=’’) - Rectangular region to select in direction plane. Default is to use the entire direction plane.
region (variant=’’) - Region selection.
chans (string=’’) - Channels to use.
stokes (string=’’) - Stokes planes to use.
mask (string=’’) - Mask to use.
mask != ''
stretch (bool=False) - Stretch the mask if necessary and possible?
mode (string=’divide’) - Divide or multiply the image by the primary beam image. Minimal match supported.
cutoff (double=-1.0) - PB cutoff. If mode is “d”, all values less than this will be masked. If “m”, all values greater will be masked. Less than 0, no cutoff.
Corrects an image for primary beam attenuation using an image of the primary beam pattern. The primary beam pattern can be provided as an image, in which case:
it must have the same shape as the input image and its coordinate system must be the same, or
it must be a 2-D image in which case its coordinate system must consist of a (2-D) direction coordinate which is the same as the direction coordinate in the input image and its direction plane must be the same shape as that of the input image.
Alternatively, pbimage can be an array of pixel values in which case the same dimensionality and shape constraints apply.
One can choose between dividing the image by the primary beam pattern (mode=”divide”) or multiplying the image by the primary beam pattern (mode=”multiply”). One can also choose to specify a cutoff limit for the primary beam pattern. For mode=”divide”, for all pixels below this cutoff in the primary beam pattern, the output image will be masked. In the case of mode=”multiply”, all pixels in the output will be masked corresponding to pixels with values greater than the cutoff in the primary beam pattern. A negative value for cutoff means that no cutoff will be applied, which is the default.
To correct an image for the primary beam response out to a radius where the sensitivity drops to 10% of the maximum value in the pointing center:
impbcor(imagename="attenuated.im", pbimage="mypb.im", outfile="pbcorred.im", mode="divide", cutoff=0.1)
No additional development details
- Parameter Details
Detailed descriptions of each function parameter
imagename (string)- Name of the input (CASA, FITS, MIRIAD) image
pbimage (variant='""')- Name of the image (CASA, FITS, MIRIAD) of the primarybeam pattern or an array of pixel values.Default: ‘’
outfile (string='')- Name of output CASA image.Default: none. Must be specified.
overwrite (bool=False)- If output file is specified, controls if an alreadyexisting file by the same name can be overwritten.Default: TrueOptions: True|FalseIf true, the user is not prompted, the file if itexists is automatically overwritten.
box (string='')- Rectangular region to select in direction plane.Default: ‘’ (use the entire direction plane)
region (variant='')- Region selection.Default: ‘’ (use the full image)
chans (string='')- Channels to use.Default: ‘’ (use all channels)
stokes (string='')- Stokes planes to use.Default: ‘’ (use all Stokes planes)
mask (string='')- Mask to use.Default: none
mode (string='divide')- Divide or multiply the image by the primary beam image.Default: ‘divide’Minimal match supported.
cutoff (double=-1.0)- Primary beam cutoff.Default: -1.0 (no cutoff)If mode is “d”, all values less than this will bemasked. If “m”, all values greater will bemasked. Less than 0, no cutoff (default)
stretch (bool=False)- Stretch the mask if necessary and possible?Default: FalseOptions: False|True