exportfits.py

Go to the documentation of this file.

#
# This file was generated using xslt from its XML file
#
# Copyright 2009, Associated Universities Inc., Washington DC
#
import sys
import os
from  casac import *
import string
from taskinit import casalog
#from taskmanager import tm
import task_exportfits
def exportfits(imagename='', fitsimage='', velocity=False, optical=False, bitpix=-32, minpix=0, maxpix=-1, overwrite=False, dropstokes=False, stokeslast=True):

        """Convert a CASA image to a FITS file

        CASA-produced images can be written to disk for transporting
        to other software packages.  No subimaging of the fits image
        can be made with this task.

        Keyword arguments:
        imagename -- Name of input CASA image
                default: none; example: imagename='3C273XC1.image'
        fitsimage -- Name of ouput image FITS file
                default: none; example='3C273XC1.fits'
        velocity -- Use velocity (rather than frequency) as spectral axis
                default: False
        optical -- Use the optical (rather than radio) velocity convention
                default: False;
        bitpix -- Bits per pixel
                default: -32 (floating point)
                <Options: -32 (floating point), 16 (integer)>
        minpix -- Minimum pixel value
                default: 0 = autoscale
        maxpix -- Maximum pixel value
                default: 0 = autoscale
        overwrite -- Overwrite pre-existing imagename
                default=False; example: overwrite=True
        dropstokes -- Drop Stokes axis?
                default: False; example: dropstokes=True
        stokeslast -- Put Stokes axis last in header?
                default: True; example: stokeslast=False
        async --  Run asynchronously
                default = False;

        """

#
#    The following is work around to avoid a bug with current python translation
#
        mytmp = {}

        mytmp['imagename'] = imagename
        mytmp['fitsimage'] = fitsimage
        mytmp['velocity'] = velocity
        mytmp['optical'] = optical
        mytmp['bitpix'] = bitpix
        mytmp['minpix'] = minpix
        mytmp['maxpix'] = maxpix
        mytmp['overwrite'] = overwrite
        mytmp['dropstokes'] = dropstokes
        mytmp['stokeslast'] = stokeslast
        pathname='file:///'+os.environ.get('CASAPATH').split()[0]+'/share/xml/'
        trec = casac.utils().torecord(pathname+'exportfits.xml')

        casalog.origin('exportfits')
        if trec.has_key('exportfits') and casac.utils().verify(mytmp, trec['exportfits']) :
            result = task_exportfits.exportfits(imagename, fitsimage, velocity, optical, bitpix, minpix, maxpix, overwrite, dropstokes, stokeslast)

        else :
          result = False
        return result