nraonrao
 
NRAO Home > CASA > TaskRef

0.1.49 plotms

Requires:

Synopsis A plotter/interactive flagger for visibility data. Description

Task for plotting and interacting with visibility data. A variety of axes choices (including data column) along with MS selection and averaging options are provided for data selection. Flag extension parameters are also available for flagging operations in the plotter.

All of the provided parameters can also be set using the GUI once the application has been launched. Additional and more specific operations are available through the GUI and/or through the plotms tool (pm).

Arguments





Inputs

vis

input visibility dataset (blank for none)

allowed:

string

Default:

xaxis

plot x-axis (blank for default/current)

allowed:

string

Default:

xdatacolumn

data column to use for x-axis (blank for default/current)

allowed:

string

Default:

yaxis

plot y-axis (blank for default/current)

allowed:

string

Default:

ydatacolumn

data column to use for y-axis (blank for default/current)

allowed:

string

Default:

selectdata

data selection parameters

allowed:

bool

Default:

True

field

field names or field index numbers (blank for all)

allowed:

string

Default:

spw

spectral windows:channels (blank for all)

allowed:

string

Default:

timerange

time range (blank for all)

allowed:

string

Default:

uvrange

uv range (blank for all)

allowed:

string

Default:

antenna

antenna/baselines (blank for all)

allowed:

string

Default:

scan

scan numbers (blank for all)

allowed:

string

Default:

correlation

correlations (blank for all)

allowed:

string

Default:

array

(sub)array numbers (blank for all)

allowed:

string

Default:

msselect

MS selection (blank for all)

allowed:

string

Default:

averagedata

data averaging parameters

allowed:

bool

Default:

True

avgchannel

average over channel? (blank = False, otherwise value in channels)

allowed:

string

Default:

avgtime

average over time? (blank = False, other value in seconds)

allowed:

string

Default:

avgscan

only valid if time averaging is turned on. average over scans?

allowed:

bool

Default:

False

avgfield

only valid if time averaging is turned on. average over fields?

allowed:

bool

Default:

False

avgbaseline

average over all baselines? (mutually exclusive with avgantenna)

allowed:

bool

Default:

False

avgantenna

average by per-antenna? (mutually exclusive with avgbaseline)

allowed:

bool

Default:

False

avgspw

average over all spectral windows?

allowed:

bool

Default:

False

extendflag

have flagging extend to other data points?

allowed:

bool

Default:

False

extcorrelation

extend flags based on correlation? (blank = none)

allowed:

string

Default:

extchannel

extend flags based on channel?

allowed:

bool

Default:

False

extspw

extend flags based on spw?

allowed:

bool

Default:

False

extantenna

extend flags based on antenna? (blank = none, ’all’ = all baselines, otherwise antenna-based value)

allowed:

string

Default:

exttime

extend flags based on time (within scans)?

allowed:

bool

Default:

False

extscans

only valid if exttime is true. extend flags based on scans?

allowed:

bool

Default:

False

extfield

only valid if exttime is true. extend flags based on field?

allowed:

bool

Default:

False

plotxycomp

use plotxy compliance parameters?

allowed:

bool

Default:

False

datacolumn

PLOTXY COMPLIANCE PARAMETER; use xdatacolumn and ydatacolumn instead

allowed:

string

Default:

data

timebin

PLOTXY COMPLIANCE PARAMETER; use avgtime instead

allowed:

string

Default:

0

crossscans

PLOTXY COMPLIANCE PARAMETER; use avgscan instead

allowed:

bool

Default:

False

crossbls

PLOTXY COMPLIANCE PARAMETER; use avgbaseline instead

allowed:

bool

Default:

False

width

PLOTXY COMPLIANCE PARAMETER; use avgchannel or avgspw instead

allowed:

string

Default:

1

extendcorr

PLOTXY COMPLIANCE PARAMETER; use extcorrelation instead

allowed:

string

Default:

extendchan

PLOYXY COMPLIANCE PARAMETER; use extchanngel instead

allowed:

string

Default:

extendspw

PLOTXY COMPLIANCE PARAMETER; use extspw instead

allowed:

string

Default:

extendant

PLOTXY COMPLIANCE PARAMETER; use extantenna instead

allowed:

string

Default:

extendtime

PLOTXY COMPLIANCE PARAMETER; use exttime, extscans, and extfield instead

allowed:

string

Default:

Returns
void

Example

 
 
            Task for plotting and interacting with visibility data.  A variety  
        of axes choices (including data column) along with MS selection and  
        averaging options are provided for data selection.  Flag extension  
        parameters are also available for flagging operations in the plotter.  
 
            All of the provided parameters can also be set using the GUI once  
        the application has been launched.  Additional and more specific  
        operations are available through the GUI and/or through the plotms  
        tool (pm).  
 
 
    Keyword arguments:  
    vis -- input visibility dataset  
           default: ’’  
    xaxis, yaxis -- what to plot on the two axes  
                    default: ’’ (uses PlotMS defaults/current set).  
      >>> xaxis, yaxis expandable parameters  
        xdatacolumn, ydatacolumn -- which data column to use for data axes  
                                    default: ’’ (uses PlotMS default/current  
                                    set).  
 
    selectdata -- data selection parameters flag  
                  (see help par.selectdata for more detailed information)  
                  default: False  
      >>> selectdata expandable parameters  
        field -- select using field ID(s) or field name(s)  
                 default: ’’ (all).  
        spw -- select using spectral window/channels  
               default: ’’ (all)  
        timerange -- select using time range  
                     default: ’’ (all).  
        uvrange -- select using uvrange  
                   default: ’’ (all).  
        antenna -- select using antenna/baseline  
                   default: ’’ (all).  
        scan -- select using scan number  
                default: ’’ (all).  
        correlation -- select using correlations  
                       default: ’’ (all).  
        array -- select using (sub)-array range  
                 default: ’’ (all).  
        msselect -- TaQL selection expression  
                    default: ’’ (all).  
 
    averagedata -- data averaing parameters flag  
                   default: False.  
      >>> averagedata expandable parameters  
        avgchannel -- average over channel?  either blank for none, or a value  
                      in channels.  
                      default: ’’ (none).  
        avgtime -- average over time?  either blank for none, or a value in  
                   seconds.  
                   default: ’’ (none).  
        avgscan -- average over scans?  only valid if time averaging is turned  
                   on.  
                   default: False.  
        avgfield -- average over fields?  only valid if time averaging is  
                    turned on.  
                    default: False.  
        avgbaseline -- average over all baselines?  mutually exclusive with  
                       avgantenna.  
                       default: False.  
        avgantenna -- average by per-antenna?  mutually exclusive with  
                      avgbaseline.  
                      default: False.  
        avgspw -- average over all spectral windows?  
                  default: False.  
 
    extendflag -- have flagging extend to other data points?  
                  default: False.  
      >>> extendflag expandable parameters  
        extcorrelation -- extend flags based on correlation?  blank = none.  
                          default: ’’.  
        extchannel -- extend flags based on channel?  
                      default: False.  
        extspw -- extend flags based on spw?  
                  default: False.  
        extantenna -- extend flags based on antenna?  should be either blank,  
                      ’all’ for all baselines, or an antenna-based value.  
                      default: ’’.  
        exttime -- extend flags based on time (within scans)?  
                   default: False.  
        extscans -- extend flags based on scans?  only valid if time extension  
                    is turned on.  
                    default: False.  
        extfield -- extend flags based on field?  only valid if time extension  
                    is turned on.  
                    default: False.  
 
    plotxycomp -- use plotxy compliance parameters?  WARNING: if used,  
                  subparameters will override their corresponding plotms  
                  parameter values.  
                  default: False.  
      >>> plotxycomp expandable parameters  
        datacolumn -- maps to xdatacolumn and ydatacolumn.  
                      default: ’data’.  
        timebin -- maps to avgtime.  
                   default: ’0’.  
        crossscans -- maps to avgscan.  
                      default: False.  
        crossbls -- maps to avgbaseline.  
                    default: False.  
        width -- maps to avgchannel and/or avgspw.  ’all’ is ignored, ’allspw’  
                 sets avgspw to true, any other value is set for avgchannel.  
                 default: ’1’.  
        extendcorr -- maps to extcorrelation.  ’half’ is mapped to ’poln-dep’.  
                      default: ’’.  
        extendchan -- maps to extchannel.  ’’ means False, ’all’ means True.  
                      default: ’’.  
        extendspw -- maps to extspw.  ’’ means False, ’all’ means True.  
                     default: ’’.  
        extendant -- maps to extantenna.  ’’ means False, ’all’ means True.  
                     default: ’’.  
        extendtime -- maps to exttime and/or extscans and/or extfield.  ’’  
                      means False for all, ’all’ means True for exttime, ’scan’  
                      means True for exttime and extscans, ’field’ means True  
                      for exttime and extfield.  
                      default: ’’.  
 

Please send any comments or questions about CASA or AIPS++ to aips2-requests@nrao.edu

Copyright © 2008 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

Updated daily during alpha development.