task_split Namespace Reference

Functions
def	split
def	split_core

---

Function Documentation

def task_split.split	(		vis,
			outputvis,
			datacolumn,
			field,
			spw,
			width,
			antenna,
			timebin,
			timerange,
			scan,
			intent,
			array,
			uvrange,
			correlation,
			observation,
			combine,
			keepflags,
			keepmms
	)

Create a visibility subset from an existing visibility set:

Keyword arguments:
vis -- Name of input visibility file (MS)
        default: none; example: vis='ngc5921.ms'
outputvis -- Name of output visibility file (MS)
              default: none; example: outputvis='ngc5921_src.ms'
datacolumn -- Which data column to split out
              default='corrected'; example: datacolumn='data'
              Options: 'data', 'corrected', 'model', 'all',
              'float_data', 'lag_data', 'float_data,data', and
              'lag_data,data'.
              note: 'all' = whichever of the above that are present.
field -- Field name
          default: field = '' means  use all sources
          field = 1 # will get field_id=1 (if you give it an
                      integer, it will retrieve the source with that index)
          field = '1328+307' specifies source '1328+307'.
             Minimum match can be used, egs  field = '13*' will
             retrieve '1328+307' if it is unique or exists.
             Source names with imbedded blanks cannot be included.
spw -- Spectral window index identifier
        default=-1 (all); example: spw=1
antenna -- antenna names
           default '' (all),
           antenna = '3 & 7' gives one baseline with antennaid = 3,7.
timebin -- Interval width for time averaging.
           default: '0s' or '-1s' (no averaging)
           example: timebin='30s'
timerange -- Time range
             default='' means all times.  examples:
             timerange = 'YYYY/MM/DD/hh:mm:ss~YYYY/MM/DD/hh:mm:ss'
             timerange='< YYYY/MM/DD/HH:MM:SS.sss'
             timerange='> YYYY/MM/DD/HH:MM:SS.sss'
             timerange='< ddd/HH:MM:SS.sss'
             timerange='> ddd/HH:MM:SS.sss'
scan -- Scan numbers to select.
        default '' (all).
intent -- Scan intents to select.
        default '' (all).
array -- (Sub)array IDs to select.     
         default '' (all).
uvrange -- uv distance range to select.
           default '' (all).
correlation -- Select correlations, e.g. 'rr, ll' or ['XY', 'YX'].
               default '' (all).
observation -- Select by observation ID(s).
               default '' (all).
combine -- Data descriptors that time averaging can ignore:
              scan, and/or state
              Default '' (none)
keepflags -- Keep flagged data, if possible
             Default True

keepmms -- If the input is a multi-MS, make the output one, too. (experimental)
           Default: False

Definition at line 12 of file task_split.py.

References taskinit.mstool, split_core(), and taskinit.tbtool.

def task_split.split_core	(		vis,
			outputvis,
			datacolumn,
			field,
			spw,
			width,
			antenna,
			timebin,
			timerange,
			scan,
			intent,
			array,
			uvrange,
			correlation,
			observation,
			combine,
			keepflags
	)

Definition at line 233 of file task_split.py.

References taskinit.mstool, taskinit.tbtool, update_spw.update_spwchan(), and taskinit.write_history().

Referenced by split().