cngi.image.gaussian_beam

gaussian_beam(xds, source='commonbeam', scale=1.0, name='BEAM')[source]

Construct a gaussian beam of image dimensions from specified size or beam attribute

Parameters

  • xds (xarray.core.dataset.Dataset) – input Image Dataset

  • source (str or list of floats) – Source xds attr name to find the beam information, or a list describing the major axis, minor axis, and position angle of the desired gaussian in (arcsec, arcsec, degrees), for example [1., 1., 30.]. Default is ‘commonbeam’

  • scale (float) – peak amplitude of beam. Default is unity (1.0)

  • name (str) – dataset variable name for output beam(s), overwrites if already present. Default is ‘BEAM’

Returns

output Image

Return type

xarray.core.dataset.Dataset