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 split_cli.py.

Constructor & Destructor Documentation

def split_cli.split_cli_.__init__ ( self )

Definition at line 26 of file split_cli.py.

Member Function Documentation

def split_cli.split_cli_.__call__	(	self,
		vis = `None`,
		outputvis = `None`,
		datacolumn = `None`,
		field = `None`,
		spw = `None`,
		width = `None`,
		antenna = `None`,
		timebin = `None`,
		timerange = `None`,
		scan = `None`,
		intent = `None`,
		array = `None`,
		uvrange = `None`,
		correlation = `None`,
		observation = `None`,
		combine = `None`,
		keepflags = `None`,
		keepmms = `None`,
		async = `None`
	)

Create a visibility subset from an existing visibility set

    Split is the general purpose program to make a new data set that is a
    subset or averaged form of an existing data set.  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.
    
    Split is often used after the initial calibration of the data to make a
    smaller measurement set with only the data that will be used in
    further flagging, imaging and/or self-calibration.  split can
    average over frequency (channels) and time (integrations).

    With the keepmms parameter, split can be run parallelized on multi-MS
    input.

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_src.ms'

datacolumn -- Which data column to split out
default='corrected'; 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.
Splitting with the default datacolumn='corrected'
before clean is normally required for self-calibration!

--- Data Selection (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 id'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.
       split does not support multiple channel ranges per spectral
       window (';') because it is not clear whether to keep the ranges
       in the original spectral window or make a new spectral window
       for each additional range.
width -- Defines the number of channel to average to form the one
 output channel.
 default: '1' => no channel averaging
 example: width=[2,3] => average 2 channels of 1st
          spectral window selected and 3 in the second one.
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'
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
intent -- Select by scan intent (state).  Case sensitive.
    default: '' = all
    Examples:
    intent = 'CALIBRATE_ATMOSPHERE_REFERENCE'
    intent = 'calibrate_atmosphere_reference'.upper() # same as above
    # Select states that include one or both of CALIBRATE_WVR.REFERENCE
    # or OBSERVE_TARGET_ON_SOURCE.
    intent = 'CALIBRATE_WVR.REFERENCE, OBSERVE_TARGET_ON_SOURCE'
correlation -- Select correlations, e.g. 'rr, ll' or ['XY', 'YX'].
       default '' (all).
observation -- Select by observation ID(s).
       default: '' = all
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.
keepflags -- If practical, keep completely flagged rows instead of
     dropping them.  This has absolutely no effect on averaging
     calculations, or partially flagged rows.  All of the
     channels and correlations of a row must be flagged for it
     to be droppable, and a row must be well defined to be
     keepable.  The latter condition means that this option has
     no effect on time averaging - in that case fully flagged
     rows are automatically omitted.  Regardless of this
     parameter, flagged data is never included in averaging
     calculations.

     The only time keepflags matters is if 
     1. the input MS has some completely flagged rows
     and
     2. time averaging is not being done.

     Then, if keepflags is False, the completely flagged rows
     will be omitted from the output MS.  Otherwise, they will
     be included (subject to the selection parameters).

keepmms -- If true and the input is a multi-MS, make the output one, too.
   Otherwise, the output will be a normal MS without partitioning. 
   (experimental)
   Default: False

Definition at line 46 of file split_cli.py.

def split_cli.split_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 427 of file split_cli.py.

def split_cli.split_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 362 of file split_cli.py.

def split_cli.split_cli_.description	(	self,
		key = `'split'`,
		subkey = `None`
	)

Definition at line 458 of file split_cli.py.

def split_cli.split_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 489 of file split_cli.py.

References accum_cli.accum_cli_.parameters, split_cli.split_cli_.parameters, splattotable_cli.splattotable_cli_.parameters, specfit_cli.specfit_cli_.parameters, smoothcal_cli.smoothcal_cli_.parameters, slsearch_cli.slsearch_cli_.parameters, simobserve_cli.simobserve_cli_.parameters, simanalyze_cli.simanalyze_cli_.parameters, simalma_cli.simalma_cli_.parameters, setjy_cli.setjy_cli_.parameters, sdtpimaging_cli.sdtpimaging_cli_.parameters, sdstat_cli.sdstat_cli_.parameters, sdsmooth_cli.sdsmooth_cli_.parameters, sdscale_cli.sdscale_cli_.parameters, sdsave_cli.sdsave_cli_.parameters, sdreduce_cli.sdreduce_cli_.parameters, sdplot_cli.sdplot_cli_.parameters, sdmath_cli.sdmath_cli_.parameters, sdlist_cli.sdlist_cli_.parameters, sdimprocess_cli.sdimprocess_cli_.parameters, sdimaging_cli.sdimaging_cli_.parameters, sdgrid_cli.sdgrid_cli_.parameters, sdflagmanager_cli.sdflagmanager_cli_.parameters, sdflag_cli.sdflag_cli_.parameters, sdfit_cli.sdfit_cli_.parameters, sdcoadd_cli.sdcoadd_cli_.parameters, sdcal_cli.sdcal_cli_.parameters, sdbaseline_cli.sdbaseline_cli_.parameters, rmtables_cli.rmtables_cli_.parameters, applycal_cli.applycal_cli_.parameters, predictcomp_cli.predictcomp_cli_.parameters, polcal_cli.polcal_cli_.parameters, plotxy_cli.plotxy_cli_.parameters, plotweather_cli.plotweather_cli_.parameters, plotuv_cli.plotuv_cli_.parameters, plotms_cli.plotms_cli_.parameters, plotcal_cli.plotcal_cli_.parameters, plotants_cli.plotants_cli_.parameters, peel_cli.peel_cli_.parameters, pclean_cli.pclean_cli_.parameters, partition_cli.partition_cli_.parameters, msview_cli.msview_cli_.parameters, msmoments_cli.msmoments_cli_.parameters, mosaic_cli.mosaic_cli_.parameters, makemask_cli.makemask_cli_.parameters, autoclean_cli.autoclean_cli_.parameters, listsdm_cli.listsdm_cli_.parameters, listpartition_cli.listpartition_cli_.parameters, listobs_cli.listobs_cli_.parameters, listhistory_cli.listhistory_cli_.parameters, listfits_cli.listfits_cli_.parameters, listcal_cli.listcal_cli_.parameters, imview_cli.imview_cli_.parameters, imval_cli.imval_cli_.parameters, imtrans_cli.imtrans_cli_.parameters, imsubimage_cli.imsubimage_cli_.parameters, imstat_cli.imstat_cli_.parameters, imsmooth_cli.imsmooth_cli_.parameters, imregrid_cli.imregrid_cli_.parameters, imreframe_cli.imreframe_cli_.parameters, importvla_cli.importvla_cli_.parameters, importuvfits_cli.importuvfits_cli_.parameters, importgmrt_cli.importgmrt_cli_.parameters, importfitsidi_cli.importfitsidi_cli_.parameters, importfits_cli.importfits_cli_.parameters, importevla_cli.importevla_cli_.parameters, importasdm_cli.importasdm_cli_.parameters, impbcor_cli.impbcor_cli_.parameters, immoments_cli.immoments_cli_.parameters, immath_cli.immath_cli_.parameters, imhead_cli.imhead_cli_.parameters, imfit_cli.imfit_cli_.parameters, imcontsub_cli.imcontsub_cli_.parameters, imcollapse_cli.imcollapse_cli_.parameters, hanningsmooth_cli.hanningsmooth_cli_.parameters, gencal_cli.gencal_cli_.parameters, gaincal_cli.gaincal_cli_.parameters, browsetable_cli.browsetable_cli_.parameters, fluxscale_cli.fluxscale_cli_.parameters, flagmanager_cli.flagmanager_cli_.parameters, flagdata_cli.flagdata_cli_.parameters, flagcmd_cli.flagcmd_cli_.parameters, fixvis_cli.fixvis_cli_.parameters, fixplanets_cli.fixplanets_cli_.parameters, find_cli.find_cli_.parameters, feather_cli.feather_cli_.parameters, exportuvfits_cli.exportuvfits_cli_.parameters, exportfits_cli.exportfits_cli_.parameters, exportasdm_cli.exportasdm_cli_.parameters, delmod_cli.delmod_cli_.parameters, deconvolve_cli.deconvolve_cli_.parameters, cvel_cli.cvel_cli_.parameters, csvclean_cli.csvclean_cli_.parameters, conjugatevis_cli.conjugatevis_cli_.parameters, concat_cli.concat_cli_.parameters, clearstat_cli.clearstat_cli_.parameters, clearplot_cli.clearplot_cli_.parameters, clearcal_cli.clearcal_cli_.parameters, clean_cli.clean_cli_.parameters, caltabconvert_cli.caltabconvert_cli_.parameters, calstat_cli.calstat_cli_.parameters, ft_cli.ft_cli_.parameters, boxit_cli.boxit_cli_.parameters, blcal_cli.blcal_cli_.parameters, bandpass_cli.bandpass_cli_.parameters, listvis_cli.listvis_cli_.parameters, asdmsummary_cli.asdmsummary_cli_.parameters, and recipes.almahelpers.SpwInfo.parameters.

Referenced by uvsub_cli.uvsub_cli_.defaults(), uvcontsub2_cli.uvcontsub2_cli_.defaults(), tclean_cli.tclean_cli_.defaults(), testconcat_cli.testconcat_cli_.defaults(), viewer_cli.viewer_cli_.defaults(), uvcontsub_cli.uvcontsub_cli_.defaults(), wvrgcal_cli.wvrgcal_cli_.defaults(), ssoflux_cli.ssoflux_cli_.defaults(), vishead_cli.vishead_cli_.defaults(), uvcontsub3_cli.uvcontsub3_cli_.defaults(), virtualconcat_cli.virtualconcat_cli_.defaults(), visstat_cli.visstat_cli_.defaults(), widebandpbcor_cli.widebandpbcor_cli_.defaults(), uvmodelfit_cli.uvmodelfit_cli_.defaults(), split_cli.split_cli_.defaults(), statwt_cli.statwt_cli_.defaults(), and widefield_cli.widefield_cli_.defaults().

def split_cli.split_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 338 of file split_cli.py.

def split_cli.split_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file split_cli.py.

References accum_cli.accum_cli_.__async__, split_cli.split_cli_.__async__, splattotable_cli.splattotable_cli_.__async__, specfit_cli.specfit_cli_.__async__, smoothcal_cli.smoothcal_cli_.__async__, slsearch_cli.slsearch_cli_.__async__, simobserve_cli.simobserve_cli_.__async__, simanalyze_cli.simanalyze_cli_.__async__, simalma_cli.simalma_cli_.__async__, setjy_cli.setjy_cli_.__async__, sdtpimaging_cli.sdtpimaging_cli_.__async__, sdstat_cli.sdstat_cli_.__async__, sdsmooth_cli.sdsmooth_cli_.__async__, sdscale_cli.sdscale_cli_.__async__, sdsave_cli.sdsave_cli_.__async__, sdreduce_cli.sdreduce_cli_.__async__, sdplot_cli.sdplot_cli_.__async__, sdmath_cli.sdmath_cli_.__async__, sdlist_cli.sdlist_cli_.__async__, sdimprocess_cli.sdimprocess_cli_.__async__, sdimaging_cli.sdimaging_cli_.__async__, sdgrid_cli.sdgrid_cli_.__async__, sdflagmanager_cli.sdflagmanager_cli_.__async__, sdflag_cli.sdflag_cli_.__async__, sdfit_cli.sdfit_cli_.__async__, sdcoadd_cli.sdcoadd_cli_.__async__, sdcal_cli.sdcal_cli_.__async__, sdbaseline_cli.sdbaseline_cli_.__async__, rmtables_cli.rmtables_cli_.__async__, predictcomp_cli.predictcomp_cli_.__async__, polcal_cli.polcal_cli_.__async__, plotxy_cli.plotxy_cli_.__async__, plotweather_cli.plotweather_cli_.__async__, plotuv_cli.plotuv_cli_.__async__, plotms_cli.plotms_cli_.__async__, plotcal_cli.plotcal_cli_.__async__, plotants_cli.plotants_cli_.__async__, peel_cli.peel_cli_.__async__, pclean_cli.pclean_cli_.__async__, partition_cli.partition_cli_.__async__, msview_cli.msview_cli_.__async__, msmoments_cli.msmoments_cli_.__async__, mosaic_cli.mosaic_cli_.__async__, makemask_cli.makemask_cli_.__async__, listvis_cli.listvis_cli_.__async__, listsdm_cli.listsdm_cli_.__async__, listpartition_cli.listpartition_cli_.__async__, listobs_cli.listobs_cli_.__async__, listhistory_cli.listhistory_cli_.__async__, listfits_cli.listfits_cli_.__async__, listcal_cli.listcal_cli_.__async__, imview_cli.imview_cli_.__async__, imval_cli.imval_cli_.__async__, imtrans_cli.imtrans_cli_.__async__, imsubimage_cli.imsubimage_cli_.__async__, imstat_cli.imstat_cli_.__async__, imsmooth_cli.imsmooth_cli_.__async__, imregrid_cli.imregrid_cli_.__async__, imreframe_cli.imreframe_cli_.__async__, importvla_cli.importvla_cli_.__async__, importuvfits_cli.importuvfits_cli_.__async__, importgmrt_cli.importgmrt_cli_.__async__, importfitsidi_cli.importfitsidi_cli_.__async__, importfits_cli.importfits_cli_.__async__, importevla_cli.importevla_cli_.__async__, importasdm_cli.importasdm_cli_.__async__, impbcor_cli.impbcor_cli_.__async__, immoments_cli.immoments_cli_.__async__, immath_cli.immath_cli_.__async__, imhead_cli.imhead_cli_.__async__, imfit_cli.imfit_cli_.__async__, imcontsub_cli.imcontsub_cli_.__async__, imcollapse_cli.imcollapse_cli_.__async__, hanningsmooth_cli.hanningsmooth_cli_.__async__, gencal_cli.gencal_cli_.__async__, gaincal_cli.gaincal_cli_.__async__, ft_cli.ft_cli_.__async__, fluxscale_cli.fluxscale_cli_.__async__, flagmanager_cli.flagmanager_cli_.__async__, flagdata_cli.flagdata_cli_.__async__, flagcmd_cli.flagcmd_cli_.__async__, fixvis_cli.fixvis_cli_.__async__, fixplanets_cli.fixplanets_cli_.__async__, find_cli.find_cli_.__async__, feather_cli.feather_cli_.__async__, exportuvfits_cli.exportuvfits_cli_.__async__, exportfits_cli.exportfits_cli_.__async__, exportasdm_cli.exportasdm_cli_.__async__, delmod_cli.delmod_cli_.__async__, deconvolve_cli.deconvolve_cli_.__async__, cvel_cli.cvel_cli_.__async__, csvclean_cli.csvclean_cli_.__async__, conjugatevis_cli.conjugatevis_cli_.__async__, concat_cli.concat_cli_.__async__, clearstat_cli.clearstat_cli_.__async__, clearplot_cli.clearplot_cli_.__async__, clearcal_cli.clearcal_cli_.__async__, clean_cli.clean_cli_.__async__, caltabconvert_cli.caltabconvert_cli_.__async__, calstat_cli.calstat_cli_.__async__, browsetable_cli.browsetable_cli_.__async__, boxit_cli.boxit_cli_.__async__, blcal_cli.blcal_cli_.__async__, bandpass_cli.bandpass_cli_.__async__, autoclean_cli.autoclean_cli_.__async__, asdmsummary_cli.asdmsummary_cli_.__async__, and applycal_cli.applycal_cli_.__async__.

Member Data Documentation

dictionary split_cli.split_cli_.__async__ [static, private]

Definition at line 20 of file split_cli.py.

Referenced by split_cli.split_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(), and ssoflux_cli.ssoflux_cli_.result().

split_cli.split_cli_.__bases__ [private]

Definition at line 27 of file split_cli.py.

split_cli.split_cli_.__doc__ [private]

Definition at line 28 of file split_cli.py.

split_cli.split_cli_.__globals__ [private]

Definition at line 199 of file split_cli.py.

string split_cli.split_cli_.__name__ [static, private]

Definition at line 19 of file split_cli.py.

split_cli.split_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file split_cli.py.

split_cli.split_cli_.parameters

Definition at line 30 of file split_cli.py.

Referenced by tclean_cli.tclean_cli_.itsdefault(), vishead_cli.vishead_cli_.itsdefault(), wvrgcal_cli.wvrgcal_cli_.itsdefault(), widebandpbcor_cli.widebandpbcor_cli_.itsdefault(), visstat_cli.visstat_cli_.itsdefault(), uvmodelfit_cli.uvmodelfit_cli_.itsdefault(), split_cli.split_cli_.itsdefault(), statwt_cli.statwt_cli_.itsdefault(), and widefield_cli.widefield_cli_.itsdefault().

tuple split_cli.split_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 406 of file split_cli.py.

tuple split_cli.split_cli_.retval [static]

Definition at line 419 of file split_cli.py.

split_cli.split_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file split_cli.py.

string split_cli.split_cli_.valornotval [static]

Definition at line 409 of file split_cli.py.

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

split_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