NRAO Home > CASA > CASA Toolkit Reference Manual
agentflagger.parseclipparameters - Function

2.2.1 Parse data selection parameters and specific parameters for the clip mode. Data selection follows the MS Selection syntax.
Arguments





Inputs

field

Field indices or source names. Example: ’2,3C48’

allowed:

string

Default:

spw

Spectral Window Indices or names. Example: ’1,2’

allowed:

string

Default:

array

Array Indices or names. Example: ’VLAA’

allowed:

string

Default:

feed

Feed index or name. Eexample: ’1,2’ (not supported yet)

allowed:

string

Default:

scan

Scan number. Example: ’1,2,3’

allowed:

string

Default:

antenna

Baseline number. Example: ’2,3,4,5’

allowed:

string

Default:

uvrange

UV-distance range, with a unit. Example: ’2.0-3000.0 m’

allowed:

string

Default:

time

Time range, as MJDs or date strings. Example: ’xx.x.x.x.x~yy.y.y.y.y’

allowed:

string

Default:

correlation

Correlations/polarizations. Example: ’RR,LL,RL,LR,XX,YY,XY,YX’

allowed:

string

Default:

intent

Scan intent. Example: ’*CAL*, *BAND*’

allowed:

string

Default:

observation

Observation Id. Example: ’2~4’

allowed:

string

Default:

datacolumn

Data column to use for clipping. Supported columns for cal tables are FPARAM,CPARAM,SNR. Example: ’DATA’. Default:

allowed:

string

Default:

DATA

clipminmax

Range to use for clipping. Example: [100.0,200.0]

allowed:

doubleArray

Default:

clipoutside

Clip points outside this range? [True/False]. Default:

allowed:

bool

Default:

true

channelavg

Average data over channels before clipping? [True/False]. Default:

allowed:

bool

Default:

false

chanbin

Width (bin) of input channels to average to form an output channel.

allowed:

variant

Default:

variant 1

timeavg

Average data over time ranges. [True/False]. Default:

allowed:

bool

Default:

false

timebin

Bin width for time average. Example: ’2s’

allowed:

string

Default:

clipzeros

Clip zero-value data. [True/False]. Default:

allowed:

bool

Default:

false

apply

Parameter to flag or unflag data. Default:

allowed:

bool

Default:

true

Returns
bool

Example

 
The correlation parameter can be used with an operator for the clip mode.  
The operator should be written only once and it will affect all the polarizations  
given in the string. See the example below:  
 
af.parseclipparameters(clipzeros=True, clipminmax=[0.,4.], correlation=’ABS_XX,XY’)  
 
or for a calibration table:  
af.parseclipparameters(clipzeros=True, clipminmax=[0.,4.], correlation=’Sol1’)  
 

__________________________________________________________________


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