#
# stub function definition file for docstring parsing
#
[docs]def nrobeamaverage(infile, datacolumn='float_data', field='', spw='', timerange='', scan='', beam='', timebin='0s', outfile=''):
r"""
Average SD data over beams and do time averaging
[`Description`_] [`Examples`_] [`Development`_] [`Details`_]
Parameters
- infile_ (path) - name of input SD dataset
- datacolumn_ (string='float_data') - name of data column to be used ["data", "float_data", or "corrected_data"]
- field_ (string='') - select data by field IDs and names, e.g. "3C2*" (""=all)
- spw_ (string='') - select data by IF IDs (spectral windows), e.g. "3,5,7" (""=all)
- timerange_ (string='') - select data by time range, e.g. "09:14:0~09:54:0" (""=all) (see examples in help)
- scan_ (string='') - select data by scan numbers, e.g. "21~23" (""=all)
- beam_ (string='') - beam IDs to be averaged over, e.g. "1,3" (""=all)
- timebin_ (string='0s') - bin width for time averaging.
- outfile_ (string='') - name of output file
.. _Description:
Description
Task **nrobeamaverage** is dedicated to the data obtained with the multi-beam receivers in the NRO45m telescope,
and is used to export Single Dish MS data averaged over different beams.
This task is in particular useful for the data observed in the On-On mode, in which two beams are used to observe
same source position on the sky. When one beam (beam-1) points to the source position, the other beam (beam-3)
points the reference position, and when beam-3 observes the source position, beam-1 points to its reference position.
Compared to the observations with a single beam, this mode can reduce the dead-time due to observations of the reference
position, and observers can obtain betterr sensitivities by averaging the spectra obtained with the two beams. This task
can be used in this averaging process.
Details of the On-On mode can be seen in the NRO official web page
(https://www.nro.nao.ac.jp/~nro45mrt/html/obs/nobs/scan.html#on-on).
.. _Examples:
Examples
Average the spectra over all the beams:
::
nrobeamaverage(infile='sd_data.ms', outfile='sd_data_bave.ms')
Average the spectra over the selected beam IDs:
::
nrobeamaverage(infile='sd_data.ms', outfile='sd_data_bave.ms', beam='1,3')
You can apply time-averaging at the same time:
::
nrobeamaverage(infile='sd_data.ms', outfile='sd_data_bave.ms', timebin='3600s')
.. _Development:
Development
No additional development details
.. _Details:
Parameter Details
Detailed descriptions of each function parameter
.. _infile:
| ``infile (path)`` - name of input SD dataset
.. _datacolumn:
| ``datacolumn (string='float_data')`` - name of data column to be used ["data", "float_data", or "corrected_data"]
.. _field:
| ``field (string='')`` - select data by field IDs and names, e.g. "3C2*" (""=all)
.. _spw:
| ``spw (string='')`` - select data by IF IDs (spectral windows), e.g. "3,5,7" (""=all)
.. _timerange:
| ``timerange (string='')`` - select data by time range, e.g. "09:14:0~09:54:0" (""=all) (see examples in help)
.. _scan:
| ``scan (string='')`` - select data by scan numbers, e.g. "21~23" (""=all)
.. _beam:
| ``beam (string='')`` - beam IDs to be averaged over, e.g. "1,3" (""=all)
.. _timebin:
| ``timebin (string='0s')`` - bin width for time averaging.
.. _outfile:
| ``outfile (string='')`` - name of output file
"""
pass