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

Constructor & Destructor Documentation

def imcollapse_cli.imcollapse_cli_.__init__ ( self )

Definition at line 26 of file imcollapse_cli.py.

Member Function Documentation

def imcollapse_cli.imcollapse_cli_.__call__	(	self,
		imagename = `None`,
		function = `None`,
		axes = `None`,
		outfile = `None`,
		box = `None`,
		region = `None`,
		chans = `None`,
		stokes = `None`,
		mask = `None`,
		wantreturn = `None`,
		overwrite = `None`,
		stretch = `None`,
		async = `None`
	)

Collapse image along one axis, aggregating pixel values along that axis.
PARAMETER SUMMARY
imagename        Name of the input (CASA, FITS, MIRIAD) image
function         Function used to compute aggregation of pixel values along the collapsed
 axis. Supported functions are max, mean, median, min, rms, stdev,
 sum, variance. Minimum match is supported for the function parameter (eg,
 function="r" will compute the rms of the pixel values).
axis             Zero-based axis number(s) or minimal match strings to compress.
outfile          Name of output CASA image. If not specified, no image is written
 but an image analysis tool which references the output image is returned.
overwrite        If output file is specified, controls if an already existing file by the
 same name can be overwritten. If true, the user is not prompted, the file
 if it exists is automatically overwritten.
box              Direction plane box specification, "blcx, blcy, trcx, trcy". Only one box
 may be specified. If not specified, region is used if specified. If region
 is also not specified, entire directional plane unioned with any chans and
 stokes specification determines the region.
region           Region specification. See help par.region. Default is to not use a region.
chans            Optional contiguous frequency channel number specification. Not used if
 region is specified. Default is all channels.
stokes           Contiguous stokes planes specification. Not used if region is specified.
 Default is all stokes.
mask             Mask to use. See help par.mask. Default is none.
stretch          Stretch the input mask if necessary and possible. Only used if a mask is specified.
 See help par.stretch.
wantreturn       If true, return an image analysis tool referencing the collapsed image, if
 false, return false.

This task collapses an image along a specified axis or set of axes of N pixels to a single pixel on each
specified axis. It computes the specified aggregate function for pixel values along the specified axes
and places those values in the single remaining plane of those axes in the output image. It returns
an image analysis tool containing the newly created collapsed image if wantreturn=True. Choices of
aggregate functions are: max, mean, median, min, rms, stdev, sum, variance. Minimal unique match is
supported for the function parameter (eg, function="r" will compute the rms of the pixel values, "med"
will compute the median).

Axes can be specified as a single integer or array of integers indicating the zero-based axes along
which to collapse the image. Axes may also be specified as a single or array of strings which minimally
and uniquely match (ignoring case) world axes names in the image (eg "dec" or ["ri, "d"] for
collapsing along the declination axis or along the right ascension and declination axes, respectively).

If outfile is not specified (or contains only white spaces), no image is written but, if wantreturn=True,
the collapsed image is still able to be accessed via the returned image analysis tool which references
the collpased image. If the returned object is not wanted it should still be captured and deleted via its
done() method. If this is not done, there is no gaurantee for when the python garbage collector will delete
it. If the returned object is wanted, it should be deleted as soon as possible for the same reasons, eg

collapsed_image = imcollapse(..., wantreturn=T)
# do things (or not) with collapsed_image and when done with object, do
collapsed_image.done()

The reference pixel of the collapsed axis is set to 0 and its reference value is set to the mean
of the the first and last values of that axis in the specified region of the input image.

# myimage.im is a 512x512x128x4 (ra,dec,freq,stokes) image
imagename = "myimage.im"
# collapse a subimage of it along its spectral axis avoiding the 8 edge
# channels at each end of the band, computing the mean value of the pixels
# resulting image is 256x256x1x4 in size.
outfile="collapse_spec_mean.im"
function="mean"
axis=2
box="127,127,383,383"
chans="8~119"
collapsed = imcollapse(imagename=imagename, outfile=outfile, function=function, axes=axis, box=box, chans=chans, wantreturn=True)
# manipulate collapsed
collapsed.done()
T

Definition at line 46 of file imcollapse_cli.py.

def imcollapse_cli.imcollapse_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 331 of file imcollapse_cli.py.

def imcollapse_cli.imcollapse_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 269 of file imcollapse_cli.py.

def imcollapse_cli.imcollapse_cli_.description	(	self,
		key = `'imcollapse'`,
		subkey = `None`
	)

Definition at line 362 of file imcollapse_cli.py.

def imcollapse_cli.imcollapse_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 387 of file imcollapse_cli.py.

Referenced by rmtables_cli.rmtables_cli_.defaults(), listfits_cli.listfits_cli_.defaults(), listhistory_cli.listhistory_cli_.defaults(), importfitsidi_cli.importfitsidi_cli_.defaults(), uvsub_cli.uvsub_cli_.defaults(), uvcontsub2_cli.uvcontsub2_cli_.defaults(), importgmrt_cli.importgmrt_cli_.defaults(), plotweather_cli.plotweather_cli_.defaults(), importuvfits_cli.importuvfits_cli_.defaults(), imreframe_cli.imreframe_cli_.defaults(), plotants_cli.plotants_cli_.defaults(), importfits_cli.importfits_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(), imregrid_cli.imregrid_cli_.defaults(), listpartition_cli.listpartition_cli_.defaults(), sdscale_cli.sdscale_cli_.defaults(), imsubimage_cli.imsubimage_cli_.defaults(), msmoments_cli.msmoments_cli_.defaults(), impbcor_cli.impbcor_cli_.defaults(), slsearch_cli.slsearch_cli_.defaults(), peel_cli.peel_cli_.defaults(), predictcomp_cli.predictcomp_cli_.defaults(), uvcontsub_cli.uvcontsub_cli_.defaults(), wvrgcal_cli.wvrgcal_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(), imhead_cli.imhead_cli_.defaults(), listcal_cli.listcal_cli_.defaults(), sdgrid_cli.sdgrid_cli_.defaults(), importasdm_cli.importasdm_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(), importevla_cli.importevla_cli_.defaults(), partition_cli.partition_cli_.defaults(), simalma_cli.simalma_cli_.defaults(), imfit_cli.imfit_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 imcollapse_cli.imcollapse_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 245 of file imcollapse_cli.py.

def imcollapse_cli.imcollapse_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file imcollapse_cli.py.

References accum_cli.accum_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 imcollapse_cli.imcollapse_cli_.__async__ [static, private]

Definition at line 20 of file imcollapse_cli.py.

Referenced by imcollapse_cli.imcollapse_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(), imstat_cli.imstat_cli_.result(), imsmooth_cli.imsmooth_cli_.result(), imregrid_cli.imregrid_cli_.result(), imreframe_cli.imreframe_cli_.result(), importvla_cli.importvla_cli_.result(), importuvfits_cli.importuvfits_cli_.result(), importgmrt_cli.importgmrt_cli_.result(), importfitsidi_cli.importfitsidi_cli_.result(), importfits_cli.importfits_cli_.result(), importevla_cli.importevla_cli_.result(), importasdm_cli.importasdm_cli_.result(), impbcor_cli.impbcor_cli_.result(), immoments_cli.immoments_cli_.result(), immath_cli.immath_cli_.result(), imhead_cli.imhead_cli_.result(), imfit_cli.imfit_cli_.result(), and imcontsub_cli.imcontsub_cli_.result().

imcollapse_cli.imcollapse_cli_.__bases__ [private]

Definition at line 27 of file imcollapse_cli.py.

imcollapse_cli.imcollapse_cli_.__doc__ [private]

Definition at line 28 of file imcollapse_cli.py.

imcollapse_cli.imcollapse_cli_.__globals__ [private]

Definition at line 118 of file imcollapse_cli.py.

string imcollapse_cli.imcollapse_cli_.__name__ [static, private]

Definition at line 19 of file imcollapse_cli.py.

imcollapse_cli.imcollapse_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file imcollapse_cli.py.

imcollapse_cli.imcollapse_cli_.parameters

Definition at line 30 of file imcollapse_cli.py.

tuple imcollapse_cli.imcollapse_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 310 of file imcollapse_cli.py.

tuple imcollapse_cli.imcollapse_cli_.retval [static]

Definition at line 323 of file imcollapse_cli.py.

imcollapse_cli.imcollapse_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file imcollapse_cli.py.

string imcollapse_cli.imcollapse_cli_.valornotval [static]

Definition at line 313 of file imcollapse_cli.py.

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

imcollapse_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