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

Constructor & Destructor Documentation

def visstat_cli.visstat_cli_.__init__ ( self )

Definition at line 26 of file visstat_cli.py.

Member Function Documentation

def visstat_cli.visstat_cli_.__call__	(	self,
		vis = `None`,
		axis = `None`,
		datacolumn = `None`,
		useflags = `None`,
		spw = `None`,
		field = `None`,
		selectdata = `None`,
		antenna = `None`,
		uvrange = `None`,
		timerange = `None`,
		correlation = `None`,
		scan = `None`,
		array = `None`,
		observation = `None`,
		async = `None`
	)

Displays statistical information from a measurement set, or from a measurement set selection

This task returns statistical information about data in a measurement
set.

The following values are computed: mean value, sum of values,
sum of squared values, median, median absolute deviation, quartile,
minimum, maximum, variance, standard deviation, and root mean square.

The following axes are supported: uvw, flag, weight, sigma, antenna1,
antenna2, feed1, feed2, field_id, array_id, data_desc_id, flag_row,
interval, scan, scan_number, time, weight_spectrum, amp, amplitude,
phase, real, imag, imaginary, and uvrange.

Optionally, the statistical information can be computed based only
on a given subset of the measurement set.

Note: If the MS consists of inhomogeneous data, for example several
spectral windows each having a different number of channels, it may be
necessary to use selection parameters to select a homogeneous subset of
the MS, e.g. spw='2'.

Keyword arguments:

vis  --- Name of input visibility file
  default: '', example: vis='my.ms'

axis -- Which data to analyze.

default: 'amplitude'
axis='phase'
axis='imag'
axis='scan_number'
axis='flag'

The phase of a complex number is in radians in the range [-pi; pi[.


datacolumn -- Which data column to use for complex data.
default: 'data'
datacolumn='data'
datacolumn='corrected'
datacolumn='model'

useflags -- Take MS flags into account?
default: True
useflag=False
useflag=True
If useflags=False, flagged values are included in the statistics.
If useflags=True, any flagged values are not used in the statistics.

spw -- Select data based on spectral window and channels
default: '' (all); example: spw='1'
spw='<2' #spectral windows less than 2
spw='>1' #spectral windows greater than 1
spw='0:0~10' # first 10 channels from spw 0
spw='0:0~5;56~60' # multiple separated channel chunks.

field -- Select data based on field id(s) or name(s)
default: '' (all); example: field='1'
field='0~2' # field ids inclusive from 0 to 2
field='3C*' # all field names starting with 3C

selectdata -- Other data selection parameters
default: True
antenna -- Select data based on baseline
default: '' (all); example: antenna='5&6' baseline 5-6
antenna='5&6;7&8' #baseline 5-6 and 7-8
antenna='5' # all baselines with antenna 5
antenna='5,6' # all baselines with antennas 5 and 6
correlation -- Correlation types
default: '' (all);
example: correlation='RR LL'
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
timerange  -- Select data based on time range:
default = '' (all); example,
timerange = 'YYYY/MM/DD/hh:mm:ss~YYYY/MM/DD/hh:mm:ss'
Note: YYYY/MM/DD can be dropped as needed:
timerange='09:14:0~09:54:0' # this time range
timerange='09:44:00' # data within one integration of time
timerange='>10:24:00' # data after this time
timerange='09:44:00+00:13:00' #data 13 minutes after time
scan -- Select data based on scan number
default: '' (all); example: scan='>3'
array -- Selection based on the antenna array
observation -- Selection by observation ID(s).
       default: '' (all); example: observation='1~3'

Definition at line 46 of file visstat_cli.py.

def visstat_cli.visstat_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 359 of file visstat_cli.py.

def visstat_cli.visstat_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 297 of file visstat_cli.py.

def visstat_cli.visstat_cli_.description	(	self,
		key = `'visstat'`,
		subkey = `None`
	)

Definition at line 390 of file visstat_cli.py.

def visstat_cli.visstat_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 417 of file visstat_cli.py.

Referenced by wvrgcal_cli.wvrgcal_cli_.defaults(), visstat_cli.visstat_cli_.defaults(), widebandpbcor_cli.widebandpbcor_cli_.defaults(), and widefield_cli.widefield_cli_.defaults().

def visstat_cli.visstat_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 273 of file visstat_cli.py.

def visstat_cli.visstat_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file visstat_cli.py.

Member Data Documentation

dictionary visstat_cli.visstat_cli_.__async__ [static, private]

Definition at line 20 of file visstat_cli.py.

Referenced by visstat_cli.visstat_cli_.result(), wvrgcal_cli.wvrgcal_cli_.result(), widefield_cli.widefield_cli_.result(), and widebandpbcor_cli.widebandpbcor_cli_.result().

visstat_cli.visstat_cli_.__bases__ [private]

Definition at line 27 of file visstat_cli.py.

visstat_cli.visstat_cli_.__doc__ [private]

Definition at line 28 of file visstat_cli.py.

visstat_cli.visstat_cli_.__globals__ [private]

Definition at line 142 of file visstat_cli.py.

Referenced by wvrgcal_cli.wvrgcal_cli_.check_params(), visstat_cli.visstat_cli_.check_params(), widebandpbcor_cli.widebandpbcor_cli_.check_params(), widefield_cli.widefield_cli_.check_params(), wvrgcal_cli.wvrgcal_cli_.defaults(), visstat_cli.visstat_cli_.defaults(), widebandpbcor_cli.widebandpbcor_cli_.defaults(), widefield_cli.widefield_cli_.defaults(), wvrgcal_cli.wvrgcal_cli_.paramgui(), visstat_cli.visstat_cli_.paramgui(), widebandpbcor_cli.widebandpbcor_cli_.paramgui(), and widefield_cli.widefield_cli_.paramgui().

string visstat_cli.visstat_cli_.__name__ [static, private]

Definition at line 19 of file visstat_cli.py.

visstat_cli.visstat_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file visstat_cli.py.

visstat_cli.visstat_cli_.parameters

Definition at line 30 of file visstat_cli.py.

Referenced by wvrgcal_cli.wvrgcal_cli_.itsdefault(), widebandpbcor_cli.widebandpbcor_cli_.itsdefault(), visstat_cli.visstat_cli_.itsdefault(), and widefield_cli.widefield_cli_.itsdefault().

tuple visstat_cli.visstat_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 338 of file visstat_cli.py.

tuple visstat_cli.visstat_cli_.retval [static]

Definition at line 351 of file visstat_cli.py.

visstat_cli.visstat_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file visstat_cli.py.

string visstat_cli.visstat_cli_.valornotval [static]

Definition at line 341 of file visstat_cli.py.

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

visstat_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