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

Constructor & Destructor Documentation

def imstat_cli.imstat_cli_.__init__ ( self )

Definition at line 26 of file imstat_cli.py.

Member Function Documentation

def imstat_cli.imstat_cli_.__call__	(	self,
		imagename = `None`,
		axes = `None`,
		region = `None`,
		box = `None`,
		chans = `None`,
		stokes = `None`,
		listit = `None`,
		verbose = `None`,
		mask = `None`,
		stretch = `None`,
		logfile = `None`,
		append = `None`,
		async = `None`
	)

Displays statistical information from an image or image region

     Many parameters are determined from the specified region of an image.
     For this version, the region can be specified by a set of rectangular
     pixel coordinates, the channel ranges and the Stokes.

     For directed output, run as 
    myoutput = imstat()
   

Keyword arguments:
imagename    Name of input image
     Default: none; Example: imagename='ngc5921_task.im'
axes         axes to compute statistics over. -1 => all axes.
region       Region of interest. See help par.region.
box          A box region specified in pixels on the directional plane
     Default: none (whole 2-D plane); 
     Example: box='10,10,50,50'
     box = '10,10,30,30,35,35,50,50' (two boxes)
chans        Zero based channel numbers
 Range of channel numbers to include in statistics
     All spectral windows are included
     Default:''= all;  Example: chans='3~20'    
stokes       Stokes parameters to analyze.
     Default: all; Example: stokes='IQUV';  
     Example:stokes='I,Q'
     Options: 'I','Q','U','V','RR','RL','LR','LL','XX','YX','XY','YY', ...
listit       Print stats and bounding box to logger? 
verbose      Print additional messages to logger?
mask         Mask to use. See help par.mask. Default is none.
stretch      Stretch the mask if necessary and possible? See help par.stretch 
logfile      Name of file to write fit results.
append       If logfile exists, append to it (True) or overwrite it (False).


      General procedure:

 1.  Specify inputs, then

 2.  myoutput = imstat()
       or specify inputs directly in calling sequence to task
     myoutput = imstat(imagename='image.im', etc)

 3.  myoutput['KEYS'] will contain the result associated with any
       of the keys given below

KEYS CURRENTLY AVAILABLE
blc          - absolute PIXEL coordinate of the bottom left corner of 
       the bounding box surrounding the selected region
blcf         - Same as blc, but uses WORLD coordinates instead of pixels
trc          - the absolute PIXEL coordinate of the top right corner 
       of the bounding box surrounding the selected region
trcf         - Same as trc, but uses WORLD coordinates instead of pixels
flux         - the integrated flux density if the beam is defined and 
       the if brightness units are $Jy/beam$
npts         - the number of unmasked points used
max          - the maximum pixel value
min          - minimum pixel value
maxpos       - absolute PIXEL coordinate of maximum pixel value
maxposf      - Same as maxpos, but uses WORLD coordinates instead of pixels
minpos       - absolute pixel coordinate of minimum pixel value
minposf      - Same as minpos, but uses WORLD coordinates instead of pixels
sum          - the sum of the pixel values: $\sum I_i$
sumsq        - the sum of the squares of the pixel values: $\sum I_i^2$
mean         - the mean of pixel values: 
       $\bar{I} = \sum I_i / n$
sigma        - the standard deviation about the mean: 
       $\sigma^2 = (\sum I_i - \bar{I})^2 / (n-1)$
rms          - the root mean square: 
       $\sqrt {\sum I_i^2 / n}$
median       - the median pixel value
medabsdevmed - the median of the absolute deviations from the 
       median
quartile     - the inter-quartile range. Find the points 
       which are 25% largest and 75% largest (the median is 
       50% largest), find their difference and divide that 
       difference by 2.

Additional Examples
# Selected two box region
# box 1, bottom-left coord is 2,3 and top-right coord is 14,15
# box 2, bottom-left coord is 30,31 and top-right coord is 42,43
imstat( 'myImage', box='2,3,14,15;30,31,42,43' )

# Select the same two box regions but only channels 4 and 5
imstat( 'myImage', box='2,3,14,15;30,31,42,43', chan='4~5' )

# Select all channels greater the 20 as well as channel 0.
# Then the mean and standard deviation are printed
results = imstat( 'myImage', chans='>20;0' )
print "Mean is: ", results['mean'], "  s.d. ", results['sigma']

# Find statistical information for the Q stokes value only
# then the I stokes values only, and printing out the statistical
# values that we are interested in.
s1 = imstat( 'myimage', stokes='Q' )
s2 = imstat( 'myimage', stokes='I' )
print "       |  MIN  |   MAX  | MEAN"
print "  Q    | ",s1['min'][0],"  |  ",s1['max'][0],"  |  ",,"  |  ",s1['mean'][0]
print "  I    | ",s2['min'][0],"  |  ",s2['max'][0],"  |  ",,"  |  ",s2['mean'][0]

# evaluate statistics for each spectral plane in an ra x dec x frequency image
ia.fromshape("", [20,30,40])
# give pixels non-zero values
ia.addnoise()
# These are the display axes, the calculation of statistics occurs
# for each (hyper)plane along axes not listed in the axes parameter,
# in this case axis 2 (the frequency axis)
# display the rms for each frequency plane (your mileage will vary with
# the values).
stats = ia.statistics(axes=[0,1])
 stats["rms"]
  Out[10]: 
array([ 0.99576014,  1.03813124,  0.97749186,  0.97587883,  1.04189885,
1.03784776,  1.03371549,  1.03153074,  1.00841606,  0.947155  ,
0.97335404,  0.94389403,  1.0010221 ,  0.97151822,  1.03942156,
1.01158476,  0.96957082,  1.04212773,  1.00589049,  0.98696715,
1.00451481,  1.02307892,  1.03102005,  0.97334671,  0.95209879,
1.02088714,  0.96999902,  0.98661619,  1.01039267,  0.96842754,
0.99464947,  1.01536798,  1.02466023,  0.96956468,  0.98090756,
0.9835844 ,  0.95698935,  1.05487967,  0.99846411,  0.99634868])

Definition at line 46 of file imstat_cli.py.

def imstat_cli.imstat_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 384 of file imstat_cli.py.

def imstat_cli.imstat_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 324 of file imstat_cli.py.

def imstat_cli.imstat_cli_.description	(	self,
		key = `'imstat'`,
		subkey = `None`
	)

Definition at line 415 of file imstat_cli.py.

def imstat_cli.imstat_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 440 of file imstat_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 imstat_cli.imstat_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 300 of file imstat_cli.py.

def imstat_cli.imstat_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file imstat_cli.py.

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

Definition at line 20 of file imstat_cli.py.

Referenced by imstat_cli.imstat_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(), and imsubimage_cli.imsubimage_cli_.result().

imstat_cli.imstat_cli_.__bases__ [private]

Definition at line 27 of file imstat_cli.py.

imstat_cli.imstat_cli_.__doc__ [private]

Definition at line 28 of file imstat_cli.py.

imstat_cli.imstat_cli_.__globals__ [private]

Definition at line 173 of file imstat_cli.py.

string imstat_cli.imstat_cli_.__name__ [static, private]

Definition at line 19 of file imstat_cli.py.

imstat_cli.imstat_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file imstat_cli.py.

imstat_cli.imstat_cli_.parameters

Definition at line 30 of file imstat_cli.py.

tuple imstat_cli.imstat_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 363 of file imstat_cli.py.

tuple imstat_cli.imstat_cli_.retval [static]

Definition at line 376 of file imstat_cli.py.

imstat_cli.imstat_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file imstat_cli.py.

string imstat_cli.imstat_cli_.valornotval [static]

Definition at line 366 of file imstat_cli.py.

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

imstat_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