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

Constructor & Destructor Documentation

def uvmodelfit_cli.uvmodelfit_cli_.__init__ ( self )

Definition at line 26 of file uvmodelfit_cli.py.

Member Function Documentation

def uvmodelfit_cli.uvmodelfit_cli_.__call__	(	self,
		vis = `None`,
		field = `None`,
		spw = `None`,
		selectdata = `None`,
		timerange = `None`,
		uvrange = `None`,
		antenna = `None`,
		scan = `None`,
		msselect = `None`,
		niter = `None`,
		comptype = `None`,
		sourcepar = `None`,
		varypar = `None`,
		outfile = `None`,
		async = `None`
	)

Fit a single component source model to the uv data

Fit a single component source model to the uv data.  Three models
are available: P=point; G=Gaussian; D=Disk.  Fitting parameters can
be held fixed.   The results are given in the log and placed in a
components file.

Keyword arguments:
vis -- Name of input visibility file 
default: none; example: vis='ngc5921.ms'

--- Data Selection
field -- Select data based on field id(s) or name(s)
default: '' (all); example: field='1'
field='0~2' # field ids inclusive from 0 to 2
field='3C*' # all field names starting with 3C
spw -- Select data based on spectral window
default: '' (all); example: spw='1'
spw='<2' #spectral windows less than 2
spw='>1' #spectral windows greater than 1
selectdata -- Select a subset of the visibility using MSSelection
default: False; example: selectdata=True
timerange  -- Select data based on time range:
default = '' (all); example,
timerange = 'YYYY/MM/DD/hh:mm:ss~YYYY/MM/DD/hh:mm:ss'
Note: YYYY/MM/DD can be dropped as needed:
timerange='09:14:0~09:54:0' # this time range
timerange='09:44:00' # data within one integration of time
timerange='>10:24:00' # data after this time
timerange='09:44:00+00:13:00' #data 13 minutes after time
uvrange -- Select data within uvrange (default units kilo-lambda)
       default: '' (all); example:
       uvrange='0~1000kl'; uvrange from 0-1000 kilo-lamgda
       uvrange='>4kl';uvranges greater than 4 kilo lambda
       uvrange='0~1000km'; uvrange in kilometers
antenna -- Select data based on antenna/baseline
default: '' (all); example: antenna='5&6' baseline 5-6
antenna='5&6;7&8' #baseline 5-6 and 7-8
antenna='5' # all baselines with antenna 5
antenna='5,6' # all baselines with antennas 5 and 6
scan -- Select data based on scan number - New, under developement
default: '' (all); example: scan='>3'
msselect -- Optional data selection (field,spw,time,etc)
default:'' means select all; example:msselect='FIELD_ID==0', 
msselect='FIELD_ID IN [0,1,2]' means select fields 0,1 and 2
msselect='FIELD_ID <= 1 means select fields 0, 1
msselect='FIELD_ID==0 && ANTENNA1 IN [0] && ANTENNA2 IN [2:26]'
   means select field 0 and antennas 0 to 26, except antenna 1.
Other msselect fields are: 'DATA_DESC_ID', 'SPECTRAL_WINDOW_ID',
'POLARIZATION_ID', 'SCAN_NUMBER', 'TIME', 'UVW'
See ccokbook for more details

niter -- Number of fitting iterations to execute
default: 5; example: niter=20
comptype -- component model type
default: 'P';
Options: 'P' (point source), 'G' (elliptical gaussian),
         'D' (elliptical disk)
sourcepar -- Starting guess for component parameters
default: [1,0,0];  (for comptype='P')
IF comptype = 'P' then
  sourcepar = [flux,xoff,yoff] where
    flux = Jy, xoff = arcsec-east, yoff = arcsec-north.
IF comptype = 'G' or 'D', then
  sourcepar = [flux,xoff,yoff,majax,axrat,pos] where
    majax = arcsec, axrat < 1, pos=angle in deg
varypar -- Control which parameters to let vary in the fit
default: [] (all vary);
example: vary=[F,T,T]

examples:

     fit a point:
comptype = 'P'
sourcepar = [0.4,0.2,-0.3];
varypar = [T,T,T]

     fit a circular Gaussian:
comptype = 'G'
sourcepar = [1.4,0.3,-0.2,0.3, 1, 0]
varypar    = [ T , T ,  T , T , F, F]
    

outfile -- Optional output component list table
default: ''; example: outfile='componentlist.cl'


How to get the output values:

    cl.open('componentlist.cl')
    fit = cl.getcompoent()             stores component information
    fit                                to see the whole mess
    flux = fit['flux']['value']        to store the I,Q,U,V, flux
    print flux

    ra = fit['shape']['direction']['m0']['value']
    dec =fit['shape']['direction']['m1']['value']
    print ra, dec

    bmaj = fit['shape']['majoraxis']['value']     to get major axis
    bmin = fit['shape']['minoraxis']['value']     to get minor axis

Definition at line 46 of file uvmodelfit_cli.py.

def uvmodelfit_cli.uvmodelfit_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 368 of file uvmodelfit_cli.py.

def uvmodelfit_cli.uvmodelfit_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 310 of file uvmodelfit_cli.py.

def uvmodelfit_cli.uvmodelfit_cli_.description	(	self,
		key = `'uvmodelfit'`,
		subkey = `None`
	)

Definition at line 399 of file uvmodelfit_cli.py.

def uvmodelfit_cli.uvmodelfit_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 426 of file uvmodelfit_cli.py.

References accum_cli.accum_cli_.parameters, uvmodelfit_cli.uvmodelfit_cli_.parameters, uvcontsub_cli.uvcontsub_cli_.parameters, uvcontsub3_cli.uvcontsub3_cli_.parameters, uvcontsub2_cli.uvcontsub2_cli_.parameters, testconcat_cli.testconcat_cli_.parameters, tclean_cli.tclean_cli_.parameters, statwt_cli.statwt_cli_.parameters, ssoflux_cli.ssoflux_cli_.parameters, split_cli.split_cli_.parameters, splattotable_cli.splattotable_cli_.parameters, specfit_cli.specfit_cli_.parameters, smoothcal_cli.smoothcal_cli_.parameters, slsearch_cli.slsearch_cli_.parameters, simobserve_cli.simobserve_cli_.parameters, simanalyze_cli.simanalyze_cli_.parameters, simalma_cli.simalma_cli_.parameters, setjy_cli.setjy_cli_.parameters, sdtpimaging_cli.sdtpimaging_cli_.parameters, sdstat_cli.sdstat_cli_.parameters, sdsmooth_cli.sdsmooth_cli_.parameters, sdscale_cli.sdscale_cli_.parameters, sdsave_cli.sdsave_cli_.parameters, sdreduce_cli.sdreduce_cli_.parameters, sdplot_cli.sdplot_cli_.parameters, sdmath_cli.sdmath_cli_.parameters, sdlist_cli.sdlist_cli_.parameters, sdimprocess_cli.sdimprocess_cli_.parameters, sdimaging_cli.sdimaging_cli_.parameters, sdgrid_cli.sdgrid_cli_.parameters, sdflagmanager_cli.sdflagmanager_cli_.parameters, sdflag_cli.sdflag_cli_.parameters, sdfit_cli.sdfit_cli_.parameters, sdcoadd_cli.sdcoadd_cli_.parameters, sdcal_cli.sdcal_cli_.parameters, sdbaseline_cli.sdbaseline_cli_.parameters, rmtables_cli.rmtables_cli_.parameters, applycal_cli.applycal_cli_.parameters, predictcomp_cli.predictcomp_cli_.parameters, polcal_cli.polcal_cli_.parameters, plotxy_cli.plotxy_cli_.parameters, plotweather_cli.plotweather_cli_.parameters, plotuv_cli.plotuv_cli_.parameters, plotms_cli.plotms_cli_.parameters, plotcal_cli.plotcal_cli_.parameters, plotants_cli.plotants_cli_.parameters, peel_cli.peel_cli_.parameters, pclean_cli.pclean_cli_.parameters, partition_cli.partition_cli_.parameters, msview_cli.msview_cli_.parameters, msmoments_cli.msmoments_cli_.parameters, mosaic_cli.mosaic_cli_.parameters, makemask_cli.makemask_cli_.parameters, autoclean_cli.autoclean_cli_.parameters, listsdm_cli.listsdm_cli_.parameters, listpartition_cli.listpartition_cli_.parameters, listobs_cli.listobs_cli_.parameters, listhistory_cli.listhistory_cli_.parameters, listfits_cli.listfits_cli_.parameters, listcal_cli.listcal_cli_.parameters, imview_cli.imview_cli_.parameters, imval_cli.imval_cli_.parameters, imtrans_cli.imtrans_cli_.parameters, imsubimage_cli.imsubimage_cli_.parameters, imstat_cli.imstat_cli_.parameters, imsmooth_cli.imsmooth_cli_.parameters, imregrid_cli.imregrid_cli_.parameters, imreframe_cli.imreframe_cli_.parameters, importvla_cli.importvla_cli_.parameters, importuvfits_cli.importuvfits_cli_.parameters, importgmrt_cli.importgmrt_cli_.parameters, importfitsidi_cli.importfitsidi_cli_.parameters, importfits_cli.importfits_cli_.parameters, importevla_cli.importevla_cli_.parameters, importasdm_cli.importasdm_cli_.parameters, impbcor_cli.impbcor_cli_.parameters, immoments_cli.immoments_cli_.parameters, immath_cli.immath_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, browsetable_cli.browsetable_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, ft_cli.ft_cli_.parameters, boxit_cli.boxit_cli_.parameters, blcal_cli.blcal_cli_.parameters, bandpass_cli.bandpass_cli_.parameters, listvis_cli.listvis_cli_.parameters, asdmsummary_cli.asdmsummary_cli_.parameters, and recipes.almahelpers.SpwInfo.parameters.

Referenced by uvsub_cli.uvsub_cli_.defaults(), viewer_cli.viewer_cli_.defaults(), wvrgcal_cli.wvrgcal_cli_.defaults(), vishead_cli.vishead_cli_.defaults(), virtualconcat_cli.virtualconcat_cli_.defaults(), visstat_cli.visstat_cli_.defaults(), widebandpbcor_cli.widebandpbcor_cli_.defaults(), uvmodelfit_cli.uvmodelfit_cli_.defaults(), and widefield_cli.widefield_cli_.defaults().

def uvmodelfit_cli.uvmodelfit_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 286 of file uvmodelfit_cli.py.

def uvmodelfit_cli.uvmodelfit_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file uvmodelfit_cli.py.

References accum_cli.accum_cli_.__async__, uvmodelfit_cli.uvmodelfit_cli_.__async__, uvcontsub_cli.uvcontsub_cli_.__async__, uvcontsub3_cli.uvcontsub3_cli_.__async__, uvcontsub2_cli.uvcontsub2_cli_.__async__, testconcat_cli.testconcat_cli_.__async__, tclean_cli.tclean_cli_.__async__, statwt_cli.statwt_cli_.__async__, ssoflux_cli.ssoflux_cli_.__async__, split_cli.split_cli_.__async__, splattotable_cli.splattotable_cli_.__async__, specfit_cli.specfit_cli_.__async__, smoothcal_cli.smoothcal_cli_.__async__, slsearch_cli.slsearch_cli_.__async__, simobserve_cli.simobserve_cli_.__async__, simanalyze_cli.simanalyze_cli_.__async__, simalma_cli.simalma_cli_.__async__, setjy_cli.setjy_cli_.__async__, sdtpimaging_cli.sdtpimaging_cli_.__async__, sdstat_cli.sdstat_cli_.__async__, sdsmooth_cli.sdsmooth_cli_.__async__, sdscale_cli.sdscale_cli_.__async__, sdsave_cli.sdsave_cli_.__async__, sdreduce_cli.sdreduce_cli_.__async__, sdplot_cli.sdplot_cli_.__async__, sdmath_cli.sdmath_cli_.__async__, sdlist_cli.sdlist_cli_.__async__, sdimprocess_cli.sdimprocess_cli_.__async__, sdimaging_cli.sdimaging_cli_.__async__, sdgrid_cli.sdgrid_cli_.__async__, sdflagmanager_cli.sdflagmanager_cli_.__async__, sdflag_cli.sdflag_cli_.__async__, sdfit_cli.sdfit_cli_.__async__, sdcoadd_cli.sdcoadd_cli_.__async__, sdcal_cli.sdcal_cli_.__async__, sdbaseline_cli.sdbaseline_cli_.__async__, rmtables_cli.rmtables_cli_.__async__, predictcomp_cli.predictcomp_cli_.__async__, polcal_cli.polcal_cli_.__async__, plotxy_cli.plotxy_cli_.__async__, plotweather_cli.plotweather_cli_.__async__, plotuv_cli.plotuv_cli_.__async__, plotms_cli.plotms_cli_.__async__, plotcal_cli.plotcal_cli_.__async__, plotants_cli.plotants_cli_.__async__, peel_cli.peel_cli_.__async__, pclean_cli.pclean_cli_.__async__, partition_cli.partition_cli_.__async__, msview_cli.msview_cli_.__async__, msmoments_cli.msmoments_cli_.__async__, mosaic_cli.mosaic_cli_.__async__, makemask_cli.makemask_cli_.__async__, listvis_cli.listvis_cli_.__async__, listsdm_cli.listsdm_cli_.__async__, listpartition_cli.listpartition_cli_.__async__, listobs_cli.listobs_cli_.__async__, listhistory_cli.listhistory_cli_.__async__, listfits_cli.listfits_cli_.__async__, listcal_cli.listcal_cli_.__async__, imview_cli.imview_cli_.__async__, imval_cli.imval_cli_.__async__, imtrans_cli.imtrans_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 uvmodelfit_cli.uvmodelfit_cli_.__async__ [static, private]

Definition at line 20 of file uvmodelfit_cli.py.

Referenced by uvmodelfit_cli.uvmodelfit_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(), and uvsub_cli.uvsub_cli_.result().

uvmodelfit_cli.uvmodelfit_cli_.__bases__ [private]

Definition at line 27 of file uvmodelfit_cli.py.

uvmodelfit_cli.uvmodelfit_cli_.__doc__ [private]

Definition at line 28 of file uvmodelfit_cli.py.

uvmodelfit_cli.uvmodelfit_cli_.__globals__ [private]

Definition at line 153 of file uvmodelfit_cli.py.

string uvmodelfit_cli.uvmodelfit_cli_.__name__ [static, private]

Definition at line 19 of file uvmodelfit_cli.py.

uvmodelfit_cli.uvmodelfit_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file uvmodelfit_cli.py.

uvmodelfit_cli.uvmodelfit_cli_.parameters

Definition at line 30 of file uvmodelfit_cli.py.

Referenced by vishead_cli.vishead_cli_.itsdefault(), wvrgcal_cli.wvrgcal_cli_.itsdefault(), widebandpbcor_cli.widebandpbcor_cli_.itsdefault(), visstat_cli.visstat_cli_.itsdefault(), uvmodelfit_cli.uvmodelfit_cli_.itsdefault(), and widefield_cli.widefield_cli_.itsdefault().

tuple uvmodelfit_cli.uvmodelfit_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 uvmodelfit_cli.py.

tuple uvmodelfit_cli.uvmodelfit_cli_.retval [static]

Definition at line 360 of file uvmodelfit_cli.py.

uvmodelfit_cli.uvmodelfit_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file uvmodelfit_cli.py.

string uvmodelfit_cli.uvmodelfit_cli_.valornotval [static]

Definition at line 350 of file uvmodelfit_cli.py.

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

uvmodelfit_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