source: branches/alma/python/asapfitter.py@ 1582

Last change on this file since 1582 was 1461, checked in by Takeshi Nakazato, 16 years ago

New Development: No

JIRA Issue: Yes CAS-1085

Ready to Release: Yes

Interface Changes: No

What Interface Changed: Please list interface changes

Test Programs: execute sdbaseline with verify=True

Put in Release Notes: No

Description: Previously asapfitter only plots selected

region to verify baseline fit. I have
modified to plot whole spectral regions to
verify fit.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 21.8 KB
RevLine 
[113]1import _asap
[259]2from asap import rcParams
[723]3from asap import print_log
[1295]4from asap import _n_bools
[113]5
6class fitter:
7 """
8 The fitting class for ASAP.
9 """
[723]10
[113]11 def __init__(self):
12 """
13 Create a fitter object. No state is set.
14 """
15 self.fitter = _asap.fitter()
16 self.x = None
17 self.y = None
18 self.mask = None
19 self.fitfunc = None
[515]20 self.fitfuncs = None
[113]21 self.fitted = False
22 self.data = None
[515]23 self.components = 0
24 self._fittedrow = 0
[113]25 self._p = None
[515]26 self._selection = None
[1389]27 self.uselinear = False
[113]28
29 def set_data(self, xdat, ydat, mask=None):
30 """
[158]31 Set the absissa and ordinate for the fit. Also set the mask
[113]32 indicationg valid points.
33 This can be used for data vectors retrieved from a scantable.
34 For scantable fitting use 'fitter.set_scan(scan, mask)'.
35 Parameters:
[158]36 xdat: the abcissa values
[113]37 ydat: the ordinate values
38 mask: an optional mask
[723]39
[113]40 """
41 self.fitted = False
42 self.x = xdat
43 self.y = ydat
44 if mask == None:
[1295]45 self.mask = _n_bools(len(xdat), True)
[113]46 else:
47 self.mask = mask
48 return
49
50 def set_scan(self, thescan=None, mask=None):
51 """
52 Set the 'data' (a scantable) of the fitter.
53 Parameters:
54 thescan: a scantable
55 mask: a msk retireved from the scantable
56 """
57 if not thescan:
[723]58 msg = "Please give a correct scan"
59 if rcParams['verbose']:
60 print msg
61 return
62 else:
63 raise TypeError(msg)
[113]64 self.fitted = False
65 self.data = thescan
[1075]66 self.mask = None
[113]67 if mask is None:
[1295]68 self.mask = _n_bools(self.data.nchan(), True)
[113]69 else:
70 self.mask = mask
71 return
72
73 def set_function(self, **kwargs):
74 """
75 Set the function to be fit.
76 Parameters:
[1389]77 poly: use a polynomial of the order given with nonlinear least squares fit
78 lpoly: use polynomial of the order given with linear least squares fit
[113]79 gauss: fit the number of gaussian specified
80 Example:
81 fitter.set_function(gauss=2) # will fit two gaussians
[1389]82 fitter.set_function(poly=3) # will fit a 3rd order polynomial via nonlinear method
83 fitter.set_function(lpoly=3) # will fit a 3rd order polynomial via linear method
[113]84 """
[723]85 #default poly order 0
[515]86 n=0
[113]87 if kwargs.has_key('poly'):
88 self.fitfunc = 'poly'
89 n = kwargs.get('poly')
[515]90 self.components = [n]
[1389]91 self.uselinear = False
92 elif kwargs.has_key('lpoly'):
93 self.fitfunc = 'poly'
94 n = kwargs.get('lpoly')
95 self.components = [n]
96 self.uselinear = True
[113]97 elif kwargs.has_key('gauss'):
98 n = kwargs.get('gauss')
99 self.fitfunc = 'gauss'
[515]100 self.fitfuncs = [ 'gauss' for i in range(n) ]
101 self.components = [ 3 for i in range(n) ]
[1389]102 self.uselinear = False
[515]103 else:
[723]104 msg = "Invalid function type."
105 if rcParams['verbose']:
106 print msg
107 return
108 else:
109 raise TypeError(msg)
110
[113]111 self.fitter.setexpression(self.fitfunc,n)
[1232]112 self.fitted = False
[113]113 return
[723]114
[1075]115 def fit(self, row=0, estimate=False):
[113]116 """
117 Execute the actual fitting process. All the state has to be set.
118 Parameters:
[1075]119 row: specify the row in the scantable
120 estimate: auto-compute an initial parameter set (default False)
121 This can be used to compute estimates even if fit was
122 called before.
[113]123 Example:
[515]124 s = scantable('myscan.asap')
125 s.set_cursor(thepol=1) # select second pol
[113]126 f = fitter()
127 f.set_scan(s)
128 f.set_function(poly=0)
[723]129 f.fit(row=0) # fit first row
[113]130 """
131 if ((self.x is None or self.y is None) and self.data is None) \
132 or self.fitfunc is None:
[723]133 msg = "Fitter not yet initialised. Please set data & fit function"
134 if rcParams['verbose']:
135 print msg
136 return
137 else:
138 raise RuntimeError(msg)
139
[113]140 else:
141 if self.data is not None:
[515]142 self.x = self.data._getabcissa(row)
143 self.y = self.data._getspectrum(row)
[723]144 from asap import asaplog
145 asaplog.push("Fitting:")
[943]146 i = row
147 out = "Scan[%d] Beam[%d] IF[%d] Pol[%d] Cycle[%d]" % (self.data.getscan(i),self.data.getbeam(i),self.data.getif(i),self.data.getpol(i), self.data.getcycle(i))
[1075]148 asaplog.push(out,False)
[515]149 self.fitter.setdata(self.x, self.y, self.mask)
[113]150 if self.fitfunc == 'gauss':
151 ps = self.fitter.getparameters()
[1075]152 if len(ps) == 0 or estimate:
[113]153 self.fitter.estimate()
[626]154 try:
[1232]155 fxdpar = list(self.fitter.getfixedparameters())
156 if len(fxdpar) and fxdpar.count(0) == 0:
157 raise RuntimeError,"No point fitting, if all parameters are fixed."
[1389]158 if self.uselinear:
159 converged = self.fitter.lfit()
160 else:
161 converged = self.fitter.fit()
[1075]162 if not converged:
163 raise RuntimeError,"Fit didn't converge."
[626]164 except RuntimeError, msg:
[723]165 if rcParams['verbose']:
166 print msg
167 else:
168 raise
[515]169 self._fittedrow = row
[113]170 self.fitted = True
[723]171 print_log()
[113]172 return
173
[1232]174 def store_fit(self, filename=None):
[526]175 """
[1232]176 Save the fit parameters.
177 Parameters:
178 filename: if specified save as an ASCII file, if None (default)
179 store it in the scnatable
[526]180 """
[515]181 if self.fitted and self.data is not None:
182 pars = list(self.fitter.getparameters())
183 fixed = list(self.fitter.getfixedparameters())
[975]184 from asap.asapfit import asapfit
185 fit = asapfit()
186 fit.setparameters(pars)
187 fit.setfixedparameters(fixed)
188 fit.setfunctions(self.fitfuncs)
189 fit.setcomponents(self.components)
190 fit.setframeinfo(self.data._getcoordinfo())
[1232]191 if filename is not None:
192 import os
193 filename = os.path.expandvars(os.path.expanduser(filename))
194 if os.path.exists(filename):
195 raise IOError("File '%s' exists." % filename)
196 fit.save(filename)
197 else:
198 self.data._addfit(fit,self._fittedrow)
[515]199
[1017]200 #def set_parameters(self, params, fixed=None, component=None):
201 def set_parameters(self,*args,**kwargs):
[526]202 """
203 Set the parameters to be fitted.
204 Parameters:
205 params: a vector of parameters
206 fixed: a vector of which parameters are to be held fixed
207 (default is none)
208 component: in case of multiple gaussians, the index of the
209 component
[1017]210 """
211 component = None
212 fixed = None
213 params = None
[1031]214
[1017]215 if len(args) and isinstance(args[0],dict):
216 kwargs = args[0]
217 if kwargs.has_key("fixed"): fixed = kwargs["fixed"]
218 if kwargs.has_key("params"): params = kwargs["params"]
219 if len(args) == 2 and isinstance(args[1], int):
220 component = args[1]
[515]221 if self.fitfunc is None:
[723]222 msg = "Please specify a fitting function first."
223 if rcParams['verbose']:
224 print msg
225 return
226 else:
227 raise RuntimeError(msg)
[515]228 if self.fitfunc == "gauss" and component is not None:
[1017]229 if not self.fitted and sum(self.fitter.getparameters()) == 0:
[1295]230 pars = _n_bools(len(self.components)*3, False)
231 fxd = _n_bools(len(pars), False)
[515]232 else:
[723]233 pars = list(self.fitter.getparameters())
[515]234 fxd = list(self.fitter.getfixedparameters())
235 i = 3*component
236 pars[i:i+3] = params
237 fxd[i:i+3] = fixed
238 params = pars
[723]239 fixed = fxd
[113]240 self.fitter.setparameters(params)
241 if fixed is not None:
242 self.fitter.setfixedparameters(fixed)
[723]243 print_log()
[113]244 return
[515]245
[1217]246 def set_gauss_parameters(self, peak, centre, fwhm,
[1017]247 peakfixed=0, centerfixed=0,
[1217]248 fwhmfixed=0,
[515]249 component=0):
[113]250 """
[515]251 Set the Parameters of a 'Gaussian' component, set with set_function.
252 Parameters:
[1232]253 peak, centre, fwhm: The gaussian parameters
[515]254 peakfixed,
255 centerfixed,
[1217]256 fwhmfixed: Optional parameters to indicate if
[515]257 the paramters should be held fixed during
258 the fitting process. The default is to keep
259 all parameters flexible.
[526]260 component: The number of the component (Default is the
261 component 0)
[515]262 """
263 if self.fitfunc != "gauss":
[723]264 msg = "Function only operates on Gaussian components."
265 if rcParams['verbose']:
266 print msg
267 return
268 else:
269 raise ValueError(msg)
[515]270 if 0 <= component < len(self.components):
[1217]271 d = {'params':[peak, centre, fwhm],
272 'fixed':[peakfixed, centerfixed, fwhmfixed]}
[1017]273 self.set_parameters(d, component)
[515]274 else:
[723]275 msg = "Please select a valid component."
276 if rcParams['verbose']:
277 print msg
278 return
279 else:
280 raise ValueError(msg)
281
[975]282 def get_area(self, component=None):
283 """
284 Return the area under the fitted gaussian component.
285 Parameters:
286 component: the gaussian component selection,
287 default (None) is the sum of all components
288 Note:
289 This will only work for gaussian fits.
290 """
291 if not self.fitted: return
292 if self.fitfunc == "gauss":
293 pars = list(self.fitter.getparameters())
294 from math import log,pi,sqrt
295 fac = sqrt(pi/log(16.0))
296 areas = []
297 for i in range(len(self.components)):
298 j = i*3
299 cpars = pars[j:j+3]
300 areas.append(fac * cpars[0] * cpars[2])
301 else:
302 return None
303 if component is not None:
304 return areas[component]
305 else:
306 return sum(areas)
307
[1075]308 def get_errors(self, component=None):
[515]309 """
[1075]310 Return the errors in the parameters.
311 Parameters:
312 component: get the errors for the specified component
313 only, default is all components
314 """
315 if not self.fitted:
316 msg = "Not yet fitted."
317 if rcParams['verbose']:
318 print msg
319 return
320 else:
321 raise RuntimeError(msg)
322 errs = list(self.fitter.geterrors())
323 cerrs = errs
324 if component is not None:
325 if self.fitfunc == "gauss":
326 i = 3*component
327 if i < len(errs):
328 cerrs = errs[i:i+3]
329 return cerrs
330
331 def get_parameters(self, component=None, errors=False):
332 """
[113]333 Return the fit paramters.
[526]334 Parameters:
335 component: get the parameters for the specified component
336 only, default is all components
[113]337 """
338 if not self.fitted:
[723]339 msg = "Not yet fitted."
340 if rcParams['verbose']:
341 print msg
342 return
343 else:
344 raise RuntimeError(msg)
[113]345 pars = list(self.fitter.getparameters())
346 fixed = list(self.fitter.getfixedparameters())
[1075]347 errs = list(self.fitter.geterrors())
[1039]348 area = []
[723]349 if component is not None:
[515]350 if self.fitfunc == "gauss":
351 i = 3*component
352 cpars = pars[i:i+3]
353 cfixed = fixed[i:i+3]
[1075]354 cerrs = errs[i:i+3]
[1039]355 a = self.get_area(component)
356 area = [a for i in range(3)]
[515]357 else:
358 cpars = pars
[723]359 cfixed = fixed
[1075]360 cerrs = errs
[515]361 else:
362 cpars = pars
363 cfixed = fixed
[1075]364 cerrs = errs
[1039]365 if self.fitfunc == "gauss":
366 for c in range(len(self.components)):
367 a = self.get_area(c)
368 area += [a for i in range(3)]
[1088]369 fpars = self._format_pars(cpars, cfixed, errors and cerrs, area)
[723]370 if rcParams['verbose']:
[515]371 print fpars
[1075]372 return {'params':cpars, 'fixed':cfixed, 'formatted': fpars,
373 'errors':cerrs}
[723]374
[1075]375 def _format_pars(self, pars, fixed, errors, area):
[113]376 out = ''
377 if self.fitfunc == 'poly':
378 c = 0
[515]379 for i in range(len(pars)):
380 fix = ""
[1232]381 if len(fixed) and fixed[i]: fix = "(fixed)"
[1088]382 if errors :
383 out += ' p%d%s= %3.6f (%1.6f),' % (c,fix,pars[i], errors[i])
384 else:
385 out += ' p%d%s= %3.6f,' % (c,fix,pars[i])
[113]386 c+=1
[515]387 out = out[:-1] # remove trailing ','
[113]388 elif self.fitfunc == 'gauss':
389 i = 0
390 c = 0
[515]391 aunit = ''
392 ounit = ''
[113]393 if self.data:
[515]394 aunit = self.data.get_unit()
395 ounit = self.data.get_fluxunit()
[113]396 while i < len(pars):
[1039]397 if len(area):
398 out += ' %2d: peak = %3.3f %s , centre = %3.3f %s, FWHM = %3.3f %s\n area = %3.3f %s %s\n' % (c,pars[i],ounit,pars[i+1],aunit,pars[i+2],aunit, area[i],ounit,aunit)
[1017]399 else:
400 out += ' %2d: peak = %3.3f %s , centre = %3.3f %s, FWHM = %3.3f %s\n' % (c,pars[i],ounit,pars[i+1],aunit,pars[i+2],aunit,ounit,aunit)
[113]401 c+=1
402 i+=3
403 return out
[723]404
[113]405 def get_estimate(self):
406 """
[515]407 Return the parameter estimates (for non-linear functions).
[113]408 """
409 pars = self.fitter.getestimate()
[943]410 fixed = self.fitter.getfixedparameters()
[723]411 if rcParams['verbose']:
[1017]412 print self._format_pars(pars,fixed,None)
[113]413 return pars
414
415 def get_residual(self):
416 """
417 Return the residual of the fit.
418 """
419 if not self.fitted:
[723]420 msg = "Not yet fitted."
421 if rcParams['verbose']:
422 print msg
423 return
424 else:
425 raise RuntimeError(msg)
[113]426 return self.fitter.getresidual()
427
428 def get_chi2(self):
429 """
430 Return chi^2.
431 """
432 if not self.fitted:
[723]433 msg = "Not yet fitted."
434 if rcParams['verbose']:
435 print msg
436 return
437 else:
438 raise RuntimeError(msg)
[113]439 ch2 = self.fitter.getchi2()
[723]440 if rcParams['verbose']:
[113]441 print 'Chi^2 = %3.3f' % (ch2)
[723]442 return ch2
[113]443
444 def get_fit(self):
445 """
446 Return the fitted ordinate values.
447 """
448 if not self.fitted:
[723]449 msg = "Not yet fitted."
450 if rcParams['verbose']:
451 print msg
452 return
453 else:
454 raise RuntimeError(msg)
[113]455 return self.fitter.getfit()
456
457 def commit(self):
458 """
[526]459 Return a new scan where the fits have been commited (subtracted)
[113]460 """
461 if not self.fitted:
[723]462 msg = "Not yet fitted."
463 if rcParams['verbose']:
464 print msg
465 return
466 else:
467 raise RuntimeError(msg)
[975]468 from asap import scantable
469 if not isinstance(self.data, scantable):
[723]470 msg = "Not a scantable"
471 if rcParams['verbose']:
472 print msg
473 return
474 else:
475 raise TypeError(msg)
[113]476 scan = self.data.copy()
[259]477 scan._setspectrum(self.fitter.getresidual())
[723]478 print_log()
[1092]479 return scan
[113]480
[723]481 def plot(self, residual=False, components=None, plotparms=False, filename=None):
[113]482 """
483 Plot the last fit.
484 Parameters:
485 residual: an optional parameter indicating if the residual
486 should be plotted (default 'False')
[526]487 components: a list of components to plot, e.g [0,1],
488 -1 plots the total fit. Default is to only
489 plot the total fit.
490 plotparms: Inidicates if the parameter values should be present
491 on the plot
[113]492 """
493 if not self.fitted:
494 return
[723]495 if not self._p or self._p.is_dead:
496 if rcParams['plotter.gui']:
497 from asap.asaplotgui import asaplotgui as asaplot
498 else:
499 from asap.asaplot import asaplot
500 self._p = asaplot()
501 self._p.hold()
[113]502 self._p.clear()
[515]503 self._p.set_panels()
[652]504 self._p.palette(0)
[113]505 tlab = 'Spectrum'
[723]506 xlab = 'Abcissa'
[1017]507 ylab = 'Ordinate'
[1273]508 from matplotlib.numerix import ma,logical_not,logical_and,array
509 m = self.mask
[113]510 if self.data:
[515]511 tlab = self.data._getsourcename(self._fittedrow)
512 xlab = self.data._getabcissalabel(self._fittedrow)
[1273]513 m = logical_and(self.mask,
[1306]514 array(self.data._getmask(self._fittedrow),
515 copy=False))
[1389]516
[626]517 ylab = self.data._get_ordinate_label()
[515]518
[1075]519 colours = ["#777777","#dddddd","red","orange","purple","green","magenta", "cyan"]
[1461]520 nomask=True
521 for i in range(len(m)):
522 nomask = nomask and m[i]
523 label0='Masked Region'
524 label1='Spectrum'
525 if ( nomask ):
526 label0=label1
527 else:
528 y = ma.masked_array( self.y, mask = m )
529 self._p.palette(1,colours)
530 self._p.set_line( label = label1 )
531 self._p.plot( self.x, y )
[652]532 self._p.palette(0,colours)
[1461]533 self._p.set_line(label=label0)
[1273]534 y = ma.masked_array(self.y,mask=logical_not(m))
[1088]535 self._p.plot(self.x, y)
[113]536 if residual:
[1461]537 self._p.palette(7)
[515]538 self._p.set_line(label='Residual')
[1116]539 y = ma.masked_array(self.get_residual(),
[1273]540 mask=logical_not(m))
[1088]541 self._p.plot(self.x, y)
[652]542 self._p.palette(2)
[515]543 if components is not None:
544 cs = components
545 if isinstance(components,int): cs = [components]
[526]546 if plotparms:
[1031]547 self._p.text(0.15,0.15,str(self.get_parameters()['formatted']),size=8)
[515]548 n = len(self.components)
[652]549 self._p.palette(3)
[515]550 for c in cs:
551 if 0 <= c < n:
552 lab = self.fitfuncs[c]+str(c)
553 self._p.set_line(label=lab)
[1116]554 y = ma.masked_array(self.fitter.evaluate(c),
[1273]555 mask=logical_not(m))
[1088]556
557 self._p.plot(self.x, y)
[515]558 elif c == -1:
[652]559 self._p.palette(2)
[515]560 self._p.set_line(label="Total Fit")
[1116]561 y = ma.masked_array(self.fitter.getfit(),
[1273]562 mask=logical_not(m))
[1088]563 self._p.plot(self.x, y)
[515]564 else:
[652]565 self._p.palette(2)
[515]566 self._p.set_line(label='Fit')
[1116]567 y = ma.masked_array(self.fitter.getfit(),
[1273]568 mask=logical_not(m))
[1088]569 self._p.plot(self.x, y)
[723]570 xlim=[min(self.x),max(self.x)]
571 self._p.axes.set_xlim(xlim)
[113]572 self._p.set_axes('xlabel',xlab)
573 self._p.set_axes('ylabel',ylab)
574 self._p.set_axes('title',tlab)
575 self._p.release()
[723]576 if (not rcParams['plotter.gui']):
577 self._p.save(filename)
578 print_log()
[113]579
[1061]580 def auto_fit(self, insitu=None, plot=False):
[113]581 """
[515]582 Return a scan where the function is applied to all rows for
583 all Beams/IFs/Pols.
[723]584
[113]585 """
586 from asap import scantable
[515]587 if not isinstance(self.data, scantable) :
[723]588 msg = "Data is not a scantable"
589 if rcParams['verbose']:
590 print msg
591 return
592 else:
593 raise TypeError(msg)
[259]594 if insitu is None: insitu = rcParams['insitu']
595 if not insitu:
596 scan = self.data.copy()
597 else:
598 scan = self.data
[880]599 rows = xrange(scan.nrow())
[1446]600 # Save parameters of baseline fits as a class attribute.
601 # NOTICE: This does not reflect changes in scantable!
602 if len(rows) > 0: self.blpars=[]
[723]603 from asap import asaplog
[876]604 asaplog.push("Fitting:")
605 for r in rows:
[1031]606 out = " Scan[%d] Beam[%d] IF[%d] Pol[%d] Cycle[%d]" % (scan.getscan(r),scan.getbeam(r),scan.getif(r),scan.getpol(r), scan.getcycle(r))
[880]607 asaplog.push(out, False)
[876]608 self.x = scan._getabcissa(r)
609 self.y = scan._getspectrum(r)
610 self.data = None
611 self.fit()
[1446]612 fpar = self.get_parameters()
[1061]613 if plot:
614 self.plot(residual=True)
615 x = raw_input("Accept fit ([y]/n): ")
616 if x.upper() == 'N':
[1446]617 self.blpars.append(None)
[1061]618 continue
[880]619 scan._setspectrum(self.fitter.getresidual(), r)
[1446]620 self.blpars.append(fpar)
[1061]621 if plot:
622 self._p.unmap()
623 self._p = None
[876]624 print_log()
625 return scan
[794]626
Note: See TracBrowser for help on using the repository browser.