sdmath

Synopsis ASAP SD task: do simple arithmatic (subtraction, addition, multiplication, and division) for spectra Description

ASAP SD task: Do simple arithmatic (subtraction, addition, multiplication, and division) for spectra


Inputs
expr	Mathematical expression using spectra
	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:
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:
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

  Keyword arguments:
        expr -- Mathematical expression using scantables
        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
        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
        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

        DESCRIPTION:

        Task sdmath execute a mathematical expression for single dish spectra.
        The spectral data file can be any of the formats supported by
        ASAP (scantable, MS, rpfits, and SDFITS). In the expression,
        these file names should be put inside of sigle or double quotes.

        The fluxunit, specunit, and frame can be set, otherwise, the current
        settings of the first spectral data in the expression are used.
        Other selections (e.g. scan No, . IF, Pol) also apply to all
        the spectral data in the expression, so if any of the data does
        not contains selection, the task will produce no output.

        Example:
        # do on-off/off calculation
        expr=’("orion_on_data.asap"-"orion_off_data.asap")/"orion_off_data.asap"
        outfile=’orion_cal.asap’
        sdmath()

0.1.61 sdmath