listpartition_pg.listpartition_pg_ Class Reference

List of all members.

Public Member Functions
def	__init__
def	__call__
Private Attributes
	__bases__
	__doc__
Static Private Attributes
string	__name__

---

Detailed Description

Definition at line 18 of file listpartition_pg.py.

---

Constructor & Destructor Documentation

def listpartition_pg.listpartition_pg_.__init__

(

self

)

Definition at line 21 of file listpartition_pg.py.

---

Member Function Documentation

def listpartition_pg.listpartition_pg_.__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 26 of file listpartition_pg.py.

References vla_uvfits_line_sf.verify.

---

Member Data Documentation

listpartition_pg.listpartition_pg_.__bases__ [private]

Definition at line 22 of file listpartition_pg.py.

listpartition_pg.listpartition_pg_.__doc__ [private]

Definition at line 23 of file listpartition_pg.py.

string listpartition_pg.listpartition_pg_.__name__ [static, private]

Definition at line 19 of file listpartition_pg.py.

---

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

• listpartition_pg.py