##########################################################################
# task_specfit.py
#
# Copyright (C) 2008, 2009
# Associated Universities, Inc. Washington DC, USA.
#
# This script is free software; you can redistribute it and/or modify it
# under the terms of the GNU Library General Public License as published by
# the Free Software Foundation; either version 2 of the License, or (at your
# option) any later version.
#
# This library is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
# License for more details.
#
# You should have received a copy of the GNU Library General Public License
# along with this library; if not, write to the Free Software Foundation,
# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
#
# Correspondence concerning AIPS++ should be adressed as follows:
#        Internet email: aips2-request@nrao.edu.
#        Postal address: AIPS++ Project Office
#                        National Radio Astronomy Observatory
#                        520 Edgemont Road
#                        Charlottesville, VA 22903-2475 USA
#
# <author>
# Dave Mehringer
# </author>
#
# <summary>
# Fit 1 dimensional gaussians and/or polynomial
# </summary>
#
# <reviewed reviwer="" date="" tests="" demos="">
# </reviewed>
#
# <prerequisite>
# <ul>
#
# </ul>
# </prerequisite>
#
# <etymology>
# specfit => spec(trum) fit(ter)
# but in general it can be used for any image axis
# </etymology>
#
# <synopsis>
# specfit fits models to 1-d profiles. It is built on top of ia.fitprofile()
# </synopsis> 
#
# <example>
# specfit(imagename="myline.im", ngauss=2, poly=3, model="mymodel.im", multi=true, residual="myresid.im")
#
# </example>
#
# <motivation>
# To make users happy, cf https://bugs.aoc.nrao.edu/browse/CAS-607
# </motivation>
#

###########################################################################
from __future__ import absolute_import

import sys
import glob
import time

# get is_python3 and is_CASA6
from casatasks.private.casa_transition import *
if is_CASA6:
    from casatools import image
    from casatasks import casalog

    from .ialib import write_image_history, get_created_images
else:
    from taskinit import *
    from taskinit import iatool as image
    from ialib import write_image_history, get_created_images

def specfit(
	imagename, box, region, chans, stokes, axis, mask, ngauss,
	poly, estimates, minpts, multifit, model, residual, amp, amperr,
	center, centererr, fwhm, fwhmerr, integral, integralerr, wantreturn,
	stretch, logresults, pampest, pcenterest, pfwhmest, pfix,
	gmncomps, gmampcon, gmcentercon, gmfwhmcon, gmampest, gmcenterest,
    gmfwhmest, gmfix, logfile, append, pfunc, goodamprange, goodcenterrange,
    goodfwhmrange, sigma, outsigma
):
    casalog.origin('specfit')
    retval = None
    myia = image()
    myia.dohistory(False)
    try:
        if (not myia.open(imagename)):
            raise Exception("Cannot create image analysis tool using " + imagename)
        target_time = time.time()
        retval = myia.fitprofile(
			box=box, region=region, chans=chans,
			stokes=stokes, axis=axis, mask=mask,
			ngauss=ngauss, poly=poly,
			estimates=estimates, minpts=minpts,
			multifit=multifit, model=model,
			residual=residual, amp=amp, amperr=amperr,
			center=center, centererr=centererr,
			fwhm=fwhm, fwhmerr=fwhmerr,
			integral=integral, integralerr=integralerr,
			stretch=stretch, logresults=logresults,
			pampest=pampest, pcenterest=pcenterest,
			pfwhmest=pfwhmest, pfix=pfix,
			gmncomps=gmncomps, gmampcon=gmampcon,
			gmcentercon=gmcentercon, gmfwhmcon=gmfwhmcon,
			gmampest=gmampest, gmcenterest=gmcenterest,
			gmfwhmest=gmfwhmest, gmfix=gmfix, logfile=logfile,
			append=append, pfunc=pfunc, goodamprange=goodamprange,
			goodcenterrange=goodcenterrange, goodfwhmrange=goodfwhmrange,
			sigma=sigma, outsigma=outsigma
		)

        try:
            param_names = specfit.__code__.co_varnames[:specfit.__code__.co_argcount]
            if is_python3:
                vars = locals( )
                param_vals = [vars[p] for p in param_names]
            else:
                param_vals = [eval(p) for p in param_names]
            ims = [model, residual]
            for x in [amp, amperr, center, centererr, fwhm, fwhmerr, integral, integralerr]:
            	if x:
            		ims.extend(get_created_images(x, target_time))
            for im in ims:
             	write_image_history(
             	    im, sys._getframe().f_code.co_name,
            	    param_names, param_vals, casalog
         		)
        except Exception as instance:
            casalog.post("*** Error \'%s\' updating HISTORY" % (instance), 'WARN')

    finally:
        myia.done()
        if (wantreturn):
            return retval
        else:
            if (retval):
                del retval