Public Member Functions
def	__init__
def	result
def	__call__
def	paramgui
def	defaults
def	check_params
def	description
def	itsdefault
Public Attributes
	parameters
Static Public Attributes
	rkey
	Handle globals or user over-ride of arguments.
	i_am_a_casapy_task
list	retval
	This function sets the default values but also will return the list of parameters or the default value of a given parameter.
string	valornotval
tuple	retval
Private Attributes
	__bases__
	__doc__
	__globals__
Static Private Attributes
string	__name__
dictionary	__async__

Detailed Description

Definition at line 18 of file partition_cli.py.

Constructor & Destructor Documentation

def partition_cli.partition_cli_.__init__ ( self )

Definition at line 26 of file partition_cli.py.

Member Function Documentation

def partition_cli.partition_cli_.__call__	(	self,
		vis = `None`,
		outputvis = `None`,
		createmms = `None`,
		separationaxis = `None`,
		numsubms = `None`,
		datacolumn = `None`,
		calmsselection = `None`,
		calmsname = `None`,
		calfield = `None`,
		calscan = `None`,
		calintent = `None`,
		field = `None`,
		spw = `None`,
		antenna = `None`,
		timebin = `None`,
		combine = `None`,
		timerange = `None`,
		scan = `None`,
		scanintent = `None`,
		array = `None`,
		uvrange = `None`,
		observation = `None`,
		async = `None`
	)

Experimental task to produce multi-MSs using parallelism
    Experimental version for use with parallelization framework.  
    Do not use this for standard analysis... yet.

    Partition is a task to create a multi-MS out of an MS. General selection
    parameters are included, and one or all of the various data columns
    (DATA, LAG_DATA and/or FLOAT_DATA, and possibly MODEL_DATA and/or
    CORRECTED_DATA) can be selected. It can also be used to create a normal
    MS, split based on the given data selection parameters.

    The partition task creates a multi-MS using the parallelization framework.
    If a cluster is not present, it will create a default cluster based on the
    resources of the system. One can create a simple_cluster prior to running
    partition by doing the following.

    from simple_cluster import *
    sc = simple_cluster()
    sc.init_cluster('cluster-config.txt', 'test')

    The file 'cluster-config.txt' contains information on the machine that will
    be used for the cluster. Please see the help of simple_cluster for more information.        

    A multi-MS is structured to have a reference MS on the top directory and a
    sub-directory called SUBMSS, which contain each partitioned sub-MS. The
    reference MS contains links to the sub-tables of the first sub-MS. The other
    sub-MSs contain a copy of the sub-tables each. A multi-MS looks like this in disk.

    ls ngc5921.mms
    ANTENNA           FLAG_CMD     POLARIZATION  SPECTRAL_WINDOW  table.dat
    DATA_DESCRIPTION  HISTORY      PROCESSOR     STATE            table.info
    FEED              OBSERVATION  SORTED_TABLE  SUBMSS           WEATHER
    FIELD             POINTING     SOURCE        SYSCAL

    ls ngc5921.mms/SUBMSS/
    ngc5921.0000.ms/  ngc5921t.0002.ms/  ngc5921.0004.ms/  ngc5921.0006.ms/
    ngc5921.0001.ms/  ngc5921.0003.ms/  ngc5921.0005.ms/

    Inside casapy, one can use the task listpartition to list the information
    from a multi-MS.
  

    Keyword arguments:
    vis -- Name of input visibility file
default: none; example: vis='ngc5921.ms'

    outputvis -- Name of output visibility file
default: none; example: outputvis='ngc5921.mms'

    createmms -- Create a multi-MS as the output.
default: True
If False, it will work like the split task and create a
normal MS, split according to the given data selection parameters.
Note that, when this parameter is set to False, a simple_cluster
will not be created.

separationaxis -- Axis to do parallelization across. 
    default: 'scan'
    Options: 'scan', 'spw', 'both'
    The 'both' option will try to partition in both scan and spw axes.

numsubms -- The number of sub-MSs to create.
    default: 64
                

    datacolumn -- Which data column to use when partitioning.
default='data'; example: datacolumn='data'
Options: 'data', 'model', 'corrected', 'all',
'float_data', 'lag_data', 'float_data,data', and
'lag_data,data'.
    N.B.: 'all' = whichever of the above that are present.
    Otherwise the selected column will go to DATA (or
    FLOAT_DATA) in the output.

    calmsselection -- Method by which the calibration scans will be identified
    when creating a separate calibration MS.
default:'none'
Options: 'none', 'auto', 'manual'.

'auto' -- 
    calmsname -- Name of output measurement set.
default = ' '

'manual'
    calmsname -- Name of output measurement set.
default: ''
    calfield -- Field selection for calibration MS.
default: ''
    calscans -- Scan selection for calibration MS.
default: ''
    calintent -- Scan intent selection for calibration MS.
default: ''

--- Data selection parameters (see help par.selectdata for more detailed
    information)

    field -- Select field using field id(s) or field name(s).
     [run listobs to obtain the list iof d's or names]
default: ''=all fields If field string is a non-negative
   integer, it is assumed to be a field index
   otherwise, it is assumed to be a field name
   field='0~2'; field ids 0,1,2
   field='0,4,5~7'; field ids 0,4,5,6,7
   field='3C286,3C295'; fields named 3C286 and 3C295
   field = '3,4C*'; field id 3, all names starting with 4C

    spw -- Select spectral window/channels
default: ''=all spectral windows and channels
   spw='0~2,4'; spectral windows 0,1,2,4 (all channels)
   spw='<2';  spectral windows less than 2 (i.e. 0,1)
   spw='0:5~61'; spw 0, channels 5 to 61
   spw='0,10,3:3~45'; spw 0,10 all channels, spw 3 - chans 3 to 45.
   spw='0~2:2~6'; spw 0,1,2 with channels 2 through 6 in each.
   spw = '*:3~64'  channels 3 through 64 for all sp id's
   spw = ' :3~64' will NOT work.
   spw = '*:0;60~63'  channel 0 and channels 60 to 63 for all IFs 
  ';' needed to separate different channel ranges in one spw
   spw='0:0~10;15~60'; spectral window 0 with channels 0-10,15-60
   spw='0:0~10,1:20~30,2:1;2;4'; spw 0, channels 0-10,
    spw 1, channels 20-30, and spw 2, channels, 1, 2 and 4

    antenna -- Select data based on antenna/baseline
default: '' (all)
    Non-negative integers are assumed to be antenna indices, and
    anything else is taken as an antenna name.

    Examples:
    antenna='5&6': baseline between antenna index 5 and index 6.
    antenna='VA05&VA06': baseline between VLA antenna 5 and 6.
    antenna='5&6;7&8': baselines 5-6 and 7-8
    antenna='5': all baselines with antenna 5
    antenna='5,6,10': all baselines including antennas 5, 6, or 10
    antenna='5,6,10&': all baselines with *only* antennas 5, 6, or
                   10.  (cross-correlations only.  Use &&
                   to include autocorrelations, and &&&
                   to get only autocorrelations.)
    antenna='!ea03,ea12,ea17': all baselines except those that
                       include EVLA antennas ea03, ea12, or
                       ea17.

    timebin -- Interval width for time averaging.
default: '0s' or '-1s' (no averaging)
Example: timebin='30s'
 '10' means '10s'

combine -- Let time bins span changes in scan and/or state.
    default = '' (separate time bins by both of the above)
       combine = 'scan': Can be useful when the scan number
                 goes up with each integration,
                 as in many WSRT MSes.
       combine = ['scan', 'state']: disregard scan and state
                            numbers when time averaging.
       combine = 'state,scan': Same as above.

    timerange -- Select data based on time range:
default = '' (all); examples,
   timerange = 'YYYY/MM/DD/hh:mm:ss~YYYY/MM/DD/hh:mm:ss'
   Note: if YYYY/MM/DD is missing date, timerange defaults to the
   first day in the dataset
   timerange='09:14:0~09:54:0' picks 40 min on first day
   timerange='25:00:00~27:30:00' picks 1 hr to 3 hr 30min
   on next day
   timerange='09:44:00' data within one integration of time
   timerange='>10:24:00' data after this time

    array -- (Sub)array number range
default: ''=all

    uvrange -- Select data within uvrange (default units meters)
default: ''=all; example:
    uvrange='0~1000klambda'; uvrange from 0-1000 kilo-lambda
    uvrange='>4klambda';uvranges greater than 4 kilo-lambda
    uvrange='0~1000km'; uvrange in kilometers

    scan -- Scan number range
default: ''=all

    observation -- Select by observation ID(s)
default: ''=all

Definition at line 46 of file partition_cli.py.

def partition_cli.partition_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 471 of file partition_cli.py.

def partition_cli.partition_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 401 of file partition_cli.py.

def partition_cli.partition_cli_.description	(	self,
		key = `'partition'`,
		subkey = `None`
	)

Definition at line 502 of file partition_cli.py.

def partition_cli.partition_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 537 of file partition_cli.py.

def partition_cli.partition_cli_.paramgui	(	self,
		useGlobals = `True`,
		ipython_globals = `None`
	)

Opens a parameter GUI for this task.  If useGlobals is true, then any relevant global parameter settings are used.

Definition at line 377 of file partition_cli.py.

def partition_cli.partition_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file partition_cli.py.

Member Data Documentation

dictionary partition_cli.partition_cli_.__async__ [static, private]

Definition at line 20 of file partition_cli.py.

Referenced by partition_cli.partition_cli_.result(), wvrgcal_cli.wvrgcal_cli_.result(), widefield_cli.widefield_cli_.result(), widebandpbcor_cli.widebandpbcor_cli_.result(), visstat_cli.visstat_cli_.result(), vishead_cli.vishead_cli_.result(), virtualconcat_cli.virtualconcat_cli_.result(), viewer_cli.viewer_cli_.result(), uvsub_cli.uvsub_cli_.result(), uvmodelfit_cli.uvmodelfit_cli_.result(), uvcontsub_cli.uvcontsub_cli_.result(), uvcontsub3_cli.uvcontsub3_cli_.result(), uvcontsub2_cli.uvcontsub2_cli_.result(), testconcat_cli.testconcat_cli_.result(), tclean_cli.tclean_cli_.result(), statwt_cli.statwt_cli_.result(), ssoflux_cli.ssoflux_cli_.result(), split_cli.split_cli_.result(), splattotable_cli.splattotable_cli_.result(), specfit_cli.specfit_cli_.result(), smoothcal_cli.smoothcal_cli_.result(), slsearch_cli.slsearch_cli_.result(), simobserve_cli.simobserve_cli_.result(), simanalyze_cli.simanalyze_cli_.result(), simalma_cli.simalma_cli_.result(), setjy_cli.setjy_cli_.result(), sdtpimaging_cli.sdtpimaging_cli_.result(), sdstat_cli.sdstat_cli_.result(), sdsmooth_cli.sdsmooth_cli_.result(), sdscale_cli.sdscale_cli_.result(), sdsave_cli.sdsave_cli_.result(), sdreduce_cli.sdreduce_cli_.result(), sdplot_cli.sdplot_cli_.result(), sdmath_cli.sdmath_cli_.result(), sdlist_cli.sdlist_cli_.result(), sdimprocess_cli.sdimprocess_cli_.result(), sdimaging_cli.sdimaging_cli_.result(), sdgrid_cli.sdgrid_cli_.result(), sdflagmanager_cli.sdflagmanager_cli_.result(), sdflag_cli.sdflag_cli_.result(), sdfit_cli.sdfit_cli_.result(), sdcoadd_cli.sdcoadd_cli_.result(), sdcal_cli.sdcal_cli_.result(), sdbaseline_cli.sdbaseline_cli_.result(), rmtables_cli.rmtables_cli_.result(), predictcomp_cli.predictcomp_cli_.result(), polcal_cli.polcal_cli_.result(), plotxy_cli.plotxy_cli_.result(), plotweather_cli.plotweather_cli_.result(), plotuv_cli.plotuv_cli_.result(), plotms_cli.plotms_cli_.result(), plotcal_cli.plotcal_cli_.result(), plotants_cli.plotants_cli_.result(), peel_cli.peel_cli_.result(), and pclean_cli.pclean_cli_.result().

partition_cli.partition_cli_.__bases__ [private]

Definition at line 27 of file partition_cli.py.

partition_cli.partition_cli_.__doc__ [private]

Definition at line 28 of file partition_cli.py.

partition_cli.partition_cli_.__globals__ [private]

Definition at line 230 of file partition_cli.py.

string partition_cli.partition_cli_.__name__ [static, private]

Definition at line 19 of file partition_cli.py.

partition_cli.partition_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file partition_cli.py.

partition_cli.partition_cli_.parameters

Definition at line 30 of file partition_cli.py.

tuple partition_cli.partition_cli_.retval [static]

This function sets the default values but also will return the list of parameters or the default value of a given parameter.

Definition at line 450 of file partition_cli.py.

tuple partition_cli.partition_cli_.retval [static]

Definition at line 463 of file partition_cli.py.

partition_cli.partition_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file partition_cli.py.

string partition_cli.partition_cli_.valornotval [static]

Definition at line 453 of file partition_cli.py.

The documentation for this class was generated from the following file:

partition_cli.py

Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation