task_partition Namespace Reference

Classes
class	PartitionHelper
Functions
def	partition

---

Function Documentation

def task_partition.partition	(		vis,
			outputvis,
			createmms,
			separationaxis,
			numsubms,
			datacolumn,
			calmsselection,
			calmsname,
			calfield,
			calscan,
			calintent,
			field,
			spw,
			antenna,
			timebin,
			combine,
			timerange,
			scan,
			scanintent,
			array,
			uvrange,
			observation
	)

Create a multi visibility set 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'
createmms -- Boolean flag if we're creating Multi MS
              default: True
    separationaxis -- what axis do we intend to split on.
               default = 'scan'
               Options: 'scan','spw','both'
    numsubms -- Number of sub-MSs to create.
                default: 64
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.
calmsselection -- Method by which to create a separate Calibration ms
               default = 'none'
               options: 'none','auto','manual'
    calmsname -- Name of output calibration visibility file (MS)
              default: none; example: outputvis='ngc5921_CAL.ms'
    calfield -- Field selection for calibration MS.
              default: ''
    calscans -- Scan selection for calibration MS.
              default: ''
    calintent -- Scan intent selection for calibration MS.
              default: ''
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'
    combine -- Data descriptors that time averaging can ignore:
              scan, and/or state
              Default '' (none)
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).
scanintent -- Select based on the scan intent.
              default '' (all)
array -- (Sub)array IDs to select.     
         default '' (all).
uvrange -- uv distance range to select.
           default '' (all).
observation -- observation ID(s) to select.
               default '' (all).

Definition at line 504 of file task_partition.py.

References taskinit.mstool, and taskinit.write_history().

Referenced by task_partition.PartitionHelper.__partition().