NRAO Home > CASA > CASA Task Reference Manual

0.1.113 sdsaveold

Requires:

Synopsis
Save the sd spectra in various format

Description

Task sdsaveold writes the single dish data to a disk file in specified format (ASAP, MS2, SDFITS, ASCII). It is possible to save the subset of the data by selecting field names, spw ids, time ranges, scan numbers, and polarization ids. The ASAP (scantable) format is recommended for further analysis using Sd tool or tasks except imaging. For further imaging using imager or sdimaging, save the data to the Measurement Set (MS2).

Arguments





Inputs

infile

name of input SD dataset

allowed:

string

Default:

splitant

split output file by antenna (only effective for MS input)

allowed:

bool

Default:

False

antenna

select an antenna name or ID, e.g. ’PM03’ (only effective for MS input)

allowed:

any

Default:

variant 0

getpt

fill DIRECTION column properly (True), or reuse POINTING table in original MS (False) (only effective for MS input)

allowed:

bool

Default:

True

field

select data by field IDs and names, e.g. ’3C2*’ (”=all)

allowed:

string

Default:

spw

select data by IF IDs (spectral windows), e.g. ’3,5,7’ (”=all)

allowed:

string

Default:

timerange

select data by time range, e.g. ’09:14:0~09:54:0’ (”=all) (see examples in help)

allowed:

string

Default:

scan

select data by scan numbers, e.g. ’21~23’ (”=all)

allowed:

string

Default:

pol

select data by polarization IDs, e.g. ’0,1’ (”=all)

allowed:

string

Default:

beam

select data by beam IDs, e.g. ’0,1’ (”=all)

allowed:

string

Default:

restfreq

the rest frequency, e.g. ’1.41GHz’ (default unit: Hz) (see examples in help)

allowed:

any

Default:

variant

outfile

name of output file (See a WARNING in help)

allowed:

string

Default:

outform

output file format (See a WARNING in help)

allowed:

string

Default:

ASAP

fillweight

fill the WEIGHT and SIGMA columns for output MS

allowed:

bool

Default:

False

overwrite

overwrite the output file if already exists

allowed:

bool

Default:

False

Returns
void

Example

 
-----------------  
Keyword arguments  
-----------------  
infile -- name of input SD dataset  
splitant -- split output file by antenna. this parameter is only  
            effective for MS input.  
        options: (bool) True, False  
        default: False  
    >>>splitant expandable parameter  
        antenna -- select an antenna name or ID. this parameter is  
                   effective only for MS input.  
                default: 0  
                example: antenna=0 specifies antenna by id  
                         antenna=’PM03’ specifies antenna by name  
getpt -- fill DIRECTION column properly (True), or reuse POINTING  
         table in original MS (False). this parameter is only  
         effective for MS input.  
    options: (bool) True, False  
    default: True  
field -- select data by field IDs and names  
        default: ’’ (use all fields)  
        example: field=’3C2*’ (all names starting with 3C2)  
                 field=’0,4,5~7’ (field IDs 0,4,5,6,7)  
                 field=’0,3C273’ (field ID 0 or field named 3C273)  
        this selection is in addition to the other selections to data  
spw -- select data by IF IDs (spectral windows)/channels  
        default: ’’ (use all IFs and channels)  
        example: spw=’3,5,7’ (IF IDs 3,5,7; all channels)  
                 spw=’<2’ (IF IDs less than 2, i.e., 0,1; all channels)  
                 spw=’30~45GHz’ (IF IDs with the center frequencies in range 30-45GHz; all channels)  
                 spw=’0:5~61’ (IF ID 0; channels 5 to 61; all channels)  
                 spw=’3:10~20;50~60’ (select multiple channel ranges within IF ID 3)  
                 spw=’3:10~20,4:0~30’ (select different channel ranges for IF IDs 3 and 4)  
                 spw=’1~4;6:15~48’ (for channels 15 through 48 for IF IDs 1,2,3,4 and 6)  
        this selection is in addition to the other selections to data  
timerange -- select data by time range  
        default: ’’ (use all)  
        example: timerange = ’YYYY/MM/DD/hh:mm:ss~YYYY/MM/DD/hh:mm:ss’  
                 Note: YYYY/MM/DD can be dropped as needed:  
                 timerange=’09:14:00~09:54:00’ # this time range  
                 timerange=’09:44:00’ # data within one integration of time  
                 timerange=’>10:24:00’ # data after this time  
                 timerange=’09:44:00+00:13:00’ #data 13 minutes after time  
        this selection is in addition to the other selections to data  
scan -- select data by scan numbers  
        default: ’’ (use all scans)  
        example: scan=’21~23’ (scan IDs 21,22,23)  
        this selection is in addition to the other selections to data  
pol -- select data by polarization IDs  
        default: ’’ (use all polarizations)  
        example: pol=’0,1’ (polarization IDs 0,1)  
        this selection is in addition to the other selections to data  
beam -- select data by beam IDs  
        default: ’’ (use all beams)  
        example: beam=’0,1’ (beam IDs 0,1)  
        this selection is in addition to the other selections to data  
restfreq -- the rest frequency  
            available type includes float, int, string, list of float,  
            list of int, list of string, and list of dictionary. the  
            default unit of restfreq in case of float, int, or string  
            without unit is Hz. string input can be a value only  
            (treated as Hz) or a value followed by unit for which ’GHz’,  
            ’MHz’,’kHz’,and ’Hz’ are available.  
            a list can be used to set different rest frequencies for  
            each IF. the length of list input must be number of IFs.  
            dictionary input should be a pair of line name and  
            frequency with keys of ’name’ and ’value’, respectively.  
            values in the dictionary input follows the same manner as  
            as for single float or string input.  
        example: 345.796  
                 ’1420MHz’  
                 [345.8, 347.0, 356.7]  
                 [’345.8MHz’, ’347.0MHz’, ’356.7MHz’]  
                 [{’name’:’CO’,’value’:345}]  
outfile -- name of output file  
        default: ’’ ((<infile>_saved)  
        NOTE actual output file name(s) will be modified if splitant  
        is True as antenna names are to be included. If outfile has a  
        suffix ’.asap’ or ’.ASAP’, antenna name will be inserted before  
        the suffix like ’out.antName.asap’, otherwise, antenna name  
        will be simply appended to outfile like ’out.sdfits.antName’.  
outform -- output file format  
        options: ’ASAP’,’MS2’, ’ASCII’,’SDFITS’  
        default: ’ASAP’  
        NOTE the ASAP format is easiest for further sd  
        processing; use MS2 for CASA imaging.  
        If ASCII, then will append some stuff to  
        the outfile name  
fillweight -- fill WEIGHT and SIGMA column for output MS  
        default: True  
        options: True, False  
 
-----------  
DESCRIPTION  
-----------  
Task sdsaveold writes the single dish data to a disk file in  
specified format (ASAP, MS2, SDFITS, ASCII). It is possible to  
save the subset of the data by selecting field names, spw ids,  
time ranges, scan numbers, and polarization ids. The ASAP  
(scantable) format is recommended for further analysis using Sd  
tool or tasks except imaging. For further imaging using imager  
or sdimaging, save the data to the Measurement Set (MS2).  
 
Note that setting getpt=False needs a lot of attention.  
If you set getpt=False, the task retrieves pointing direction from  
MS’s FIELD table, which might not be correct for single dish  
observation, instead to check MS’s POINTING table, which is the  
default behavior of the task (getpt=True). To compensate this,  
absolute path to MS’s POINTING table is stored, and it will be used  
for POINTING table when the data is converted back to MS format.  
In general, getpt=False is faster especially for large data. However,  
MS created from Scantable cannot have correct POINTING table if  
original MS’s POINTING table doesn’t exist. Such situation will  
happen when original MS is removed or renamed, or imported Scantable  
is moved to other computer alone.  
 
-------  
WARNING  
-------  
For the GBT raw SDFITS format data as input:  
SDtasks are able to handle GBT raw SDFITS format data since the data  
filler is available. However, the functionality is not well tested yet,  
so that there may be unknown bugs.  


More information about CASA may be found at the CASA web page

Copyright 2016 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