Metadata-Version: 2.1
Name: pyimfit
Version: 0.7.5
Summary: Python wrapper for astronomical image-fitting program Imfit
Home-page: https://github.com/perwin/pyimfit
Author: Peter Erwin
Author-email: erwin@sigmaxi.net
License: UNKNOWN
Project-URL: Documentation, https://pyimfit.readthedocs.io/en/latest/
Project-URL: Source, https://github.com/perwin/pyimfit
Description: # Pyimfit
        
        This is a Python wrapper around the astronomical image-fitting program Imfit.
        
        Online documentation: [https://pyimfit.readthedocs.io/en/latest/](https://pyimfit.readthedocs.io/en/latest/).
        
        
        ## Sample Usage
        
        The following assumes an interactive Python session (such as an iPython session
        or Jupyter notebook):
        
            from astropy.io import fits
            import pyimfit
            
            imageFile = "<path-to-FITS-file-directory>/ic3478rss_256.fits"
            imfitConfigFile = "<path-to-config-file-directory>/config_exponential_ic3478_256.dat"
        
            # read in image data, convert to proper double-precisions, little-endian format
            image_data = pyimfit.FixImage(fits.getdata(imageFile))
        
            # construct model from config file; construct new Imfit fitter based on model,;
            model_desc = pyimfit.ModelDescription.load(configFile)
        
            # create an Imfit object, using the previously loaded model configuration
            imfit_fitter = pyimfit.Imfit(model_desc)
        
            # load the image data and image characteristics and do a standard fit
            # (using default chi^2 statistics and Levenberg-Marquardt solver)
            imfit_fitter.fit(image_data, gain=4.725, read_noise=4.3, original_sky=130.14)
            
            # check the fit and print the resulting best-fit parameter values
            if imfit_fitter.fitConverged is True:
                print("Fit converged: chi^2 = {0}, reduced chi^2 = {1}".format(imfit_fitter.fitStatistic,
                    imfit_fitter.reducedFitStatistic))
                bestfit_params = imfit_fitter.getRawParameters()
                print("Best-fit parameter values:", bestfit_params)
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Cython
Classifier: Programming Language :: C++
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: POSIX
Classifier: Intended Audience :: Science/Research
Requires-Python: >=3
Description-Content-Type: text/markdown
