#
# stub function definition file for docstring parsing
#
[docs]def pccor(vis, pccor_caltable, refant, timerange='none', scan='none', spw='none', antenna='none', cablecal_correction=False, ff_table='none'):
r"""
Generate Pulse Cal CORrections (pccor) for VLBA data
[`Description`_] [`Examples`_] [`Development`_] [`Details`_]
Parameters
- vis_ (path) - Name of input visibility file (MS)
- pccor_caltable_ (string) - Name of output gain calibration table
- refant_ (string) - Reference antenna name
- timerange_ (string='none') - Time range over which to compare fringefit and pccor delays
- scan_ (string='none') - Scan over which to compare fringefit and pccor delays
- spw_ (string='none') - Select the spectral windows for which to compute pccor solutions
- antenna_ (string='none') - Select the antennas for which to compute pccor solutions
- cablecal_correction_ (bool=False) - Add cable delay to pulse cal delays?
- ff_table_ (string='none') - Optional reference Fringe fit table
.. _Description:
Description
Generate Pulse Cal CORrections (**pccor**) for VLBA data
**pccor** produces time resolved phase and delay corrections for
VLBA data by analysing the phases in the PHASE_CAL table inside a
VLBA MS. Delay corrections are estimated from the highest and
lowest frequency tones within each SPW which leads to cycle
ambiguities. Cycle ambiguities are dealt with by comparing the PC
delay correction over a selected time range and/or scan with a
reference fringe fit delay solution over the same time range
obtained with a better spectral leverage. The reference fringe fit
table can be produced by an internal **pccor** call to
**fringefit** or can be provided by an expert user as input.
When pulse cal data is completely missing for an antenna and/or
spectral window **pccor** does not flag that data, it simply throws
a warning and outputs the frige fit solution as the **pccor**
solution for that antenna and/or spectral window. When pulse cal
data is missing during the selected time range for the fringe fit
solution a warning is thrown indicating that this is the case,
which the user may go around by selecting another fringe fit time
range. Lastly in the case that pulse cal data is missing for the
reference antenna during the fringe fit time range for a spectral
window, no solutions will be produced for that spectral window, if
all selected spectral windows have missing pulse cal data for the
reference antenna an error/exception is thrown.
.. _Examples:
Examples
Example of a pccor call using a scan to select a time range:
::
pccor(
vis='my_vlba_data.ms',
pccor_caltable='my_vlba_data.ms.pccor',
refant='LA',
scan='15'
)
Example of a pccor call using a time range directly:
::
pccor(
vis='my_vlba_data.ms',
pccor_caltable='my_vlba_data.ms.pccor',
refant='LA',
timerange='21:36:00~21:37:00'
)
Example of a pccor call with spectral window selection and MK
antenna exclusion:
::
pccor(
vis='my_vlba_data.ms',
pccor_caltable='my_vlba_data.ms.pccor',
refant='LA',
timerange='2011/09/16/21:36:00~21:37:00',
spw='0,1,2',
antenna='!MK'
)
Lastly an example of a pccor call where the user provides a
reference frige fit cal table.
::
pccor(
vis='my_vlba_data.ms',
pccor_caltable='my_vlba_data.ms.pccor',
refant='LA',
timerange='2011/09/16/21:36:00~21:37:00',
ff_table='my_previous_ref_fringefit.mpc'
)
.. _Development:
Development
No additional development details
.. _Details:
Parameter Details
Detailed descriptions of each function parameter
.. _vis:
| ``vis (path)`` - Name of input visibility file (MS)
.. _pccor_caltable:
| ``pccor_caltable (string)`` - Name of output gain calibration table
.. _refant:
| ``refant (string)`` - Reference antenna name
.. _timerange:
| ``timerange (string='none')`` - Time range over which to compare fringefit and pccor delays. The selected time range must have a
| bright high SNR source but must not be long enough to break coherence, usually a few minutes.
| If both a time range and a scan are specified pccor will check if they are compatible, if not, an
| Exception is thrown, if neither a scan nor a time range are specified pccor will also throw an
| exception, as time selection is required for the execution of pccor.
.. _scan:
| ``scan (string='none')`` - Select a time range over which to compare fringefit and pccor delays based on a scan. The selected
| scan must have a bright, high SNR source, but must not be long enough to break coherence, usually a
| few minutes. If both a time range and a scan are specified pccor will check if they are compatible,
| if not, an Exception is thrown, if neither a scan nor a time range are specified pccor will also
| throw an exception, as time selection is required for the execution of pccor.
.. _spw:
| ``spw (string='none')`` - Select the spectral windows for which to compute pccor solutions. If parameter is not specified, all
| available spectral windows are selected.
.. _antenna:
| ``antenna (string='none')`` - Select the antennas for which to compute pccor solutions. If parameter is not specified, all
| available antennas are selected. PCCOR is based on antenna based data, and hence no baseline
| selection is allowed here.
.. _cablecal_correction:
| ``cablecal_correction (bool=False)`` - Add cable delay to pulse cal delays?
| Default: False
| Options: False|True
.. _ff_table:
| ``ff_table (string='none')`` - Optional reference Fringe fit table. This option is for the user that wants to have fine control
| over the fringe fit solution being used to deal with cycle ambiguities. If no such control is needed
| or desired this parameter can be left blank and pccor will produce the reference fringe fit table.
"""
pass