task_viewer.__viewer_class Class Reference

List of all members.

Public Member Functions
def	__init__
def	__call__
	(1) save current viewer*server path (2) have viewer() task follow casapy/python's cwd
Public Attributes
	local_vi
	vi might not be defined in taskinit if loading directly from python via casa.py...
	local_ving

---

Detailed Description

Definition at line 10 of file task_viewer.py.

---

Constructor & Destructor Documentation

def task_viewer.__viewer_class.__init__

(

self

)

Definition at line 13 of file task_viewer.py.

---

Member Function Documentation

def task_viewer.__viewer_class.__call__	(		self,
			infile = None,
			displaytype = None,
			channel = None,
			zoom = None,
			outfile = None,
			outscale = None,
			outdpi = None,
			outformat = None,
			outlandscape = None,
			gui = None
	)

(1) save current viewer*server path (2) have viewer() task follow casapy/python's cwd

The viewer will display images in raster, contour, vector or
marker form.  Images can be blinked, and movies are available
for spectral-line image cubes.  For measurement sets, many
display and editing options are available.

examples of usage:

viewer
viewer "myimage.im"
viewer "mymeasurementset.ms"
viewer "myrestorefile.rstr"

viewer "myimage.im", "contour"

viewer "'myimage1.im' - 2 * 'myimage2.im'", "lel"
        
The viewer can be run outside of casapy by typing <casaviewer>.

Executing viewer <viewer> will bring up a display panel
window, which can be resized.  If no data file was specified,
a Load Data window will also appear.  Click on the desired data
file and choose the display type; the rendered data should appear
on the display panel.

A Data Display Options window will also appear.  It has drop-down
subsections for related options, most of which are self-explanatory.
          
The state of the viewer -- loaded data and related display
options -- can be saved in a 'restore' file for later use.
You can provide the restore filename on the command line or
select it from the Load Data window.

See the cookbook for more details on using the viewer.
        
Keyword arguments:
infile -- Name of file to visualize
        default: ''
        example: infile='ngc5921.image'
        If no infile is specified the Load Data window
        will appear for selecting data.
displaytype -- (optional): method of rendering data
        visually (raster, contour, vector or marker).  
        You can also set this parameter to 'lel' and
        provide an lel expression for infile (advanced).
        default: 'raster'
        example: displaytype='contour'

Note: there is no longer a filetype parameter; typing of
data files is now done automatically.
        example:  viewer infile='my.ms'
        obsolete: viewer infile='my.ms', filetype='ms'

Definition at line 17 of file task_viewer.py.

References task_imview.__imview_class.local_vi, task_msview.__msview_class.local_vi, task_viewer.__viewer_class.local_vi, task_imview.__imview_class.local_ving, task_msview.__msview_class.local_ving, and task_viewer.__viewer_class.local_ving.

---

Member Data Documentation

task_viewer.__viewer_class.local_vi

vi might not be defined in taskinit if loading directly from python via casa.py...

Definition at line 14 of file task_viewer.py.

Referenced by task_viewer.__viewer_class.__call__().

task_viewer.__viewer_class.local_ving

Definition at line 15 of file task_viewer.py.

Referenced by task_viewer.__viewer_class.__call__().

---

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

• task_viewer.py