5.1.1.0 sd.list_rcparameters

NRAO Home > CASA > CASA Toolkit Reference Manual

sd.list_rcparameters - Function

5.1.1 Print a list of rc parameters
Description

Print a list of rc parameters and its default values that determine basic behavior of the tool. The user can be accessed rc parameters directory since the rc parameters are available as a Python dictionary sd.rcParams. There is also a method to set rc parameters called rc. Contents of the rc paramters are described below.

verbose
It will disable exceptions and just print the messages (only valid in standalone mode)
useplotter
Preload a default plotter
insitu
Apply operations on the input scantable or retuern new one
plotter.gui
Do we want a GUI or plot to a file
plotter.stacking
Default mode for color stacking
plotter.panelling
Default mode for panelling
plotter.ganged
Push panels together, to share axis labels
plotter.decimate
Decimate the number of points plotted by a factor of nchan/1024
plotter.colours
Default color
plotter.linestyles
Default linestyles
plotter.histogram
Enable/disable histogram plotting
plotter.papertype
Postscript paper type
plotter.axesformatting
The formatting style of the x-axis
scantable.storage
Default storage of scantable (’memory’/’disk’)
scantable.history
Write history of each call to scantable
scantable.save
Default output format when saving
scantable.autoaverage
Auto averaging on read
scantable.freqframe
Default frequency frame to set when function set_freqframe is called
scantable.verbosesummary
Control the level of information printed by summary
scantable.reference
Control the identification of reference (off) scans (has to be regular expression)
scantable.parallactify
Indicate whether the data was parallactified (total phase offset is 0.0)

Arguments

Returns
string

Example

   sd.list_rcparameters()
   # output will be as follows
   # general
   # only valid in asap standard mode not in scripts or casapy
   # It will disable exceptions and just print the messages
   verbose                    : True

   # preload a default plotter
   useplotter                 : True

   # apply operations on the input scantable or return new one
   insitu                     : True

   # plotting

   # do we want a GUI or plot to a file
   plotter.gui                : True

   # default mode for colour stacking
   plotter.stacking           : Pol

   # default mode for panelling
   plotter.panelling          : scan

   # push panels together, to share axis labels
   plotter.ganged             : True

   ...

[next] [prev] [prev-tail] [front] [up]

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

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