Coverage for /wheeldirectory/casa-6.7.0-12-py3.10.el8/lib/py/lib/python3.10/site-packages/casatools/synthesisimager.py: 82%
72 statements
« prev ^ index » next coverage.py v7.6.4, created at 2024-11-01 07:19 +0000
« prev ^ index » next coverage.py v7.6.4, created at 2024-11-01 07:19 +0000
1##################### generated by xml-casa (v2) from synthesisimager.xml ###########
2##################### 7650622d99a3bacd5e07f2addadffb21 ##############################
3from __future__ import absolute_import
4from .__casac__.synthesisimager import synthesisimager as _synthesisimager
6from .errors import create_error_string
7from .typecheck import CasaValidator as _validator
8_pc = _validator( )
9from .coercetype import coerce as _coerce
10from .synthesisimstore import synthesisimstore as _wrap_synthesisimstore
12class synthesisimager:
13 _info_group_ = """synthesisimager"""
14 _info_desc_ = """tool for synthesis imaging"""
15 ### self
16 def __init__(self, *args, **kwargs):
17 """This is used to construct {tt synthesisimager} tool.
18 """
19 self._swigobj = kwargs.get('swig_object',None)
20 if self._swigobj is None:
21 self._swigobj = _synthesisimager()
23 def selectdata(self, selpars={ }):
24 """
25 """
26 return self._swigobj.selectdata(selpars)
28 def tuneselectdata(self):
29 """
30 """
31 return self._swigobj.tuneselectdata()
33 def defineimage(self, impars={ }, gridpars={ }):
34 """
35 """
36 return self._swigobj.defineimage(impars, gridpars)
38 def normalizerinfo(self, normpars={ }):
39 """
40 """
41 return self._swigobj.normalizerinfo(normpars)
43 def setdata(self, msname='', spw='', freqbeg='', freqend='', freqframe='LSRK', field='', antenna='', timestr='', scan='', obs='', state='', uvdist='', taql='', usescratch=False, readonly=False, incrmodel=False):
44 """Select data from one MS. Call this function in succession if there are
45 multiple MSs.
46 """
47 return self._swigobj.setdata(msname, spw, freqbeg, freqend, freqframe, field, antenna, timestr, scan, obs, state, uvdist, taql, usescratch, readonly, incrmodel)
49 def setimage(self, imagename='', nx=int(128), ny=int(-1), cellx=[ ], celly=[ ], stokes='I', phasecenter=[ ], nchan=int(-1), freqstart=[ ], freqstep=[ ], restfreq=[ ], facets=int(1), ftmachine='gridft', ntaylorterms=int(1), reffreq=[ ], projection='SIN', distance=[ ], freqframe='LSRK', tracksource=False, trackdir=[ ], overwrite=True, padding=float(1.0), useautocorr=False, usedoubleprec=True, wprojplanes=int(1), convfunc='SF', startmodel='', aterm=True, psterm=True, mterm=False, wbawp=True, cfcache='', usepointing=False, pointingoffsetsigdev=[ ], dopbcorr=True, conjbeams=False, computepastep=float(360.0), rotatepastep=float(5.0)):
50 """Define the image coordinate systems and shapes.
51 """
52 return self._swigobj.setimage(imagename, nx, ny, cellx, celly, stokes, phasecenter, nchan, freqstart, freqstep, restfreq, facets, ftmachine, ntaylorterms, reffreq, projection, distance, freqframe, tracksource, trackdir, overwrite, padding, useautocorr, usedoubleprec, wprojplanes, convfunc, startmodel, aterm, psterm, mterm, wbawp, cfcache, usepointing, pointingoffsetsigdev, dopbcorr, conjbeams, computepastep, rotatepastep)
54 def setweighting(self, type='natural', rmode='norm', noise=[ ], robust=float(0.0), fieldofview=[ ], npixels=int(0), multifield=False, usecubebriggs=False, uvtaper=[ ]):
55 """
56 """
57 return self._swigobj.setweighting(type, rmode, noise, robust, fieldofview, npixels, multifield, usecubebriggs, uvtaper)
59 def makepsf(self):
60 """
61 """
62 return self._swigobj.makepsf()
64 def apparentsens(self):
65 """
66 """
67 return self._swigobj.apparentsens()
69 def predictmodel(self):
70 """
71 """
72 return self._swigobj.predictmodel()
74 def drygridding(self, cflist=[ '' ]):
75 """
76 """
77 return self._swigobj.drygridding(cflist)
79 def fillcfcache(self, cflist=[ '' ], ftmname='', cfcpath='', pstermon=False, atermon=True, conjbeams=False):
80 """
81 """
82 return self._swigobj.fillcfcache(cflist, ftmname, cfcpath, pstermon, atermon, conjbeams)
84 def reloadcfcache(self):
85 """
86 """
87 return self._swigobj.reloadcfcache()
89 def executemajorcycle(self, controls={ }):
90 """
91 """
92 return self._swigobj.executemajorcycle(controls)
94 def makepb(self):
95 """
96 """
97 return self._swigobj.makepb()
99 def makesdimage(self):
100 """
101 """
102 return self._swigobj.makesdimage()
104 def makesdpsf(self):
105 """
106 """
107 return self._swigobj.makesdpsf()
109 def makeimage(self, type='observed', image='', compleximage='', model=int(0)):
110 """This tool function actually does gridding (and Fourier inversion if
111 needed) of visibility data to make an image. It allows calculation of
112 various types of image:
113 begin{description}
114 item[observed] Make the dirty image from the DATA column ({em default})
115 item[model] Make the dirty image from the MODEL_DATA column
116 item[corrected] Make the dirty image from the CORRECTED_DATA column
117 item[residual] Make the dirty image from the difference of the
118 CORRECTED_DATA and MODEL_DATA columns
119 item[psf] Make the point spread function
120 item[singledish] Make a single dish image
121 item[coverage] Make a single dish or mosaic coverage image
122 item[holography] Make a complex holography image (experimental)
124 end{description}
125 """
126 return self._swigobj.makeimage(type, image, compleximage, model)
128 def unlockimages(self, imagefieldid=int(0)):
129 """Try to unlock images if the need arise
130 """
131 return self._swigobj.unlockimages(imagefieldid)
133 def estimatememory(self):
134 """This function returns an estimate of the memory (RAM) to be used by sythesisimager tool. Need to be run after functions setdata and defineimage are done
135 """
136 return self._swigobj.estimatememory()
138 def getimstore(self, id=int(0)):
139 """
140 """
141 return _wrap_synthesisimstore(swig_object=self._swigobj.getimstore(id))
143 def getImageName(self, facetId=int(0), imageId='IMAGE', taylorTerm=int(0)):
144 """Get the image name for the given type of image (eg "PB"), the facet index, and the taylor term.
146 """
147 return self._swigobj.getImageName(facetId, imageId, taylorTerm)
149 def getcsys(self):
150 """
151 """
152 return self._swigobj.getcsys()
154 def updatenchan(self):
155 """
156 """
157 return self._swigobj.updatenchan()
159 def getweightdensity(self):
160 """
161 """
162 return self._swigobj.getweightdensity()
164 def setweightdensity(self, type=''):
165 """Load the gridded weight density into image weighting; useful in parallel when weight density is combined into one image and loaded in each process. if no imagename is passed the imagename.weight is loaded
167 """
168 return self._swigobj.setweightdensity(type)
170 def initmpi(self):
171 """
172 """
173 return self._swigobj.initmpi()
175 def releasempi(self):
176 """
177 """
178 return self._swigobj.releasempi()
180 def done(self):
181 """
182 """
183 return self._swigobj.done()