0.1.53 sdaverage
Requires:
Synopsis ASAP SD task: do data selection, calibration, and averaging
Description
ASAP SD calibration task (based on the ALMATST5 recommendations): Do
data selection, calibration, and averaging
Task Version 2007-10-25 TT split and modified from Task Version 2007-03-04
STM
Arguments
|
|
|
|
| Inputs | |
|
| sdfile | | name of input SD dataset
|
| | | allowed: | string |
| | | Default: | |
| fluxunit | | units for line flux (K,Jy) (”=current)
|
| | | allowed: | string |
| | | Default: | |
| telescopeparm | | param of telescope for flux conversion
|
| | | allowed: | any |
| | | Default: | variant |
| specunit | | units for spectral axis (channel,km/s,GHz,”=current)
|
| | | allowed: | string |
| | | Default: | |
| frame | | frequency reference frame, e.g. LSRK (”=current)
|
| | | allowed: | string |
| | | Default: | |
| doppler | | doppler convention, e.g. RADIO (”=current)
|
| | | allowed: | string |
| | | Default: | |
| calmode | | SD calibration mode (ps,nod,fs,fsotf,none)
|
| | | allowed: | string |
| | | Default: | none |
| scanlist | | list of scans to use (e.g. [1,2,3,4])
|
| | | allowed: | intArray |
| | | Default: | |
| field | | string for selection by source name
|
| | | allowed: | string |
| | | Default: | |
| iflist | | list of IF ids to select (e.g. [0,1])
|
| | | allowed: | intArray |
| | | Default: | |
| pollist | | list of polarization ids to select (e.g. [0,1])
|
| | | allowed: | intArray |
| | | Default: | |
| channelrange | | channel range selection (e.g. [0,5000])
|
| | | allowed: | intArray |
| | | Default: | |
| scanaverage | | average integs within scans (True,False)
|
| | | allowed: | bool |
| | | Default: | False |
| timeaverage | | average scans over time (True,False)
|
| | | allowed: | bool |
| | | Default: | False |
| tweight | | weighting for time averaging
|
| | | allowed: | string |
| | | Default: | none |
| averageall | | set True only when averaging spectra with different
spectral resolutions
|
| | | allowed: | bool |
| | | Default: | False |
| polaverage | | average over polarizations (True,False)
|
| | | allowed: | bool |
| | | Default: | False |
| pweight | | weighting for polarization averaging
|
| | | allowed: | string |
| | | Default: | none |
| tau | | atmospheric optical depth for correction
|
| | | allowed: | double |
| | | Default: | 0.0 |
| outfile | | output file name
|
| | | allowed: | string |
| | | Default: | |
| outform | | output file format (ASCII,MS,SDFITS,ASAP)
|
| | | allowed: | string |
| | | Default: | ASAP |
| overwrite | | overwrite the output file if already exists
|
| | | allowed: | bool |
| | | Default: | False |
| plotlevel | | plot results (0=none,1+=some,¡0=hardcopy)
|
| | | allowed: | int |
| | | Default: | 0 |
| |
Returns
void
Example
Keyword arguments:
sdfile -- name of input SD dataset
fluxunit -- units for line flux
options: ’K’,’Jy’,’’
default: ’’ (keep current fluxunit)
WARNING: For GBT data, see description below.
>>> fluxunit expandable parameter
telescopeparm -- the telescope characteristics
options: (str) name or (list) list of gain info
default: ’’ (none set)
example: if telescopeparm=’’, it tries to get the telescope
name from the data.
Full antenna parameters (diameter,ap.eff.) known
to ASAP are
’ATPKSMB’, ’ATPKSHOH’, ’ATMOPRA’, ’DSS-43’,
’CEDUNA’,’HOBART’. For GBT, it fixes default fluxunit
to ’K’ first then convert to a new fluxunit.
telescopeparm=[104.9,0.43] diameter(m), ap.eff.
telescopeparm=[0.743] gain in Jy/K
telescopeparm=’FIX’ to change default fluxunit
see description below
specunit -- units for spectral axis
options: (str) ’channel’,’km/s’,’GHz’,’MHz’,’kHz’,’Hz’
default: ’’ (=current)
example: this will be the units for masklist
frame -- frequency frame for spectral axis
options: (str) ’LSRK’,’REST’,’TOPO’,’LSRD’,’BARY’,
’GEO’,’GALACTO’,’LGROUP’,’CMB’
default: currently set frame in scantable
WARNING: frame=’REST’ not yet implemented
doppler -- doppler mode
options: (str) ’RADIO’,’OPTICAL’,’Z’,’BETA’,’GAMMA’
default: currently set doppler in scantable
calmode -- calibration mode
options: ’ps’,’nod’,’fs’,’fsotf’,’quotient’,’none’
default: ’none’
example: choose mode ’none’ if you have
already calibrated and want to
try averaging
scanlist -- list of scan numbers to process
default: [] (use all scans)
example: [21,22,23,24]
this selection is in addition to field,
iflist, and pollist
field -- selection string for selecting scans by name
default: ’’ (no name selection)
example: ’FLS3a*’
this selection is in addition to scanlist,
iflist, and pollist
iflist -- list of IF id numbers to select
default: [] (use all IFs)
example: [15]
this selection is in addition to scanlist,
field, and pollist
pollist -- list of polarization id numbers to select
default: [] (use all polarizations)
example: [1]
this selection is in addition to scanlist,
field, and iflist
channelrange -- channel range selection
default: [] (use all channel)
example: [0,5000]
Note that specified values are recognized as
’channel’ regardless of the value of specunit
scanaverage -- average integrations within scans
options: (bool) True,False
default: False
example: if True, this happens in read-in
For GBT, set False!
timeaverage -- average times for multiple scan cycles
options: (bool) True,False
default: False
example: if True, this happens after calibration
>>>timeaverage expandable parameter
tweight -- weighting for time average
options: ’none’
’var’ (1/var(spec) weighted)
’tsys’ (1/Tsys**2 weighted)
’tint’ (integration time weighted)
’tintsys’ (Tint/Tsys**2)
’median’ ( median averaging)
default: ’none’
averageall -- average multi-resolution spectra
spectra are averaged by referring
their frequency coverage
default: False
polaverage -- average polarizations
options: (bool) True,False
default: False
>>>polaverage expandable parameter
pweight -- weighting for polarization average
options: ’none’
’var’ (1/var(spec) weighted)
’tsys’ (1/Tsys**2 weighted)
default: ’none’
tau -- atmospheric optical depth
default: 0.0 (no correction)
outfile -- Name of output file
default: ’’ (<sdfile>_cal)
outform -- format of output file
options: ’ASCII’,’SDFITS’,’MS’,’ASAP’
default: ’ASAP’
example: the ASAP format is easiest for further sd
processing; use MS for CASA imaging.
If ASCII, then will append some stuff to
the outfile name
overwrite -- overwrite the output file if already exists
options: (bool) True,False
default: False
WARNING: if outform=’ASCII’, this parameter is ignored
plotlevel -- control for plotting of results
options: (int) 0=none, 1=some, 2=more, <0=hardcopy
default: 0 (no plotting)
example: plotlevel<0 as abs(plotlevel), e.g.
-1 => hardcopy of final plot (will be named
<outfile>_calspec.eps)
WARNING: be careful plotting in fsotf mode!
DESCRIPTION:
Task sdaverage performs data selection, calibration for single-dish
spectra. By setting calmode=’none’
one can run sdaverage on already calibrated data, for further selection
, averaging and atmospheric optical depth correction.
If you give multiple IFs in iflist, then your scantable will have
multiple IFs. This can be handled, but there can be funny interactions
later on. We recommend you split each IF out into separate files
by re-running sdaverage with each IF in turn.
ASAP recognizes the data of the "AT" telescopes, but currently
does not know about the GBT or any other telescope. This task
does know about GBT. Telescope name is obtained from the data.
If you wish to change the fluxunit (see below), by leaving
the sub-parameter telescopeparm unset (telescopeparm=’’),
it will use internal telescope parameters for
flux conversion for the data from AT telescopes and it will use an
approximate aperture efficiency conversion for the GBT data.
If you give telescopeparm a list, then if the list has a single float it
is assumed to be the gain in Jy/K, if two or more elements they are assumed
to be telescope diameter (m) and aperture efficiency
respectively.
Note that sdaverage assumes that the fluxunit is set correctly in
the data already. If not, then set telescopeparm=’FIX’ and it
will set the default units to fluxunit without conversion.
NOTE: If the data in sdfile is an ms from GBT and the default flux
unit is missing, this task automatically fixes the default fluxunit
to ’K’ before the conversion.
Please send any comments or questions about CASA or AIPS++
to aips2-requests@nrao.edu
Copyright © 2008 Associated Universities Inc.,
Washington, D.C.
This code is available under the terms of the GNU General Public Lincense
Home |
Contact Us |
Directories |
Site Map |
Help |
Privacy Policy |
Search
Updated daily during alpha development.