plotants.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_plotants
def plotants(vis='', figfile=''):

        """Plot the antenna distribution in the local reference frame:
       Plot the antenna distribution in the local reference frame:

       The location of the antennas in the MS will be plotted with
       X-toward local east; Y-toward local north.

       Keyword arguments:
       vis -- Name of input visibility file.
               default: none. example: vis='ngc5921.ms'

       figfile -- Save the plotted figure in this file.
               default: ''. example: figfile='myFigure.png'

               The name of each antenna (egs. vla=antenna number) is
                  shown next to its respective location.

               DO NOT use the buttons on the Mark Region line.  These are
                  not implemented yet and might abort CASA.

               You can zoom in by pressing the magnifier button (bottom,
                  third from left) and making a rectangular region with
                  the mouse.  Press the home button (left most button) to
                  remove zoom.

               A hard-copy of this plot can be obtained by pressing the
                  button on the right at the bottom of the display.  This
                  produces a png format file.
 
        """

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

        mytmp['vis'] = vis
        mytmp['figfile'] = figfile
        pathname='file:///'+os.environ.get('CASAPATH').split()[0]+'/share/xml/'
        trec = casac.utils().torecord(pathname+'plotants.xml')

        casalog.origin('plotants')
        if trec.has_key('plotants') and casac.utils().verify(mytmp, trec['plotants']) :
            result = task_plotants.plotants(vis, figfile)

        else :
          result = False
        return result