Coverage for /wheeldirectory/casa-6.7.0-12-py3.10.el8/lib/py/lib/python3.10/site-packages/casatools/__casac__/iterbotsink.py: 59%

1# This file was automatically generated by SWIG (http://www.swig.org). 

2# Version 3.0.12 

3# 

4# Do not make changes to this file unless you know what you are doing--modify 

5# the SWIG interface file instead. 

6 

7from sys import version_info as _swig_python_version_info 

8if _swig_python_version_info >= (2, 7, 0): 

9 def swig_import_helper(): 

10 import importlib 

11 pkg = __name__.rpartition('.')[0] 

12 mname = '.'.join((pkg, '_iterbotsink')).lstrip('.') 

13 try: 

14 return importlib.import_module(mname) 

15 except ImportError: 

16 return importlib.import_module('_iterbotsink') 

17 _iterbotsink = swig_import_helper() 

18 del swig_import_helper 

19elif _swig_python_version_info >= (2, 6, 0): 

20 def swig_import_helper(): 

21 from os.path import dirname 

22 import imp 

23 fp = None 

24 try: 

25 fp, pathname, description = imp.find_module('_iterbotsink', [dirname(__file__)]) 

26 except ImportError: 

27 import _iterbotsink 

28 return _iterbotsink 

29 try: 

30 _mod = imp.load_module('_iterbotsink', fp, pathname, description) 

31 finally: 

32 if fp is not None: 

33 fp.close() 

34 return _mod 

35 _iterbotsink = swig_import_helper() 

36 del swig_import_helper 

37else: 

38 import _iterbotsink 

39del _swig_python_version_info 

40 

41try: 

42 _swig_property = property 

43except NameError: 

44 pass # Python < 2.2 doesn't have 'property'. 

45 

46try: 

47 import builtins as __builtin__ 

48except ImportError: 

49 import __builtin__ 

50 

51def _swig_setattr_nondynamic(self, class_type, name, value, static=1): 

52 if (name == "thisown"): 

53 return self.this.own(value) 

54 if (name == "this"): 

55 if type(value).__name__ == 'SwigPyObject': 

56 self.__dict__[name] = value 

57 return 

58 method = class_type.__swig_setmethods__.get(name, None) 

59 if method: 

60 return method(self, value) 

61 if (not static): 

62 if _newclass: 

63 object.__setattr__(self, name, value) 

64 else: 

65 self.__dict__[name] = value 

66 else: 

67 raise AttributeError("You cannot add attributes to %s" % self) 

68 

69 

70def _swig_setattr(self, class_type, name, value): 

71 return _swig_setattr_nondynamic(self, class_type, name, value, 0) 

72 

73 

74def _swig_getattr(self, class_type, name): 

75 if (name == "thisown"): 

76 return self.this.own() 

77 method = class_type.__swig_getmethods__.get(name, None) 

78 if method: 

79 return method(self) 

80 raise AttributeError("'%s' object has no attribute '%s'" % (class_type.__name__, name)) 

81 

82 

83def _swig_repr(self): 

84 try: 

85 strthis = "proxy of " + self.this.__repr__() 

86 except __builtin__.Exception: 

87 strthis = "" 

88 return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,) 

89 

90try: 

91 _object = object 

92 _newclass = 1 

93except __builtin__.Exception: 

94 class _object: 

95 pass 

96 _newclass = 0 

97 

98class iterbotsink(_object): 

99 """Proxy of C++ casac::iterbotsink class.""" 

100 

101 __swig_setmethods__ = {} 

102 __setattr__ = lambda self, name, value: _swig_setattr(self, iterbotsink, name, value) 

103 __swig_getmethods__ = {} 

104 __getattr__ = lambda self, name: _swig_getattr(self, iterbotsink, name) 

105 __repr__ = _swig_repr 

106 

107 def __init__(self): 

108 """__init__(self) -> iterbotsink""" 

109 this = _iterbotsink.new_iterbotsink() 

110 try: 

111 self.this.append(this) 

112 except __builtin__.Exception: 

113 self.this = this 

114 

115 def setupiteration(self, *args, **kwargs): 

116 """ 

117 setupiteration(self, _iterpars) -> record * 

118 

119 

120 

121 Summary: 

122 Set parameters to control iteration mechanisms 

123 

124 Input Parameters: 

125 iterpars All parameters that control iterations 

126 

127 -------------------------------------------------------------------------------- 

128 

129 """ 

130 return _iterbotsink.iterbotsink_setupiteration(self, *args, **kwargs) 

131 

132 

133 def cleanComplete(self, *args, **kwargs): 

134 """ 

135 cleanComplete(self, _lastcyclecheck, _reachedMajorLimit) -> long 

136 

137 

138 

139 Summary: 

140 Return true when we have completed this clean 

141 

142 Input Parameters: 

143 lastcyclecheck Check using peak residual before major cycle. 

144 reachedMajorLimit Let the iterbot know if we've reached our desired limit for major cycles. 

145 

146 -------------------------------------------------------------------------------- 

147 

148 """ 

149 return _iterbotsink.iterbotsink_cleanComplete(self, *args, **kwargs) 

150 

151 

152 def endmajorcycle(self): 

153 """ 

154 endmajorcycle(self) -> bool 

155 

156 

157 

158 Summary: 

159 Record the end of a major cycle 

160 

161 -------------------------------------------------------------------------------- 

162 

163 """ 

164 return _iterbotsink.iterbotsink_endmajorcycle(self) 

165 

166 

167 def resetminorcycleinfo(self): 

168 """ 

169 resetminorcycleinfo(self) -> bool 

170 

171 

172 

173 Summary: 

174 Reset info about peak residual and masks, before start minor cycles 

175 

176 -------------------------------------------------------------------------------- 

177 

178 """ 

179 return _iterbotsink.iterbotsink_resetminorcycleinfo(self) 

180 

181 

182 def getminorcyclecontrols(self): 

183 """ 

184 getminorcyclecontrols(self) -> record * 

185 

186 

187 

188 Summary: 

189 Get the controller for a minor cycle 

190 

191 -------------------------------------------------------------------------------- 

192 

193 """ 

194 return _iterbotsink.iterbotsink_getminorcyclecontrols(self) 

195 

196 

197 def mergeexecrecord(self, *args, **kwargs): 

198 """ 

199 mergeexecrecord(self, _execrecord, _immod) -> bool 

200 

201 

202 

203 Summary: 

204 Update the iterbot with iteration stats from the deconvolver 

205 

206 Input Parameters: 

207 execrecord Pass in the output of synthesisdeconvolver.executeminorcycle() 

208 immod Outlier field id 

209 

210 -------------------------------------------------------------------------------- 

211 

212 """ 

213 return _iterbotsink.iterbotsink_mergeexecrecord(self, *args, **kwargs) 

214 

215 

216 def changestopflag(self, *args, **kwargs): 

217 """ 

218 changestopflag(self, _stopflag) -> bool 

219 

220 

221 

222 Summary: 

223 Change the stop flag (for interactive clean) 

224 

225 Input Parameters: 

226 stopflag Set to False for the next cleanComplete() check to stop the run 

227 

228 -------------------------------------------------------------------------------- 

229 

230 """ 

231 return _iterbotsink.iterbotsink_changestopflag(self, *args, **kwargs) 

232 

233 

234 def mergeinitrecord(self, *args, **kwargs): 

235 """ 

236 mergeinitrecord(self, _initrecord) -> bool 

237 

238 

239 

240 Summary: 

241 Initialize the iterbot with starting peak residuals 

242 

243 Input Parameters: 

244 initrecord Pass in the output of synthesisdeconvolver.initminorcycle() 

245 

246 -------------------------------------------------------------------------------- 

247 

248 """ 

249 return _iterbotsink.iterbotsink_mergeinitrecord(self, *args, **kwargs) 

250 

251 

252 def getiterationdetails(self): 

253 """ 

254 getiterationdetails(self) -> record * 

255 

256 

257 

258 Summary: 

259 Return a record with the details of the iteration 

260 

261 -------------------------------------------------------------------------------- 

262 

263 """ 

264 return _iterbotsink.iterbotsink_getiterationdetails(self) 

265 

266 

267 def pauseforinteraction(self): 

268 """ 

269 pauseforinteraction(self) -> record * 

270 

271 

272 

273 Summary: 

274 Pause for interaction 

275 

276 -------------------------------------------------------------------------------- 

277 

278 """ 

279 return _iterbotsink.iterbotsink_pauseforinteraction(self) 

280 

281 

282 def getiterationsummary(self): 

283 """ 

284 getiterationsummary(self) -> record * 

285 

286 

287 

288 Summary: 

289 Return a record with a summary of the iteration 

290 

291 -------------------------------------------------------------------------------- 

292 

293 """ 

294 return _iterbotsink.iterbotsink_getiterationsummary(self) 

295 

296 

297 def done(self): 

298 """ 

299 done(self) -> bool 

300 

301 

302 

303 Summary: 

304 Close the tool 

305 

306 -------------------------------------------------------------------------------- 

307 

308 """ 

309 return _iterbotsink.iterbotsink_done(self) 

310 

311 __swig_destroy__ = _iterbotsink.delete_iterbotsink 

312 __del__ = lambda self: None 

313iterbotsink_swigregister = _iterbotsink.iterbotsink_swigregister 

314iterbotsink_swigregister(iterbotsink) 

315 

316# This file is compatible with both classic and new-style classes. 

317 

318