<casaxml xsi:schemaLocation="http://casa.nrao.edu/schema/casa.xsd file:///opt/casa/code/xmlcasa/xml/casa.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://casa.nrao.edu/schema/psetTypes.html">
<task category="imaging, analysis" name="impbcor" type="function">
<shortdescription>Construct a primary beam corrected image from an image and a primary beam pattern.</shortdescription>
Correct 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 1. it must have the same shape as the input image
and its coordinate system must be the same, or 2. 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
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.
<param mustexist="true" name="imagename" type="path">
<shortdescription>Name of the input image</shortdescription>
<description>Name of the input (CASA, FITS, MIRIAD) image
<example>imagename='ngc5921.im'</example>
<param name="pbimage" direction="in" type="any">
<shortdescription>Name of the primary beam image which must exist or array of values for the pb response.</shortdescription>
<description>Name of the image (CASA, FITS, MIRIAD) of the primary
beam pattern or an array of pixel values.
<value>""</value>
<param name="outfile" direction="in" type="string">
<shortdescription>Output image name. If empty, no image is written.</shortdescription>
<description>Name of output CASA image.
Default: none. Must be specified.
<param subparam="true" name="overwrite" direction="in" type="bool">
<shortdescription>Overwrite the output if it exists?</shortdescription>
<description>If output file is specified, controls if an already
existing file by the same name can be overwritten.