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

Constructor & Destructor Documentation

def listpartition_cli.listpartition_cli_.__init__ ( self )

Definition at line 26 of file listpartition_cli.py.

Member Function Documentation

def listpartition_cli.listpartition_cli_.__call__	(	self,
		vis = `None`,
		createdict = `None`,
		listfile = `None`,
		async = `None`
	)

List the summary of a multi-MS data set in the logger or in a file

       A multi-measurement set (MMS) is an MS that has been split into sub-MSs.
       An MMS contains a reference MS in the top directory and the sub-MSs are 
       located in a directory called SUBMSS inside the MMS directory.
       Example of a MS that was 'split' in two scans using the task partition: 
       
       > ls pScan.mms/
 SUBMSS/     table.dat   table.info
       
       > ls pScan.mms/SUBMSS/
 pScan.0000.ms/ pScan.0001.ms/
       
       
       The task lists the following properties of a multi-MS or MS:
       sub-MS name, scan, spw list, list of number of channels per spw, 
       number of rows for each scan and the size in disk. Example of logger output:
       
Sub-MS         Scan  Spw               Nchan             Nrows   Size  
pScan.0000.ms  31    [ 0  1  2  3  4]  [64 64 64 64 64]  8640    42M   
pScan.0001.ms  30    [ 0  1  2  3  4]  [64 64 64 64 64]  8544    42M   



       Keyword arguments:
       vis -- Name of multi-MS or normal MS.
      default: ''. 
      example: vis='pScan.mms'

       createdict -- Create and return a dictionary containing scan summaries of each
     sub-MS. 
      default: False
      
      If set to True, the returned dictionary will contain information from
      ms.getscansummary() and ms.getspectralwindowinfo(), with the addition of an 
      index as the top key and the sub-MS name.
      Example:
      
    {0: {'MS': 'pScan.0000.ms',
 'scanId': {31: {'nchans': array([64, 64, 64, 64, 64]),
                 'nrows': 8640,
                 'spwIds': array([ 0,  1,  2,  3,  4])}},
 'size': '42M'},
     1: {'MS': 'pScan.0001.ms',
 'scanId': {30: {'nchans': array([64, 64, 64, 64, 64]),
                 'nrows': 8544,
                 'spwIds': array([ 0,  1,  2,  3,  4])}},
 'size': '42M'}}

    
       listfile -- Name of ASCII file to save output to. If empty, it will 
   list on the logger/terminal.
      default: ''
      example: listfile='pscan.txt'

Definition at line 46 of file listpartition_cli.py.

def listpartition_cli.listpartition_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 287 of file listpartition_cli.py.

def listpartition_cli.listpartition_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 238 of file listpartition_cli.py.

def listpartition_cli.listpartition_cli_.description	(	self,
		key = `'listpartition'`,
		subkey = `None`
	)

Definition at line 318 of file listpartition_cli.py.

def listpartition_cli.listpartition_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 330 of file listpartition_cli.py.

def listpartition_cli.listpartition_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 214 of file listpartition_cli.py.

def listpartition_cli.listpartition_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file listpartition_cli.py.

References accum_cli.accum_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 listpartition_cli.listpartition_cli_.__async__ [static, private]

Definition at line 20 of file listpartition_cli.py.

Referenced by listpartition_cli.listpartition_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(), pclean_cli.pclean_cli_.result(), partition_cli.partition_cli_.result(), msview_cli.msview_cli_.result(), msmoments_cli.msmoments_cli_.result(), mosaic_cli.mosaic_cli_.result(), makemask_cli.makemask_cli_.result(), listvis_cli.listvis_cli_.result(), and listsdm_cli.listsdm_cli_.result().

listpartition_cli.listpartition_cli_.__bases__ [private]

Definition at line 27 of file listpartition_cli.py.

listpartition_cli.listpartition_cli_.__doc__ [private]

Definition at line 28 of file listpartition_cli.py.

listpartition_cli.listpartition_cli_.__globals__ [private]

Definition at line 105 of file listpartition_cli.py.

string listpartition_cli.listpartition_cli_.__name__ [static, private]

Definition at line 19 of file listpartition_cli.py.

listpartition_cli.listpartition_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file listpartition_cli.py.

listpartition_cli.listpartition_cli_.parameters

Definition at line 30 of file listpartition_cli.py.

tuple listpartition_cli.listpartition_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 266 of file listpartition_cli.py.

tuple listpartition_cli.listpartition_cli_.retval [static]

Definition at line 279 of file listpartition_cli.py.

listpartition_cli.listpartition_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file listpartition_cli.py.

string listpartition_cli.listpartition_cli_.valornotval [static]

Definition at line 269 of file listpartition_cli.py.

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

listpartition_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