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

Constructor & Destructor Documentation

def imview_cli.imview_cli_.__init__ ( self )

Definition at line 26 of file imview_cli.py.

Member Function Documentation

def imview_cli.imview_cli_.__call__	(	self,
		raster = `None`,
		contour = `None`,
		zoom = `None`,
		axes = `None`,
		out = `None`,
		async = `None`
	)

View an image
The imview task provides access to a subset of all of the configuration
options for loading and configuring the display of images in the casaviewer.
This interface will evolve and eventually provide access to nearly all of 
the image options available in the casaviewer.

To simply create a casaviewer to set up interactively, you can use:

    imview

To open a particular image:

    imview "ngc5921.clean.image"

to open an image and overlay a contour:

    imview "ngc5921.clean.image", "ngc5921.clean.image"

or equivalently:

    imview( raster="ngc5921.clean.image", contour="ngc5921.clean.image" )

to output an image:

    imview( raster="ngc5921.clean.image", out="ngc5921-01.png" )    
    

There are five optional parameters for imview -- raster, contour, zoom,
axes, and out. Each of these parameters can take a few different forms and 
are treated as python dictionaries:

raster  -- (string) image file to open
   (dict)   file (string)     => image file to open
            scaling (float)   => scaling power cycles
            range (float*2)   => data range
            colormap (string) => name of colormap
            colorwedge (bool) => show color wedge?
contour -- (string) file to load as a contour
   (dict)   file (string)     => file to load
            levels (float*N)  => relative levels
            base (numeric)    => zero in relative levels
            unit (numeric)    => one in the relative levels
zoom    -- (int)    integral zoom level
   (string) region file to load as the zoom region
   (dict)   blc (numeric*2)   => bottom left corner
            trc (numeric*2)   => top right corner
            coord (string)    => pixel or world
            channel (int)     => chanel to display
   (dict)   <region record>   => record loaded
                                 e.g. rg.fromfiletorecord( )
axes    -- (string*3) demension to display on the x, y, and z axes
   (dict)     x               => dimension for x-axes
              y               => dimension for y-axes
              z               => dimension for z-axes
out     -- (string) file with a supported extension
            [jpg, pdf, eps, ps, png, xbm, xpm, ppm]
    (dict)    file (string)   => filename
              format (string) => valid ext (filename ext overrides)
              scale (numeric) => scale for non-eps, non-ps output
              dpi (numeric)   => dpi for eps or ps output
              orient (string) => portrait or landscape

Examples: 

1)  A subset (zoom) of a raster image. Note the notation of curly brackets:

    imview(raster="ngc5921.clean.image", out="ngc5921-02.png",
   zoom={'channel': 10, 'blc': [113,109], 'trc': [141,136]} )


2) An overlay of a raster image, ngc5921.clean.image, with a
contour map of the same image ngc5921.clean.image. Data ranges
are selected, as well as the colormap and the scaling cycles
of the raster image. Contours are autogenerated and The x-axis
will be Declination. The image is written out to a file named 
myout.png in the png format.

imview(raster={'file': 'ngc5921.clean.image',
       'range': [-0.01,0.03],
       'colormap': 'Hot Metal 2',
       'scaling': -1},
       contour={'file': 'ngc5921.clean.image'},
       axes={'x':'Declination'} ,
       zoom={'channel': 7, 'blc': [75,75], 'trc': [175,175],
     'coord': 'pixel'},
       out='myout.png')

3) As example (2) but with an integral zoom level and no output to a file

imview(raster={'file': 'ngc5921.clean.image', 
       'range': [-0.01,0.03], 
       'colormap': 'Hot Metal 2'}, 
       contour={'file': 'ngc5921.clean.image'}, 
       axes={'x':'Declination'} , 
       zoom=2)

4) Now, the contour levels are explicitely given, a region file is used
to define the zoom area

imview(raster={'file': 'ngc5921.clean.image',
       'range': [-0.01,0.03],
       'colormap': 'Hot Metal 2'},
       contour={'file': 'ngc5921.clean.image',
        'levels': [-0.2, 0.2, 0.25, 0.3, 0.35, 0.4, 0.6, 0.8] },
       zoom='myregion.rgn')

specifying "zoom={'file': 'myregion.rgn', 'channel': 10}" would result
in the same level of zoom and would display channel number 10 from
the cube.

Definition at line 46 of file imview_cli.py.

def imview_cli.imview_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 353 of file imview_cli.py.

def imview_cli.imview_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 302 of file imview_cli.py.

def imview_cli.imview_cli_.description	(	self,
		key = `'imview'`,
		subkey = `None`
	)

Definition at line 384 of file imview_cli.py.

def imview_cli.imview_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 402 of file imview_cli.py.

Referenced by rmtables_cli.rmtables_cli_.defaults(), listfits_cli.listfits_cli_.defaults(), listhistory_cli.listhistory_cli_.defaults(), uvsub_cli.uvsub_cli_.defaults(), uvcontsub2_cli.uvcontsub2_cli_.defaults(), plotweather_cli.plotweather_cli_.defaults(), plotants_cli.plotants_cli_.defaults(), smoothcal_cli.smoothcal_cli_.defaults(), listsdm_cli.listsdm_cli_.defaults(), tclean_cli.tclean_cli_.defaults(), splattotable_cli.splattotable_cli_.defaults(), sdflagmanager_cli.sdflagmanager_cli_.defaults(), testconcat_cli.testconcat_cli_.defaults(), sdlist_cli.sdlist_cli_.defaults(), msview_cli.msview_cli_.defaults(), viewer_cli.viewer_cli_.defaults(), listpartition_cli.listpartition_cli_.defaults(), sdscale_cli.sdscale_cli_.defaults(), msmoments_cli.msmoments_cli_.defaults(), slsearch_cli.slsearch_cli_.defaults(), peel_cli.peel_cli_.defaults(), predictcomp_cli.predictcomp_cli_.defaults(), wvrgcal_cli.wvrgcal_cli_.defaults(), uvcontsub_cli.uvcontsub_cli_.defaults(), ssoflux_cli.ssoflux_cli_.defaults(), vishead_cli.vishead_cli_.defaults(), uvcontsub3_cli.uvcontsub3_cli_.defaults(), sdimprocess_cli.sdimprocess_cli_.defaults(), virtualconcat_cli.virtualconcat_cli_.defaults(), listobs_cli.listobs_cli_.defaults(), sdsmooth_cli.sdsmooth_cli_.defaults(), visstat_cli.visstat_cli_.defaults(), imview_cli.imview_cli_.defaults(), widebandpbcor_cli.widebandpbcor_cli_.defaults(), sdcoadd_cli.sdcoadd_cli_.defaults(), uvmodelfit_cli.uvmodelfit_cli_.defaults(), listvis_cli.listvis_cli_.defaults(), sdsave_cli.sdsave_cli_.defaults(), simanalyze_cli.simanalyze_cli_.defaults(), sdmath_cli.sdmath_cli_.defaults(), listcal_cli.listcal_cli_.defaults(), sdgrid_cli.sdgrid_cli_.defaults(), sdtpimaging_cli.sdtpimaging_cli_.defaults(), sdstat_cli.sdstat_cli_.defaults(), makemask_cli.makemask_cli_.defaults(), split_cli.split_cli_.defaults(), sdimaging_cli.sdimaging_cli_.defaults(), statwt_cli.statwt_cli_.defaults(), sdflag_cli.sdflag_cli_.defaults(), partition_cli.partition_cli_.defaults(), simalma_cli.simalma_cli_.defaults(), sdfit_cli.sdfit_cli_.defaults(), sdcal_cli.sdcal_cli_.defaults(), simobserve_cli.simobserve_cli_.defaults(), polcal_cli.polcal_cli_.defaults(), sdbaseline_cli.sdbaseline_cli_.defaults(), setjy_cli.setjy_cli_.defaults(), mosaic_cli.mosaic_cli_.defaults(), widefield_cli.widefield_cli_.defaults(), pclean_cli.pclean_cli_.defaults(), plotxy_cli.plotxy_cli_.defaults(), specfit_cli.specfit_cli_.defaults(), plotms_cli.plotms_cli_.defaults(), and sdreduce_cli.sdreduce_cli_.defaults().

def imview_cli.imview_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 278 of file imview_cli.py.

def imview_cli.imview_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file imview_cli.py.

Member Data Documentation

dictionary imview_cli.imview_cli_.__async__ [static, private]

Definition at line 20 of file imview_cli.py.

Referenced by imview_cli.imview_cli_.result(), wvrgcal_cli.wvrgcal_cli_.result(), widefield_cli.widefield_cli_.result(), widebandpbcor_cli.widebandpbcor_cli_.result(), visstat_cli.visstat_cli_.result(), vishead_cli.vishead_cli_.result(), virtualconcat_cli.virtualconcat_cli_.result(), viewer_cli.viewer_cli_.result(), uvsub_cli.uvsub_cli_.result(), uvmodelfit_cli.uvmodelfit_cli_.result(), uvcontsub_cli.uvcontsub_cli_.result(), uvcontsub3_cli.uvcontsub3_cli_.result(), uvcontsub2_cli.uvcontsub2_cli_.result(), testconcat_cli.testconcat_cli_.result(), tclean_cli.tclean_cli_.result(), statwt_cli.statwt_cli_.result(), ssoflux_cli.ssoflux_cli_.result(), split_cli.split_cli_.result(), splattotable_cli.splattotable_cli_.result(), specfit_cli.specfit_cli_.result(), smoothcal_cli.smoothcal_cli_.result(), slsearch_cli.slsearch_cli_.result(), simobserve_cli.simobserve_cli_.result(), simanalyze_cli.simanalyze_cli_.result(), simalma_cli.simalma_cli_.result(), setjy_cli.setjy_cli_.result(), sdtpimaging_cli.sdtpimaging_cli_.result(), sdstat_cli.sdstat_cli_.result(), sdsmooth_cli.sdsmooth_cli_.result(), sdscale_cli.sdscale_cli_.result(), sdsave_cli.sdsave_cli_.result(), sdreduce_cli.sdreduce_cli_.result(), sdplot_cli.sdplot_cli_.result(), sdmath_cli.sdmath_cli_.result(), sdlist_cli.sdlist_cli_.result(), sdimprocess_cli.sdimprocess_cli_.result(), sdimaging_cli.sdimaging_cli_.result(), sdgrid_cli.sdgrid_cli_.result(), sdflagmanager_cli.sdflagmanager_cli_.result(), sdflag_cli.sdflag_cli_.result(), sdfit_cli.sdfit_cli_.result(), sdcoadd_cli.sdcoadd_cli_.result(), sdcal_cli.sdcal_cli_.result(), sdbaseline_cli.sdbaseline_cli_.result(), rmtables_cli.rmtables_cli_.result(), predictcomp_cli.predictcomp_cli_.result(), polcal_cli.polcal_cli_.result(), plotxy_cli.plotxy_cli_.result(), plotweather_cli.plotweather_cli_.result(), plotuv_cli.plotuv_cli_.result(), plotms_cli.plotms_cli_.result(), plotcal_cli.plotcal_cli_.result(), plotants_cli.plotants_cli_.result(), peel_cli.peel_cli_.result(), pclean_cli.pclean_cli_.result(), partition_cli.partition_cli_.result(), msview_cli.msview_cli_.result(), msmoments_cli.msmoments_cli_.result(), mosaic_cli.mosaic_cli_.result(), makemask_cli.makemask_cli_.result(), listvis_cli.listvis_cli_.result(), listsdm_cli.listsdm_cli_.result(), listpartition_cli.listpartition_cli_.result(), listobs_cli.listobs_cli_.result(), listhistory_cli.listhistory_cli_.result(), listfits_cli.listfits_cli_.result(), and listcal_cli.listcal_cli_.result().

imview_cli.imview_cli_.__bases__ [private]

Definition at line 27 of file imview_cli.py.

imview_cli.imview_cli_.__doc__ [private]

Definition at line 28 of file imview_cli.py.

imview_cli.imview_cli_.__globals__ [private]

Definition at line 161 of file imview_cli.py.

string imview_cli.imview_cli_.__name__ [static, private]

Definition at line 19 of file imview_cli.py.

imview_cli.imview_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file imview_cli.py.

imview_cli.imview_cli_.parameters

Definition at line 30 of file imview_cli.py.

tuple imview_cli.imview_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 332 of file imview_cli.py.

tuple imview_cli.imview_cli_.retval [static]

Definition at line 345 of file imview_cli.py.

imview_cli.imview_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file imview_cli.py.

string imview_cli.imview_cli_.valornotval [static]

Definition at line 335 of file imview_cli.py.

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

imview_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