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

Constructor & Destructor Documentation

def imsmooth_cli.imsmooth_cli_.__init__ ( self )

Definition at line 26 of file imsmooth_cli.py.

Member Function Documentation

def imsmooth_cli.imsmooth_cli_.__call__	(	self,
		imagename = `None`,
		kernel = `None`,
		major = `None`,
		minor = `None`,
		pa = `None`,
		targetres = `None`,
		region = `None`,
		box = `None`,
		chans = `None`,
		stokes = `None`,
		mask = `None`,
		outfile = `None`,
		stretch = `None`,
		overwrite = `None`,
		beam = `None`,
		async = `None`
	)

Smooth an image or portion of an image
This task performs a Fourier-based convolution to 'smooth' the
image. Smoothing is typically performed in order to reduce the noise in
an image.

Keyword arguments:
imagename -- Input image name
Default: none; Example: imagename='ngc5921_task.im'
outfile -- Output smoothed image file name
default: 'imsmooth_results.im'; 
example: outfile='my.image.smooth';
    kernel -- Type of kernel to use when smoothing (gaussian or boxcar).
default: 'gauss'; example: kernel='gauss'
options: 'gauss' or 'boxcar' 
    major -- Depends on the kernel type, see explanation below.
    minor -- Depends on the kernel type, see explanation below.       
    pa    -- position angle to use for gaussian kernel, unused for boxcar.
    beam  -- When kernel="gauss", this parameter can be used instead of major,
     minor, and pa to specify the gaussian parameters. See details below.
    targetres -- Used only for gaussian kernels. If True, major, minor, and
     pa, or beam, are the resolution of the output image. If false, a gaussian
     with these parameters is convolved with the input image to produce
     the output image.
    mask --  Mask to use. See help par.mask. Default is none.
    region -- region file or name.
      Use the viewer, then region manager to select regions of
      the image to process.  Similar to box, but graphical
      Or the name of a region stored with the image, 
      use rg.namesintable()
      to retrieve the list of names.
      Default: none
      Example: region='myimage.im.rgn'
         region='region1'
box --  A box region on the directional plane
ONLY pixel values acceptable at this time.
Default: none (whole 2-D plane); Example: box='10,10,50,50'
chans -- channel numbers to select for the continuum,
ONLY channel numbers accepted at this time.
Default: none (all); 
  Example: chans='3~6;>40'
stokes -- Stokes parameters to image
Example: 'I'
Default: none (all);
Options: 'I','Q','U','V','RR','RL','LR','LL','XX','YX','XY','YY', ... 

Kernel Parameters
-----------------
Finally, and most importantly the kernel is specified via the
major and minor parameters. 

Gaussian kernel: major and minor are the full width at half maximum 
 (FWHM) of the Gaussian. pa is the position angle
 of the gaussian. In addition, the targetres parameter
 indicates if the specified gaussian is to be the
 resolution of the final image (True) or if it is to
 be used to convolve the input image to create the
 output image. If True, the input image must have
 a restoring beam in its header.
 If the image has multiple beams and targetres=True,
 all planes in the image will be convolved so that the
 resulting resolution is that specified by the beam parameter.
 If the image has multiple beams and targetres=False, each plane
 will be convolved with a Gaussian specified by beam (and hence, in
 general, the output image will also have multiple beams that vary
 with spectral channel and/or polarization).
Boxcar kernel:   major, length of the box along the y-axis and
 minor, length of the box along the x-axis

The major, minor, and pa parameters can be specified in one of three ways
   Quantity -- for example major=qa.quantity(1, 'arcsec')
       Note that you can use pixel units, such as 
       major=qa.quantity(1, 'pix')
   String -- for example minor='1pix' or major='0.5km'
     (i.e. a string that the Quanta quantity function accepts).
   Numeric -- for example major=10.
      In this case, the units of major and minor are assumed to 
      be in arcsec and units of pa are assumed to be degrees. 

In the case of a Gaussian, the beam parameter offers an alternate way of
describing the convolving Gaussian. If used, neither major, minor,
nor pa can be specified. The beam parameter must have exactly three
fields: "major", "minor", and "pa" (or "positionangle"). This is, not coincidentally,
the record format for the output of ia.restoringbeam(). For example

beam = {"major": "5arcsec", "minor": "2arcsec", "pa": "20deg"}

If both beam and any of major, minor, and/or pa is specified for a Gaussian kernel,
an exception will be thrown.

Note: Using pixel units allows you to convolve axes with different units.

# EXAMPLE 1
# smoothing with a gaussian kernel 20arseconds by 10 arseconds
imsmooth( imagename='my.image', kernel='gauss', major='10arcsec', minor='10arcsec')

# EXAMPLE 2
# Smoothing using pixel coordinates and a boxcar kernel.
imsmooth( imagename='new.image', major='20pix', minor='10pix', kernel='boxcar')

Definition at line 46 of file imsmooth_cli.py.

def imsmooth_cli.imsmooth_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 368 of file imsmooth_cli.py.

def imsmooth_cli.imsmooth_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 306 of file imsmooth_cli.py.

def imsmooth_cli.imsmooth_cli_.description	(	self,
		key = `'imsmooth'`,
		subkey = `None`
	)

Definition at line 399 of file imsmooth_cli.py.

def imsmooth_cli.imsmooth_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 427 of file imsmooth_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(), imsubimage_cli.imsubimage_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 imsmooth_cli.imsmooth_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 282 of file imsmooth_cli.py.

def imsmooth_cli.imsmooth_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file imsmooth_cli.py.

References accum_cli.accum_cli_.__async__, imsmooth_cli.imsmooth_cli_.__async__, imregrid_cli.imregrid_cli_.__async__, imreframe_cli.imreframe_cli_.__async__, importvla_cli.importvla_cli_.__async__, importuvfits_cli.importuvfits_cli_.__async__, importgmrt_cli.importgmrt_cli_.__async__, importfitsidi_cli.importfitsidi_cli_.__async__, importfits_cli.importfits_cli_.__async__, importevla_cli.importevla_cli_.__async__, importasdm_cli.importasdm_cli_.__async__, impbcor_cli.impbcor_cli_.__async__, immoments_cli.immoments_cli_.__async__, immath_cli.immath_cli_.__async__, imhead_cli.imhead_cli_.__async__, imfit_cli.imfit_cli_.__async__, imcontsub_cli.imcontsub_cli_.__async__, imcollapse_cli.imcollapse_cli_.__async__, hanningsmooth_cli.hanningsmooth_cli_.__async__, gencal_cli.gencal_cli_.__async__, gaincal_cli.gaincal_cli_.__async__, ft_cli.ft_cli_.__async__, fluxscale_cli.fluxscale_cli_.__async__, flagmanager_cli.flagmanager_cli_.__async__, flagdata_cli.flagdata_cli_.__async__, flagcmd_cli.flagcmd_cli_.__async__, fixvis_cli.fixvis_cli_.__async__, fixplanets_cli.fixplanets_cli_.__async__, find_cli.find_cli_.__async__, feather_cli.feather_cli_.__async__, exportuvfits_cli.exportuvfits_cli_.__async__, exportfits_cli.exportfits_cli_.__async__, exportasdm_cli.exportasdm_cli_.__async__, delmod_cli.delmod_cli_.__async__, deconvolve_cli.deconvolve_cli_.__async__, cvel_cli.cvel_cli_.__async__, csvclean_cli.csvclean_cli_.__async__, conjugatevis_cli.conjugatevis_cli_.__async__, concat_cli.concat_cli_.__async__, clearstat_cli.clearstat_cli_.__async__, clearplot_cli.clearplot_cli_.__async__, clearcal_cli.clearcal_cli_.__async__, clean_cli.clean_cli_.__async__, caltabconvert_cli.caltabconvert_cli_.__async__, calstat_cli.calstat_cli_.__async__, browsetable_cli.browsetable_cli_.__async__, boxit_cli.boxit_cli_.__async__, blcal_cli.blcal_cli_.__async__, bandpass_cli.bandpass_cli_.__async__, autoclean_cli.autoclean_cli_.__async__, asdmsummary_cli.asdmsummary_cli_.__async__, and applycal_cli.applycal_cli_.__async__.

Member Data Documentation

dictionary imsmooth_cli.imsmooth_cli_.__async__ [static, private]

Definition at line 20 of file imsmooth_cli.py.

Referenced by imsmooth_cli.imsmooth_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(), listcal_cli.listcal_cli_.result(), imview_cli.imview_cli_.result(), imval_cli.imval_cli_.result(), imtrans_cli.imtrans_cli_.result(), imsubimage_cli.imsubimage_cli_.result(), and imstat_cli.imstat_cli_.result().

imsmooth_cli.imsmooth_cli_.__bases__ [private]

Definition at line 27 of file imsmooth_cli.py.

imsmooth_cli.imsmooth_cli_.__doc__ [private]

Definition at line 28 of file imsmooth_cli.py.

imsmooth_cli.imsmooth_cli_.__globals__ [private]

Definition at line 149 of file imsmooth_cli.py.

string imsmooth_cli.imsmooth_cli_.__name__ [static, private]

Definition at line 19 of file imsmooth_cli.py.

imsmooth_cli.imsmooth_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file imsmooth_cli.py.

imsmooth_cli.imsmooth_cli_.parameters

Definition at line 30 of file imsmooth_cli.py.

tuple imsmooth_cli.imsmooth_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 347 of file imsmooth_cli.py.

tuple imsmooth_cli.imsmooth_cli_.retval [static]

Definition at line 360 of file imsmooth_cli.py.

imsmooth_cli.imsmooth_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file imsmooth_cli.py.

string imsmooth_cli.imsmooth_cli_.valornotval [static]

Definition at line 350 of file imsmooth_cli.py.

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

imsmooth_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