NRAO Home > CASA > CASA Task Reference Manual

0.1.114 sdscaleold

Requires:

Synopsis
Scale the sd spectra

Description

Task sdscaleold performs scaling of single-dish spectra by scaling factor given by parameter named factor. By setting scaletsys = True, associated Tsys is also scaled.

Arguments





Inputs

infile

name of input SD dataset

allowed:

string

Default:

antenna

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

allowed:

any

Default:

variant 0

factor

scaling factor (float or float list)

allowed:

any

Default:

variant 1.0

scaletsys

scaling of associated Tsys

allowed:

bool

Default:

True

outfile

name of output file (See a WARNING in help)

allowed:

string

Default:

overwrite

overwrite the output file if already exists

allowed:

bool

Default:

False

verbose

Print verbose log output

allowed:

bool

Default:

True

Returns
void

Example

 
------------------  
Keyword arguments  
------------------  
infile -- name of input SD dataset  
antenna -- select an antenna name or ID  
        default: 0  
        example: ’PM03’  
        NOTE this parameter is effective only for MS input  
factor -- scaling factor. float, one- or two-dimensional float list,  
          or filename storing scaling factor are acceptable  
       default: 1.0 (no scaling)  
       example: see description below  
scaletsys -- scaling of associated Tsys  
          options: (bool) True, False  
          default: True  
outfile -- name of output file  
        default: outfile=’’ (<infile>_scaled<factor>)  
        example: ’scaled.asap’  
overwrite -- overwrite the output file if already exists  
        options: (bool) True,False  
        default: False  
        NOTE this parameter is ignored when outform=’ASCII’  
verbose -- Print verbose log messages. If True, Tsys values before  
           (and after) scaling are printed to logger.  
          options: (bool) True, False  
          default: True  
 
-----------  
DESCRIPTION  
-----------  
Task sdscaleold performs scaling of single-dish spectra.  
Associated Tsys is also scaled if scaletsys is True.  
Tsys informations are written in the casalogger and they are  
automatically stored in ’casapy.log’.  
The infile can be any of ASAP, MS, SDFITS, or RPFITS format.  
If outfile name is given or outfile=’’(default), the scaled data  
is written to a new file with the same format as the input data  
(Note: in case of the RPFITS format input data, it will be written  
to SDFITS format).  
 
The scaling factor, factor, accepts both scalar type and list  
type value. The list must be one or two dimensional. If factor is  
one dimensional, its length must coincide with a number of spectral  
channel. If factor is two dimensional, its shape must be  
(n, 1) or (n, m), where n is a number of spectrum, while m is a  
number of channel for each spcetum. m can be variable for each  
spectrum. In addition, the factor can be an ASCII filename that  
stores a space-separated list of scaling factor consisting of  
adequate number of rows and columns. For example, if the contents  
of input ASCII file is shown as,  
 
   0.5 0.3 0.2  
   1.0 0.2 0.9  
 
it is interpreted as a list [[0.5, 0.3, 0.2],[1.0, 0.2, 0.9]].  
 
-------  
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