task_specfit.py

Go to the documentation of this file.

##########################################################################
# 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 taskinit import *

def specfit(
        imagename=None, box=None, region=None, chans=None,
        stokes=None, axis=None, mask=None, ngauss=None,
        poly=None, estimates=None, minpts=None, multifit=None,
        model=None, residual=None, amp=None, amperr=None,
        center=None, centererr=None, fwhm=None, fwhmerr=None,
        integral=None, integralerr=None, wantreturn=None,
        stretch=None, logresults=None, pampest=None,
        pcenterest=None, pfwhmest=None, pfix=None,
        gmncomps=None, gmampcon=None, gmcentercon=None,
    gmfwhmcon=None, gmampest=None, gmcenterest=None,
    gmfwhmest=None, gmfix=None, logfile=None, append=None,
    pfunc=None, goodamprange=None, goodcenterrange=None,
    goodfwhmrange=None, sigma=None, outsigma=None
):
    casalog.origin('specfit')
    retval = None
    myia = iatool()
    try:
        if (not myia.open(imagename)):
            raise Exception, "Cannot create image analysis tool using " + imagename
        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
                )
    except Exception, instance:
        casalog.post( str( '*** Error ***') + str(instance), 'SEVERE')
        retval = None
    myia.done()
    if (wantreturn):
        return retval
    else:
        if (retval):
           del retval
        return None