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

Constructor & Destructor Documentation

def imhead_cli.imhead_cli_.__init__ ( self )

Definition at line 26 of file imhead_cli.py.

Member Function Documentation

def imhead_cli.imhead_cli_.__call__	(	self,
		imagename = `None`,
		mode = `None`,
		hdkey = `None`,
		hdvalue = `None`,
		hdtype = `None`,
		hdcomment = `None`,
		verbose = `None`,
		async = `None`
	)

List, get and put image header parameters

This task allows the user to manipulate some meta-data parameters in an
image.  The mode='list' shows those keywords that are
presently implemented, with their values.  The contents associated
with the keywords can be obtained (get) and changed (put).

Additional image parameter listings are available.

[For visibility files, the taskname='vishead' should be used.]

The modes that are available are:

   list    --- Lists the image header keywords and values.
       Use this if 'get' and 'put' are executed.
   get     --- Get the specified keyword value(s) from the image
   put     --- Put the specified keyword value(s) into the image 

   history --- Display the history information in hte CASA logger.
   summary --- Information summarizing the CASA image file.
   fits    --- Lists the header information in a FITS style (not available)
   add     --- Adds a new header key.  Use with caution
   del     --- Delete a header key, hdkey.  Use with caution

Parameters currently implemented are listed using mode = 'list'

   beammaj         Major axis of the clean beam
   beammin         Minor axis of the clean beam
   beampa          Position angle of the clean beam
   NOTE: If the image contains multiple beams, use mode="summary" to get
   a listing.
   bunit           Brightness unit (K, Jy/beam, etc)
   cdeltn          Pixel size, nth axis  (max n is 4)
   crpixn          Pixel coordinate of reference point, nth axis
   crvaln          Pixel location of reference point, nth axis
   ctypen          Axis name, nth axis
   cunitn          Pixel units, nth axis
   datamax         Maximum pixel value in image
   datamin         Minimum pixel value in image
   date-obs        Date of the observation
   equinox         Reference frame for directional coordinates
   imtype          Image type: intensity, 
   minpos
   minpixpos
   maxpos
   maxpixpos
   object          Source name
   observer        Observer name
   projection      Image projection ('SIN','TAN', or 'ZEA')
   reffreqtype     Reference frame for the spectral coordinates
   restfreq        Rest Frequency
   shape           Number of pixels along each axis
   telescope       Telescope name

Keyword arguments:

imagename --- Name of input image
        default: none; example: imagename='ngc5921_task.image'
mode      --- Mode: options: 
        default: none; 'list', 'summary', 'fits', 'history',
        'get', 'put', 'add', and 'del'

        NOTE:  'add' and 'del' should be used with caution

hdkey     --- keyword to use with get, put, add, or del
        default: none;  example: hdkey='telescope'
hdvalue   --- keyword value that is 'got', or to be 'put' or
      to be 'added'
        default: ''; example: hdvalue='VLA'
hdcomment --- comment to be stored with the keyword for mode='put' or mode='add'
Examples: 
  hdkey='date-obs';hdvalue='2007/06/20/00:00:00'
  hdkey='beammajor';hdvalue='55arcsec'
  hdkey='beampa'';hdvalue='0deg'
  hdkey='restfrequency';hdvalue='1.421GHz'
  hdkey='restfrequency';hdvalue='1.421GHz, 115.272GHz'
  hdkey='projection';hdvalue='TAN'
  hdkey='cdelt4';hdvalue=24415.05
  hdkey='cdelt1';hdvalue='7.75e-5deg'
  hdkey='crval1';hdvalue=qa.quantity( '763180', 'arsec')
  hdkey='crval1';hdvalue='14:07:58'
  hdkey='crval4';hdvalue='6250000Hz'

hdtype    --- Used only with 'add' mode.  It is the data type that
           is used to store the hdkey.  It can not be used to
           change the data type of an exiting keyword.
      options: bool, int, string, doubple, complex
      default: none; example hdtype='double'


Note that hdvalue will contain numbers, strings as well as units.

If mode="summary", verbose=True and the image contains multiple beams, the output,
will contain information on every beam in the dataset. If mode="summary",
verbose=False and the image has multiple beams, only a brief summary of
beams for each polarization is listed. In this
case, the beams with the maximum area, the minimum area, and the median area for
each polarization are listed. If mode is not "summary" and/or the image does not
have multiple beams, verbose is not used.

Examples:

1)  get the clean beam from one image and put it in a second image

   Get the clean beam from image1 into hdvalue
imagename = 'image1.im'; mode = 'get'; hdkey = 'beam'
hdvalue = imhead()
print hdvalue   #  to see values

   To then put the clean beam into image2
imagename = 'image2.im', mode = 'put'; imhead()

2)  Most output values are dictionaries:


       mode = 'get'; hdkey = 'maxpos'; aa = imhead()

    would give for the command print aa
{'value': '03:19:48.160, +41.30.42.103, I, 4.88163e+09Hz', 'unit': ''}
    print aa['value'] gives 
03:19:48.160, +41.30.42.103, I, 4.88163e+09Hz
    print aa['value'[1][0:12] gives 03:19:48.160

      
       mode = 'get'; hdkey = 'crpix1'; aa = imhead()

    would give for the command print aa
{'value': '128.0', 'unit': ''}
    print aa['value'] gives 
128.0    (a string)

3)  The use of put is a bit more straight-forward

       mode = 'put'; hdkey = 'crpix1'; hdvalue = '200'; imhead()
     then
       mode = 'get'; hdkey = 'crpix1'; aa = imhead()  would give
   {'value': '200.0', 'unit': ''}

Definition at line 46 of file imhead_cli.py.

def imhead_cli.imhead_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 387 of file imhead_cli.py.

def imhead_cli.imhead_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 330 of file imhead_cli.py.

def imhead_cli.imhead_cli_.description	(	self,
		key = `'imhead'`,
		subkey = `None`
	)

Definition at line 418 of file imhead_cli.py.

def imhead_cli.imhead_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 438 of file imhead_cli.py.

References accum_cli.accum_cli_.parameters, imhead_cli.imhead_cli_.parameters, imfit_cli.imfit_cli_.parameters, imcontsub_cli.imcontsub_cli_.parameters, imcollapse_cli.imcollapse_cli_.parameters, hanningsmooth_cli.hanningsmooth_cli_.parameters, gencal_cli.gencal_cli_.parameters, gaincal_cli.gaincal_cli_.parameters, ft_cli.ft_cli_.parameters, fluxscale_cli.fluxscale_cli_.parameters, flagmanager_cli.flagmanager_cli_.parameters, flagdata_cli.flagdata_cli_.parameters, flagcmd_cli.flagcmd_cli_.parameters, fixvis_cli.fixvis_cli_.parameters, fixplanets_cli.fixplanets_cli_.parameters, find_cli.find_cli_.parameters, feather_cli.feather_cli_.parameters, exportuvfits_cli.exportuvfits_cli_.parameters, exportfits_cli.exportfits_cli_.parameters, exportasdm_cli.exportasdm_cli_.parameters, delmod_cli.delmod_cli_.parameters, deconvolve_cli.deconvolve_cli_.parameters, cvel_cli.cvel_cli_.parameters, csvclean_cli.csvclean_cli_.parameters, conjugatevis_cli.conjugatevis_cli_.parameters, concat_cli.concat_cli_.parameters, clearstat_cli.clearstat_cli_.parameters, clearplot_cli.clearplot_cli_.parameters, clearcal_cli.clearcal_cli_.parameters, clean_cli.clean_cli_.parameters, caltabconvert_cli.caltabconvert_cli_.parameters, calstat_cli.calstat_cli_.parameters, browsetable_cli.browsetable_cli_.parameters, boxit_cli.boxit_cli_.parameters, blcal_cli.blcal_cli_.parameters, bandpass_cli.bandpass_cli_.parameters, autoclean_cli.autoclean_cli_.parameters, asdmsummary_cli.asdmsummary_cli_.parameters, and applycal_cli.applycal_cli_.parameters.

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(), impbcor_cli.impbcor_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(), imhead_cli.imhead_cli_.defaults(), sdmath_cli.sdmath_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(), 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 imhead_cli.imhead_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 306 of file imhead_cli.py.

def imhead_cli.imhead_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file imhead_cli.py.

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

Definition at line 20 of file imhead_cli.py.

Referenced by imhead_cli.imhead_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(), and immath_cli.immath_cli_.result().

imhead_cli.imhead_cli_.__bases__ [private]

Definition at line 27 of file imhead_cli.py.

imhead_cli.imhead_cli_.__doc__ [private]

Definition at line 28 of file imhead_cli.py.

imhead_cli.imhead_cli_.__globals__ [private]

Definition at line 189 of file imhead_cli.py.

string imhead_cli.imhead_cli_.__name__ [static, private]

Definition at line 19 of file imhead_cli.py.

imhead_cli.imhead_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file imhead_cli.py.

imhead_cli.imhead_cli_.parameters

Definition at line 30 of file imhead_cli.py.

tuple imhead_cli.imhead_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 366 of file imhead_cli.py.

tuple imhead_cli.imhead_cli_.retval [static]

Definition at line 379 of file imhead_cli.py.

imhead_cli.imhead_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file imhead_cli.py.

string imhead_cli.imhead_cli_.valornotval [static]

Definition at line 369 of file imhead_cli.py.

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

imhead_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