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

Constructor & Destructor Documentation

def imsubimage_cli.imsubimage_cli_.__init__ ( self )

Definition at line 26 of file imsubimage_cli.py.

Member Function Documentation

def imsubimage_cli.imsubimage_cli_.__call__	(	self,
		imagename = `None`,
		outfile = `None`,
		region = `None`,
		mask = `None`,
		dropdeg = `None`,
		overwrite = `None`,
		verbose = `None`,
		stretch = `None`,
		wantreturn = `None`,
		async = `None`
	)

Create a (sub)image from a region of the image
PARAMETER SUMMARY
imagename Name of the input image
outfile Name of output file. Empty means create a temporary image and return it.
region Region of interest. See help par.region for specification options. Default ("") is entire image.
mask Mask to use. See help par.mask. Default ("") is none.
dropdeg If True, all degenerate axes in the input image will be excluded in the output image.
overwrite If True, a pre-existing file of the same name as outfile will be overwritten.
verbose Post additional informative messages to the logger.
stretch Stretch the input mask if necessary and possible. Only used if a mask is specified.
See help par.stretch.

OVERVIEW

This task copies all or part of the image to another on-the-fly Image tool.
If {\stfaf outfile} is given, the subimage is written to the specified
disk file. If {\stfaf outfile} is unset, the returned Image \tool\ actually
references the input image file (i.e. that associated with the Image
\tool\ to which you are applying this function). So if you deleted the
input image disk file, it would render this \tool\ useless. When you destroy this
\tool\ (with the done function)
the reference connection is broken.

Sometimes it is useful to drop axes of length one (degenerate axes).
Set {\stfaf dropdeg} equal to True if you want to do this.

The output mask is the combination (logical OR) of the default input
\pixelmask\ (if any) and the OTF mask. Any other input \pixelmasks\
will not be copied. Use function maskhandler if you
need to copy other masks too.

If the mask has fewer dimensions than the image and if the shape
of the dimensions the mask and image have in common are the same,
the mask will automatically have the missing dimensions added so
it conforms to the image.

If stretch is true and if the number of mask dimensions is less than
or equal to the number of image dimensions and some axes in the
mask are degenerate while the corresponding axes in the image are not,
the mask will be stetched in the degenerate dimensions. For example,
if the input image has shape [100, 200, 10] and the input
mask has shape [100, 200, 1] and stretch is true, the mask will be
stretched along the third dimension to shape [100, 200, 10]. However if
the mask is shape [100, 200, 2], stretching is not possible and an
error will result.

Definition at line 46 of file imsubimage_cli.py.

def imsubimage_cli.imsubimage_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 296 of file imsubimage_cli.py.

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

def imsubimage_cli.imsubimage_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 241 of file imsubimage_cli.py.

def imsubimage_cli.imsubimage_cli_.description	(	self,
		key = `'imsubimage'`,
		subkey = `None`
	)

Definition at line 327 of file imsubimage_cli.py.

def imsubimage_cli.imsubimage_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 345 of file imsubimage_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 imsubimage_cli.imsubimage_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 217 of file imsubimage_cli.py.

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

def imsubimage_cli.imsubimage_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file imsubimage_cli.py.

References accum_cli.accum_cli_.__async__, imsubimage_cli.imsubimage_cli_.__async__, imstat_cli.imstat_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 imsubimage_cli.imsubimage_cli_.__async__ [static, private]

Definition at line 20 of file imsubimage_cli.py.

Referenced by imsubimage_cli.imsubimage_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(), and imtrans_cli.imtrans_cli_.result().

imsubimage_cli.imsubimage_cli_.__bases__ [private]

Definition at line 27 of file imsubimage_cli.py.

imsubimage_cli.imsubimage_cli_.__doc__ [private]

Definition at line 28 of file imsubimage_cli.py.

imsubimage_cli.imsubimage_cli_.__globals__ [private]

Definition at line 96 of file imsubimage_cli.py.

string imsubimage_cli.imsubimage_cli_.__name__ [static, private]

Definition at line 19 of file imsubimage_cli.py.

imsubimage_cli.imsubimage_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file imsubimage_cli.py.

imsubimage_cli.imsubimage_cli_.parameters

Definition at line 30 of file imsubimage_cli.py.

tuple imsubimage_cli.imsubimage_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 275 of file imsubimage_cli.py.

tuple imsubimage_cli.imsubimage_cli_.retval [static]

Definition at line 288 of file imsubimage_cli.py.

imsubimage_cli.imsubimage_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file imsubimage_cli.py.

string imsubimage_cli.imsubimage_cli_.valornotval [static]

Definition at line 278 of file imsubimage_cli.py.

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

imsubimage_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