NRAO Home > CASA > CASA Toolkit Reference Manual
ms.summary - Function

1.3.1 (PARTIALLY IMPLEMENTED!!!) Summarize the measurement set


Description

This method will print a summary of the measurement set to the system logger. The verbose argument provides some control on how much information is displayed.

For especially large datasets, the cachesize parameter can be increased for possibly better performance.

This method can also return, in the header argument, a record containing the following fields.

nrow
Number of rows in the measurement set
name
Name of the measurement set

DESCRIPTION OF ALGORITHM TO CALCULATE THE NUMBER OF UNFLAGGED ROWS The number of unflagged rows will only be computed if listunflis True. The number of unflagged rows (the nUnflRows columns in the scans and fields portions of the listing) is calculated by summing the fractional unflagged bandwidth for each row (and hence why the number of unflagged rows, in general, is not an integer). Thus a row which has half of its total bandwidth flagged contributes 0.5 rows to the unflagged row count. A row with 20 of 32 channels of homogeneous width contributes 20/32 = 0.625 rows to the unflagged row count. A row with a value of False in the FLAG_ROW column is not counted in the number of unflagged rows.

Arguments





Inputs

verbose

Produce verbose logging output

allowed:

bool

Default:

false

listfile

Output file

allowed:

string

Default:

listunfl

List unflagged row counts? If true, it can have significant negative performance impact.

allowed:

bool

Default:

false

cachesize

EXPERIMENTAL. Maximum size in megabytes of cache in which data structures can be held.

allowed:

double

Default:

50

overwrite

If True, tacitly overwrite listfile if it exists.

allowed:

bool

Default:

false

wantreturn

If true, construct a record containing summary info and return it, else return nothing. If you don’t need the record and just want the log output, setting this to False will provide a small performance increase.

allowed:

bool

Default:

true

Returns
record

Example

 
 
 
      ms.open(’3C273XC1.MS’)  
      outr=ms.summary(verbose=True)  
      ###print the begining of observation in this ms  
      print qa.time(qa.quantity(outr[’header’][’BeginTime’],’d’), form=’ymd’)  
      ###print  a dictionary of the info of scan 1  
      outr[’header’][’scan_1’]  
 
    This example will send a verbose summary of the measurement  
    set to the logger.  

__________________________________________________________________


More information about CASA may be found at the CASA web page

Copyright 2016 Associated Universities Inc., Washington, D.C.

This code is available under the terms of the GNU General Public Lincense


Home | Contact Us | Directories | Site Map | Help | Privacy Policy | Search