#
# stub class definition file for docstring parsing
#
[docs]class atcafiller:
"""
Filler for ATNF/ATCA RPFITS data
"""
[docs] def atcafiller(self):
"""
Construct an atcafiller tool
This is used to construct an {\tt atcafiller} tool for filling ATCA RPFITS data into a MeasurementSet
"""
pass
[docs] def open(self, msname='', filenames=[''], options=['']):
"""
Specify the names of the data files and MeasurementSet
This function does the actual filling of the data from rpfits format
files to a MeasurementSet. After the completion of the fill operation
you should call the done method to avoid problems with incomplete
flushing of the data to disk. You may want to run select before fill, to
reduce the amount of data you read in.
In the filenames argument commas are not allowed because of the
wildcard capability.
The options argument allows for special processing options during the
filling process.
* birdie: remove self generated birdies in 128 MHz
data by deleting every other channel and the edge
channels
* reweight: suppress ringing of interference spikes by
reweighting the lag spectrum for minimum spectral sidelobe response
* noxycorr: do not apply the xyphase
correction using the noise cal xy phase measurements (use if you
know there was a problem with the measurements)
* compress: Compress the data, model, corrected data and imaging weight
columns (may reduce dynamic range)
* fastmosaic: Produce a MeasurementSet with small tiles to optimize I/O
for observations with a large number of pointings and a short time (a few
integrations) on each pointing. Failing to use this options for such data
may cause very inefficient access, especially for continuum data
(10-100 times slower)
* hires: For data taken in binning mode: set the TIME_CENTROID column to
the center of each bin (normally center of integration interval). The TIME column is
unaffected. TIME_CENTROID will no longer be in time order for dual frequency
mode.
* noac : Do not load the autocorrelations
.. rubric:: Parameters
- ``msname (string='')`` - Filename for MeasurementSet to create
- ``filenames (stringArray=[''])`` - Existing RPFITS files to read; wild cards accepted,
don't use commas
- ``options (stringArray=[''])`` - Processing options: birdie, rfiflag, noxycorr, compress,
fastmosaic, hires, reweight, noac
"""
pass
[docs] def fill(self):
"""
Fill the MeasurementSet
This function does the actual filling of the data from rpfits format
files to a MeasurementSet. You may want to run select before fill, to
reduce the amount of data you read in.
"""
pass
[docs] def select(self, firstscan=0, lastscan=9999, spw=[-1], lowfreq=0.1, highfreq=999.0, fields=[''], edge=8.0):
"""
Select the data to fill
Select on various items, to load only a subset of the data present in
the input file. The default is to load everything.
Note that the frequency selection using lowfreq and highfreq acts purely on
center (reference) frequencies, channel selection is not available at this stage.
Use freqchain to select the frequency chain (or IF) to load,
specify either 1 or 2, the default of zero will load both.
Use the fields parameter to specify a list of field names (sources) you
want to load.
For detailed selection of complex observations the last two parameters let
you specify the required bandwidth (in whole MHz) and number of channels
of the first frequency chain.
.. rubric:: Parameters
- ``firstscan (int=0)`` - First scan to read
- ``lastscan (int=9999)`` - Last scan to read
- ``spw (intArray=[-1])`` - Select one or more spectralwindows , -1=all
- ``lowfreq (double=0.1)`` - Lowest reference frequency to select
- ``highfreq (double=999.0)`` - Highest reference frequency to select
- ``fields (stringArray=[''])`` - List of field names (sources) to select
- ``edge (float=8.0)`` - Percentage of edge channels to flag
"""
pass
[docs] def opacities(self, fghz=[''], tempk=300.0, humi=50.0, press=1010.0, height=200.0):
"""
Calculate opacity correction
This function does the actual filling of the data from rpfits format
files to a MeasurementSet. You may want to run select before fill, to
reduce the amount of data you read in.
.. rubric:: Parameters
- ``fghz (doubleArray=[''])`` - array of frequencies
- ``tempk (float=300.0)`` - surface temperature in K
- ``humi (float=50.0)`` - humidity in %
- ``press (float=1010.0)`` - surface pressure in hPa
- ``height (float=200.0)`` - observatory height in m
"""
pass